Project Description

Welcome to the Arcana Candles E-Commerce Platform! Our system is crafted to effortlessly manage product sales, prioritizing security, data integrity, and user-friendly interfaces. Whether you're a customer or part of our administrative team, expect a seamless experience tailored to your needs.

Functional Requirements:

1.User Roles and Authentication:

• The system distinguishes between different user roles, such as customers (normal users) and administrative staff, each with specific permissions.
• Robust authentication mechanisms are in place to ensure that only authorized users can access the system securely.

2.Products Management:

• Administrative staff can effortlessly create, modify, and oversee product details, encompassing product names, prices, descriptions, and images.
• Authorized personnel can easily view and update product information as needed.

3.Comments Management:

• Users have the capability to leave comments on relevant products.
• The system facilitates the creation and editing of comments, enhancing user engagement and interaction.

4.Promotions:

• Customers are greeted with promotional posters on the homepage, highlighting ongoing offers and deals.

5.Customers Reviews:

• Customers can conveniently access top reviews from other customers directly on the homepage, aiding in informed decision-making.

Technical Implementation:

Our system will be developed as a RESTful API, utilizing modern web technologies to ensure scalability, security, and ease of integration with other systems. Data will be stored securely and redundantly, with appropriate encryption and access controls in place. We will prioritize user experience, with intuitive interfaces and responsive design to ensure accessibility across various devices.

Getting Started with Project

To get started with the project, follow these steps:

1. Clone the Repository: Clone the project repository to your local machine using the following command:
   • git clone <repository_url>
2. Install Dependencies: Open a terminal within the project directory and run the following command to install all dependencies:
   • npm install
3. Create .env file: use "MONGO" for your MongoDB url and use "JWT_SECRET" for secret key:
   • JWT_SECRET = "anything"
   • MONGO = "mongodb+srv://xxx:xxx@xxx-xxx.nfsmyma.mongodb.net/?retryWrites=true&w=majority&appName=xxx-xxx"
4. Run Backend Server: Start the backend server by running the following command in the terminal:
   • npm run dev
5. Run Frontend Server: Open a new terminal and navigate to the frontend directory within the project directory using the following command:
   • cd frontend
6. Create .env file: use "VITE_FIREBASE_API_KEY" for your firebase api key:
   • VITE_FIREBASE_API_KEY = ""AIzaxxxxxxxxxxxxxxxxxxx"
7. Then, run the following command to start the frontend server:
   • npm run dev
8. Access the Application: Open a web browser and go:
   • http://localhost:5173/
9. Login: You can log in as an admin, faculty, or student using the provided credentials.
10. With these steps, you should now be able to run the project locally and access it through your web browser.

API Documentation

You can access the API documentation for our Arcana Candles E-Commerce website through Postman. Please follow these steps to view the documentation:

1. Open Postman and ensure you are logged in.
2. Import the provided collection of APIs.
3. Once imported, you can explore the available endpoints, request methods, and parameters.
4. Each API endpoint is documented with details such as its purpose, expected input parameters, and sample responses.
5. Test the APIs directly within Postman to familiarize yourself with their functionality.