From 4d33a9c9c84dab17c2920415408620795c4728ea Mon Sep 17 00:00:00 2001 From: Mykhailo Pohorenyi <116377279+mpohorenyi@users.noreply.github.com> Date: Sat, 30 Dec 2023 21:51:57 +0200 Subject: [PATCH] Update README.md --- README.md | 208 ++++++++++++++++++++++++++++++------------------------ 1 file changed, 117 insertions(+), 91 deletions(-) diff --git a/README.md b/README.md index 4cef0f5..c70275d 100644 --- a/README.md +++ b/README.md @@ -1,108 +1,77 @@ -

Nice Gadgets ๐Ÿ‘Œ

- -
- -To get started, you need to clone the repository locally and run the next command: - -``` -npm install -``` - -We constantly work in this repository, you don't need to clone it every time, you only need to clone it for the first time - -Group work on the project is carried out in separate branches, which should be called the name of your task - -Before you start working on your task, you must pull the current version of the repository and MUST create your own branch IMMEDIATELY: - -``` -git pull -git checkout -b "" -``` - -After you finish working on the task, you should add all the changed files, commit them, push them to YOUR CREATED BRANCH, and make Pull Requests - -``` -git add -git commit -m "" -git push origin "" -``` - -Please make commits for each fully completed part of the task and name them properly - -
- -# ๐Ÿš€ Available Scripts - -In the project directory, you can run: - -
- -## โšก๏ธ start - -``` -npm start -``` - -Runs the app in the development mode.\ -Open [http://localhost:3000](http://localhost:3000) to view it in the browser. - -
- -## ๐Ÿงถ lint - -``` -npm run lint -``` - -
- -## ๐ŸŽฏ format - -``` -npm run format -``` - + + +

Welcome to Nice Gadgets store ๐Ÿ‘‹

