docs(RSS-ECOMM-1_17): update Readme (#55)

* docs: add scripts description

* docs: add authors' contact info

* docs: add description how to run the project locally

* docs: add tech stack description

* chore: update PR template

* chore: update PR template

* docs: update general overview

* fix: remove unnecessary links

.github/pull_request_template.md

@@ -2,15 +2,15 @@
 
 📍 conforms with the following format:
 
-- [ ] prefix (following the [convention](https://www.conventionalcommits.org/en/v1.0.0-beta.2/): feat, fix, hotfix, chore, refactor, revert, docs, style, test)
-- [ ] issue number (e.g. RSS-ECOMM-1_01, where 1 - is the sprint number and 01 - is the issue number)
-- [ ] description
+- [ ] prefix (following the [convention](https://www.conventionalcommits.org/en/v1.0.0-beta.2/): `feat`, `fix`, `hotfix`, `chore`, `refactor`, `revert`, `docs`, `style`, `test`)
+- [ ] sprint and issue number (e.g. `RSS-ECOMM-1_01`, where `1` - is the sprint number and `01` - is the issue number)
+- [ ] short escription
 
 👀 Example: `feat(RSS-ECOMM-1_01): description`
 
 ## PR Description 🧙‍♂️
 
-_Add a description of the changes in the PR_ 🤔
+_Add a comprehensive description of the changes in the PR_ 🤔
 
 #### Affected Scope 💡
 

README.md

@@ -1,19 +1,72 @@
-## eCommerce Application 🛍️🌐
+# Greenshop 🌿
 
-Welcome to our eCommerce application! This platform replicates real-world shopping experiences in a digital environment 🏪. It's a comprehensive online shopping portal that provides an interactive and seamless experience to users. From product discovery to checkout, the application ensures a smooth journey for the user, enhancing their engagement and boosting their purchasing confidence 🚀.
+## General Overview 🛍️
 
-Users can browse through a vast range of products 📚👗👟, view detailed descriptions, add their favorite items to the basket 🛒, and proceed to checkout 💳. It includes features such as user registration and login 📝🔐, product search 🔍, product categorization, and sorting to make the shopping experience more streamlined and convenient.
+Welcome to [Greenshop](https://mad-wizards-greenshop.netlify.app/), your digital haven for all things green! 🪴
 
-An important aspect of our application is that it's responsive 📲, ensuring it looks great on various devices with a minimum resolution of 390px. This feature makes the shopping experience enjoyable, irrespective of the device users prefer.
+- Our Mission 🌸
+- Key Features 🗝️
+- Technical Stack 💻
+- How to Run the Project Locally ⚙️
+- Availabile Scripts 📑
+- Contact us 📩
 
-Key pages in the application include:
+### Our Mission 🌸
 
-- Login and Registration pages 🖥️
-- Main page 🏠
-- Catalog Product page 📋
-- Detailed Product page 🔎
-- User Profile page 👤
-- Basket page 🛒
-- About Us page 🙋‍♂️🙋‍♀️
+At Greenshop, we're on a mission to cultivate a greener, more vibrant world, one plant at a time. Our curated collection features a diverse array of potted plants, seeds, soil, and accessories, meticulously selected to cater to the needs and desires of both novice gardeners and seasoned green thumbs alike. Whether you're looking to transform your living space into a lush oasis or embark on a journey of cultivating your own botanical wonders, Greenshop has everything you need to bring your green dreams to life.
 
-The application is powered by CommerceTools 🌐, a leading provider of commerce solutions for B2C and B2B enterprises. CommerceTools offers a cloud-native, microservices-based commerce platform that enables brands to create unique and engaging digital commerce experiences.
+Our modern and minimalist website offers a sleek and intuitive shopping experience, designed to delight and inspire. From our clean and uncluttered design to our seamless navigation and user-friendly interface, we're committed to making your shopping experience as effortless and enjoyable as possible.
+
+### Key features of Greenshop include 🗝️
+
+🔎 **Comprehensive Product Selection**: Explore our extensive catalog of potted plants, seeds, soil, and gardening essentials, handpicked to ensure the highest quality and variety.
+
+🧭 **User-friendly Navigation**: Our intuitive navigation system makes it easy for you to find the plants, seeds, soil, and accessories you need.
+
+🧩 **Elegance and Functionality**: Our intuitive design and intuitive features make it easy to shop for plants, seeds, soil, and accessories.
+
+🖼️ **Responsive Design**: Whether you're browsing on a desktop, tablet, or smartphone, our website adapts seamlessly to provide a visually stunning and immersive experience on any device.
+
+🔐 **Secure checkout process**: Secure checkout ensures you can shop with confidence and peace of mind.
+
+## Technical Stack 💻
+
+_in our project we used the following technologies:_
+
+- **Frontend**: Utilizes [HTML](https://www.w3schools.com/html/), [SASS](https://sass-lang.com/), and [Typescript](https://www.typescriptlang.org/) to craft a dynamic and engaging user interface 🎨
+- **Bundling**: Employs [Vite](https://vitejs.dev/) as the bundler, ensuring swift development server startup time and seamless module replacement 🌳
+- **Deployment**: Hosted on [Netlify](https://www.netlify.com/), enabling efficient and hassle-free deployment of the application 🌟
+- **Code Quality**: Ensured code quality through rigorous checks by [Husky](https://typicode.github.io/husky/), [Prettier](https://prettier.io/), [ESLint](https://eslint.org/), [Stylelint](https://stylelint.io/), [SonarLint](https://www.sonarsource.com/products/sonarlint/), and [EditorConfig](https://editorconfig.org/), maintaining consistency and best practices throughout the codebase 🐶
+- **Testing**: Thorough testing conducted with [Jest](https://jestjs.io/), ensuring the reliability and robustness of the application's functionalities 🃏
+- **Backend**: Supported by [CommerceTools](https://commercetools.com/), a leading provider of commerce solutions, offering a robust and scalable platform for creating immersive digital commerce experiences 🌐
+
+## How to Run the Project Locally ⚙️
+
+_to run the project locally, you can follow the following steps:_
+
+- Clone the repository: `git clone https://github.com/stardustmeg/greenshop.git`
+- Navigate to the project directory: `cd greenshop`
+- Install dependencies: `npm install`
+- Run the project: `npm run dev`
+
+## Availabile Scripts 📑
+
+_you can run the following scripts in the project directory:_
+
+- `npm run dev`: Initiates the Vite development server.
+- `npm run build`: Transpiles TypeScript files using TypeScript compiler and builds the project using Vite.
+- `npm run preview`: Launches a production server to preview the project built with Vite.
+- `npm run format`: Applies code formatting using Prettier.
+- `npm run ci:format`: Checks code formatting compliance using Prettier.
+- `npm run typecheck`: Performs TypeScript type checking without emitting any files.
+- `npm run lint`: Lints the codebase using ESLint.
+- `npm run lint:fix`: Fixes linting errors automatically using ESLint for TypeScript files.
+- `npm run lint-styles`: Lints SCSS stylesheets using Stylelint.
+- `npm run prepare`: Sets up Husky for managing git hooks.
+- `npm run test`: Runs tests using Jest with a specific configuration file (`jest.config.cjs`).
+
+## Contact us 📩
+
+- Margarita Golubeva (my GitHub: [stardustmeg](https://github.com/stardustmeg))
+- Maxim Zabaluev (my GitHub: [Kleostro](https://github.com/kleostro))
+- Yuliya Kursevich (my GitHub: [YulikK](https://github.com/yulikk))

package.json

@@ -1,8 +1,8 @@
 {
-  "name": "eCommerce Application",
+  "name": "Greenshop",
   "private": true,
   "version": "1.0.0",
-  "description": "The Best e-Commerce-Project",
+  "description": "The Best eCommerce Application",
   "type": "module",
   "scripts": {
     "dev": "vite",