Update README.md

README.md

@@ -1,2 +1,71 @@
-# svit-svitla-app
-
+# Inventory Management and QR Code Generation Service for Offline Store "Svit Svitla"
+
+## About Us
+
+We are a team of junior specialists who have come together to implement a creative project for an offline lighting devices store and gain experience in teamwork. Our product is currently an MVP, but we already have several ideas for expanding it.
+
+## Project Overview
+
+The Svit Svitla application is an MVP service designed for product inventory management and the generation of QR codes for products. The application allows store managers to create detailed product cards, which include photos, pricing, and specifications. Upon creating a product card, a QR code is automatically generated, which can be printed and attached to the corresponding product. Store customers can scan the QR code to view product information and share it through various messaging platforms.
+
+## Key Features
+
+### For Store Managers
+- **Creating a Product Card:** A user-friendly interface for creating product cards, including textual information and photographs.
+- **QR Code Generation:** Automatic generation of QR codes for each product card, with options to download and print.
+- **Product Card Management:** View, edit, and delete product cards within the application.
+- **Product Search by Article Number:** Quickly retrieve product cards using a unique article number.
+- **Pre-order Catalog Creation:** Generate and store PDF catalogs of products available for pre-order, which can be downloaded by customers.
+
+### For Store Customers
+- **QR Codes for Products:** Scan QR codes to access detailed product information.
+- **Product Card Sharing:** Share product cards via any installed messenger application.
+- **Catalog of Available Products:** Browse the catalog of products currently available in the offline store.
+- **Product Filter by Categories:** Filter products by category within the catalog.
+- **Downloading PDF Catalogs:** Download PDF versions of product catalogs.
+- **Leave Feedback:** Scan a QR code in the store to leave feedback, which is stored in the database and sent to the CEO.
+
+## Development Tools
+
+### Frontend
+- **React**
+- **Redux Toolkit**
+- **JavaScript (ES6+)**
+- **Styled Components**
+- **Vite**
+- **REST API**
+
+### Backend
+- **Express.js**
+- **MongoDB**
+- **Azure**
+
+### Testing and Other Tools
+- **Trello**
+- **Postman**
+- **DevTools**
+
+## Adaptations
+
+The application is designed to be responsive and works seamlessly across different devices:
+- **Mobile**
+- **Tablet**
+- **Desktop**
+
+## Project Links
+
+- **Frontend Repository:** [GitHub - Frontend](https://github.com/NatalyKrvch/svit-svitla-app)
+- **Backend Repository:** [GitHub - Backend](https://github.com/NatalyKrvch/svit-svitla-api)
+- **Design Project on Figma:** [Figma Design](https://www.figma.com/file/8Z4MnKF5usgzyRm8MSaUDg/lamps-feedback-project?type=design&node-id=54298-36194&mode=design&t=hvD2f0DKlBcj9YCj-0)
+- **Web Application:** [Svit Svitla Web App](https://svit-svitla.com/)
+
+**Note:** The main functions like creating or editing product cards are restricted to authorized users only.
+
+## Contact Information
+
+- **Anastasiia Smirnova - Project Manager**: [LinkedIn](https://www.linkedin.com/in/anastasiasmirnovapm/)
+- **Maryna Borovikova - UI/UX Designer**: [LinkedIn](https://www.linkedin.com/in/maryna-borovikova/)
+- **Mykyta Kresik - Fullstack Developer**: [LinkedIn](https://www.linkedin.com/in/mykyta-kresik/)
+- **Nataliia Kravchenko - Frontend Developer**: [LinkedIn](https://www.linkedin.com/in/nataliiakravchenko/)
+- **Oksana Koss - Frontend Developer**: [LinkedIn](https://www.linkedin.com/in/oksana-koss-it/)
+- **Diana Kurylovska - QA**: [LinkedIn](https://www.linkedin.com/in/diana-kurylovska-031928232/)