+
+ + ![Create React App](https://img.shields.io/badge/Create%20React%20App-09D3AC.svg?style=for-the-badge&logo=Create-React-App&logoColor=white) + ![HTML5](https://img.shields.io/badge/html5-%23E34F26.svg?style=for-the-badge&logo=html5&logoColor=white) + ![CSS3](https://img.shields.io/badge/css3-%231572B6.svg?style=for-the-badge&logo=css3&logoColor=white) + ![SASS](https://img.shields.io/badge/SASS-hotpink.svg?style=for-the-badge&logo=SASS&logoColor=white) + ![TypeScript](https://img.shields.io/badge/TypeScript-3178C6.svg?style=for-the-badge&logo=TypeScript&logoColor=white) + ![React](https://img.shields.io/badge/React-61DAFB.svg?style=for-the-badge&logo=React&logoColor=black) + ![React Router](https://img.shields.io/badge/React%20Router-CA4245.svg?style=for-the-badge&logo=React-Router&logoColor=white) + ![Redux](https://img.shields.io/badge/Redux-764ABC.svg?style=for-the-badge&logo=Redux&logoColor=white) + ![Axios](https://img.shields.io/badge/Axios-5A29E4.svg?style=for-the-badge&logo=Axios&logoColor=white) + ![EsLint](https://img.shields.io/badge/ESLint-4B32C3.svg?style=for-the-badge&logo=ESLint&logoColor=white) + ![Prettier](https://img.shields.io/badge/Prettier-F7B93E.svg?style=for-the-badge&logo=Prettier&logoColor=black) +
+ +
- -## ๐ŸŽญ format + test - -``` -npm run fix-style -``` - -This command will be automatically run before each commit - -
- -## ๐Ÿ’€ WARNING - -Please, do not run any scripts other than the ones mentioned above. - -
- -# ๐Ÿงฌ Project structure (in process) - -This is the structure of the files in the project: +
+ + Logo + + +

+ View Demo +

+
+ + +
+ Table of Contents +
    +
  1. + About The Project +
    2. +
  2. + Project structure +
    3. +
  3. Contributors
    4. +
+
+ + +## About The Project +
+ + ![Nice Gadgets Demo](https://media2.giphy.com/media/v1.Y2lkPTc5MGI3NjExZDRhd25udWt2dWl1djZoaGpoY3o2bnAxeW5iZGhoenB4bHFqa2lnNSZlcD12MV9pbnRlcm5hbF9naWZfYnlfaWQmY3Q9Zw/ZX8qTXn3O5nMHtNdcS/giphy.gif) +
+ +## Project structure ```sh โ”‚ โ”œโ”€โ”€ public # public files (favicon, .htaccess, manifest, ...) โ”œโ”€โ”€ src # source files - โ”‚ โ”œโ”€โ”€ api - โ”‚ โ”œโ”€โ”€ fonts - โ”‚ โ”œโ”€โ”€ modules # Pages, shared components constants and other resources + โ”‚ โ”œโ”€โ”€ api # API services + โ”‚ โ”œโ”€โ”€ fonts # projects fonts + โ”‚ โ”œโ”€โ”€ helpers # help functions + โ”‚ โ”œโ”€โ”€ modules # pages and shared components โ”‚ โ”‚ โ”œโ”€โ”€ Pages โ”‚ โ”‚ โ””โ”€โ”€ shared - โ”‚ โ”œโ”€โ”€ store # Redux store + โ”‚ โ”œโ”€โ”€ static # static images (logos, icons, banners, ...) + โ”‚ โ”œโ”€โ”€ store # redux store โ”‚ โ”‚ โ””โ”€โ”€ reducers # store's reducers - โ”‚ โ”œโ”€โ”€ styles + โ”‚ โ”œโ”€โ”€ styles # main project styles โ”‚ โ”œโ”€โ”€ types # data interfaces โ”‚ โ”œโ”€โ”€ utils # utilities functions โ”‚ โ”œโ”€โ”€ App.scss โ”‚ โ”œโ”€โ”€ App.tsx โ”‚ โ”œโ”€โ”€ index.tsx โ”‚ โ”œโ”€โ”€ react-app-env.d.ts - โ”‚ โ””โ”€โ”€ Root.tsx # React component with all the routes + โ”‚ โ””โ”€โ”€ Root.tsx # react component with all the routes โ”œโ”€โ”€ .editorconfig โ”œโ”€โ”€ .eslintrc.js โ”œโ”€โ”€ .gitignore @@ -113,4 +82,61 @@ This is the structure of the files in the project: โ””โ”€โ”€ tsconfig.json ``` -

The description will be supplemented

+## Contributors + +
+
+ ๐Ÿ‘จโ€๐Ÿ’ผ Mykhailo Pohorenyi (Team Lead) + + [Github](https://github.com/mpohorenyi) + [LinkedIn](https://www.linkedin.com/in/mykhailo-pohorenyi/) + [Telegram](https://t.me/mpohorenyi) + Gmail +
+ +
+ ๐Ÿ‘ฉโ€๐Ÿ’ผ Olha Koziuk + + [Github](https://github.com/OlhaKoziuk) + [LinkedIn](https://www.linkedin.com/in/olha-koziuk-9a84402a0/) + [Telegram](https://t.me/olhakoziuk) + Gmail +
+ +
+ ๐Ÿ‘ฉโ€๐Ÿ’ผ Viktoriia Levik + + [Github](https://github.com/vlevik) + [LinkedIn](https://www.linkedin.com/in/viktoriia-levik-1905131b1/) + [Telegram](https://t.me/lefka) + Gmail +
+ +
+ ๐Ÿ‘ฉโ€๐Ÿ’ผ Anastasiia Karkachova + + [Github](https://github.com/dsfreedom) + [LinkedIn](https://www.linkedin.com/in/anastasiia-karkachova-47220819a/) + [Telegram](https://t.me/dancingsparrow) + Gmail +
+ +
+ ๐Ÿ‘จโ€๐Ÿ’ผ Denys Shurubura + + [Github](https://github.com/DenysShurubura) + [Telegram](https://t.me/shur416) + Gmail +
+ +
+ ๐Ÿ‘จโ€๐Ÿ’ผ Andrii Shmahin + + [Github](https://github.com/mifyy) + [LinkedIn](https://www.linkedin.com/in/andrii-shmahin-910b13294/) + [Telegram](https://t.me/mifyy) + Gmail +
+
+ +

(UP)