Merge pull request #179 from 202306-NEA-DZ-FEW/157-enhance-single-pro…

…duct-page Update README.md
202306-NEA-DZ-FEW · Nov 28, 2023 · 9dd217d · 9dd217d
2 parents 10a5825 + 2e8d27a
commit 9dd217d
Show file tree

Hide file tree

Showing 12 changed files with 99 additions and 20 deletions.
diff --git a/README.md b/README.md
@@ -1,27 +1,106 @@
-# Capstone project information
+# Student Store - Capstone project
 
-## Project information
+## WEBSITE DETAILS:
 
--   Project name: Student’s Store
--   Project description: A marketplace made for all students. Any student could sell or buy or even borrow any type of products like electronics, games, study books, all products supposed to be cheap and used in most cases.
--   Technology used: Nextjs, TailwindCSS, DaisyUi, Firebase, i18next, Husky, Prettier, Eslint, Commitlinter (Conventional Commits)
--   Team members: Benarba Tewfik, Hocine Benouddane, Katia Ghezali, Mounia Belkheir, Sami Babouche, Khaoula Aourra
--   Bootcamp: NEA DZ FEW 2023
+### Outline and objective:
 
-## Installation
+The purpose of this website is to create a marketplace for students to sell, buy, or borrow cheap and used products. The objective is to provide a platform where students can easily list and fulfill their product needs.
 
-```shell
-npm install -g commitizen // Installs commitizen
-npx husky install         // Installs Husky
-chmod ug+x .husky/*       // Gives husky executable extension
-npm install               // Installs the node modules
-```
+### Brief Concept:
 
-## Development process
+The website is a marketplace exclusively designed for students. It facilitates the buying, selling, and borrowing of various products, including electronics, games, and study books. The focus is on affordability, with most products being cheap and used.
 
--   When commiting you will have to use `git cz` and then go through the process. Look at the first commit I made to know what that means.
--   The translation process is done using the i18next library. There's an example in the index.js file of how this is done. Check this github project for more info on how to use the i18next library: [i18next](https://github.com/i18next/next-i18next)
--   When writing commits, commitlinter library is used to make sure that your commits are consistent with the conventional commits. To learn more about it refer to the guidelines in Canvas or the [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/#summary) site.
--   The `layout` folder contains the components that will be used in the layout of pages, so components like the header and footer will be placed there.
+### Target Audience:
 
-Good luck and happy coding :D
+Students of all ages, genders, and locations. The language of the platform is tailored for students.
+
+### Three Words to Describe:
+
+Only For Students.
+
+## Features and Functionality:
+
+1. **User Authentification:**
+    - Student account creation and management.
+    - Secure sign-in and sign-up processes.
+2. **Product Management:**
+    - Easy product listing with image upload functionality.
+    - Intuitive product categorization (electronics, games, study books).
+    - Search and filtering options (e.g., by price).
+3. **Donation Page:**
+    - Facilitate a page for users willing to donate items.
+    - Encourage a sense of community and support.
+4. **User Profiles:**
+    - Robust user profile management.
+    - Option to view and edit personal information.
+    - Track and manage listed products.
+5. **Multi-language Support:**
+    - Website content available in English, Arabic, and French.
+    - Enhance accessibility and inclusivity.
+6. **Responsive Design:**
+    - Compatible with desktop, tablet, and mobile devices.
+    - Unique user experience across various screen sizes.
+7. **Internationalization (i18n):**
+    - Implement i18n for seamless translation of content.
+    - Enhance the user experience for speakers of different languages.
+8. **Technology Stack:**
+    - Nextjs for a fast and efficient frontend.
+    - TailwindCSS for a modern and responsive design.
+    - DaisyUi for UI components.
+    - Firebase for backend and database management.
+    - Husky, Prettier, Eslint, Commitlinter for code quality and version control.
+
+### Content:
+
+-   Student account creation and management
+-   Product listing and image upload
+-   Product browsing and filtering (e.g., by price)
+-   Donation page
+-   User profile management
+-   Listing management
+-   Profile information page
+-   User's listings page
+-   User's orders page
+-   Cart management
+-   Checkout process
+-   Internationalization
+-   Responsive design
+
+## Devices:
+
+-   Desktop
+-   Tablet
+-   Mobile
+
+## Project Contributors
+
+-   Benarba Tewfik,
+-   Hocine Benouddane,
+-   Katia Ghezali,
+-   Mounia Belkheir,
+-   Sami Babouche,
+-   Khaoula Aourra
+
+## Additional Details:
+
+-   The platform encourages a sense of community by providing a donation page.
+-   Affordability and usability are emphasized to cater to the student audience.
+-   Regular code quality checks and enhancements are implemented using Husky, Prettier, Eslint, and Commitlinter.
+-   The platform is designed to be easily navigable on different devices, enhancing user accessibility.
+
+## Bootcamp Information:
+
+Re:Coded - NEA DZ FEW 2023
+
+## Screenshots:
+
+![splash](image.png)
+![sign up](image-1.png)
+![sign in](image-2.png)
+![home en](image-3.png)
+![all products](image-5.png)
+![my cart](image-6.png)
+![checkout](image-7.png)
+![profile](image-8.png)
+![my listings](image-9.png)
+![single product](image-10.png)
diff --git a/image-1.png b/image-1.png
diff --git a/image-10.png b/image-10.png
diff --git a/image-2.png b/image-2.png
diff --git a/image-3.png b/image-3.png
diff --git a/image-4.png b/image-4.png
diff --git a/image-5.png b/image-5.png
diff --git a/image-6.png b/image-6.png
diff --git a/image-7.png b/image-7.png
diff --git a/image-8.png b/image-8.png
diff --git a/image-9.png b/image-9.png
diff --git a/image.png b/image.png