docs: complete README.md file

README.md

@@ -1 +1,76 @@
-# eCommerce
+# 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](https://rs.school/)🤓. It is built using [commercetools](https://commercetools.com/), 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:
+
+```bash
+git clone git@github.com:akrutsko/eCommerce.git
+```
+
+2. Change into the project directory:
+
+```bash
+cd eCommerce
+```
+
+3. Install the project dependencies:
+
+```bash
+npm install
+```
+
+4. Run the project:
+
+```bash
+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:
+
+```bash
+npm run dev
+```
+
+### Technology stack 📚
+
+The PeakPulse project utilizes the following technologies:
+
+- [TypeScript](https://www.typescriptlang.org/): A typed superset of JavaScript, providing static types to enhance code quality.
+- [Webpack](https://webpack.js.org/): A powerful bundler used to package the project's assets.
+- [Tailwind CSS](https://tailwindcss.com/): A utility-first CSS framework for designing modern and responsive user interfaces.
+- [Jest](https://jestjs.io/): A testing framework for running unit tests.
+- [commercetools](https://commercetools.com/): A cloud-based commerce platform used for product management, inventory, and order processing.
+
+### License 📄
+
+PeakPulse is licensed under the [ISC License](https://en.wikipedia.org/wiki/ISC_license#:~:text=The%20ISC%20license%20is%20a,ISC%20license).
+
+---
+
+Thank you for your interest. Best regards, CodeCircus Team 🎉