PeakPulse - eCommerce Project for Sport Goods with commercetools

PeakPulse is an eCommerce project focused on selling sporting goods. This project is created by team "CodeCircus"🎪 as part of their learning journey in the Rolling Scopes School🤓. It is built using commercetools, a powerful cloud-based commerce platform, to handle product management, inventory, and order processing.

Local Setup ↩️

To run the PeakPulse repository locally, follow these steps👇🏻:

Prerequisites ❗️

Make sure you have the following tools installed on your system:

• Node.js (version 12 or higher)
• npm (Node Package Manager)

Installation 📩

1. Clone the PeakPulse repository from GitHub:

git clone git@github.com:akrutsko/eCommerce.git

2. Change into the project directory:

cd eCommerce

3. Install the project dependencies:

npm install

4. Run the project:

npm run serve

Scripts 🔐

PeakPulse comes with several useful npm scripts:

• dev: Builds the project in development mode using webpack.
• prod: Builds the project in production mode using webpack.
• serve: Starts a development server with webpack to serve the project.
• lint: Lints the TypeScript files using ESLint with the airbnb-base rules.
• lint:fix: Lints and automatically fixes the issues in the TypeScript files.
• prettier: Formats the TypeScript, JavaScript, and CSS files using Prettier.
• test: Runs the Jest tests for the project.

You can run these scripts using npm run <script-name>, for example:

npm run dev

Technology stack 📚

The PeakPulse project utilizes the following technologies:

• TypeScript: A typed superset of JavaScript, providing static types to enhance code quality.
• Webpack: A powerful bundler used to package the project's assets.
• Tailwind CSS: A utility-first CSS framework for designing modern and responsive user interfaces.
• Jest: A testing framework for running unit tests.
• commercetools: A cloud-based commerce platform used for product management, inventory, and order processing.
• commercetools sdk: Libraries and tools for integrating commercetools into your project.
• Swiper:A touch-enabled slider library for creating interactive carousels and sliders.
• Toastify: A JavaScript library for displaying user-friendly notification messages.

License 📄

PeakPulse is licensed under the ISC License.

---

Thank you for your interest. Best regards, CodeCircus Team 🎉