A modern e-commerce web app where users can browse products, add them to a cart, and simulate purchases. It's built with up-to-date frontend tools and serves as a starting point for real online stores.
The main goal of this project is to learn and apply best practices in frontend development using modern tools. It's built to be easy to grow and update, and it helps the team practice working together while connecting the app to CommerceTools, a headless e-commerce platform.
- React
- Typescript
- Vite
- Eslint, Prettier, husky
- Jest
- CommerceTools
The following scripts are defined in the package.json and can be run using npm run <script>:
| Script | Description |
|---|---|
dev |
Starts the development server. |
build |
Build for production. |
preview |
Preview the production build. |
lint |
Lint the codebase. |
format |
Format all files with Prettier. |
prepare |
Prepares Git hooks using Husky. |
test |
Run tests with Jest. |
Follow these steps to set up and run the application:
Rename the .env-example file to .env in the root of the project directory.
cp .env-example .envRename the .env-example file to .env in the root of the project directory.
npm installTo start the development server, run the following command:
npm run devContributions are welcome! To help us accept your changes quickly, please follow these simple rules:
- Create Pull Requests: All changes must be submitted via a Pull Request from your own fork of this repository.
- Implement your changes, keeping the coding style consistent.
- Lint and Format: Before committing, run the linter and formatter to ensure your code adheres to the project's standards.
npm run lint
npm run format- Commit Your Changes: Commit your work with a clear and descriptive commit message.
git commit -m "feat: Add new awesome feature"- Open a Pull Request from your branch to the develop branch of the main repository. Provide a clear description of the changes you've made.
We appreciate your help in making this GameStore even better!