README.md

OnlineBookSales-Backend

This project named Online Book Sales - Backend deals with developing an e-commerce website for Online Book Sale. It provides the user with a catalog of different books available for purchase in the store. In order to facilitate online purchase, a shopping cart is provided to the user. The system is implemented using a 3-tier approach, with a backend database, a middle tier of Node.js and Express.js, and a web browser as the front end client.

💥 Features

• Registration and Login System.

✨ Link Of The Project

https://online-book-sales-backend.onrender.com/

📌 Tech Stack

How to Contribute

If you think that you can add a new feature or want to fix a bug, we invite you to contribute to Online Book Sales and make this project better. To start contributing, follow the below instructions:

1. Create a folder at your desire location (usually at your desktop).

2. Open Git Bash Here

3. Create a Git repository.

   Run command git init

4. Fork the repository.

5. Clone your forked repository of project.

git clone https://github.com/<your_username>/OnlineBookSales.git

6. Navigate to the project directory.

cd FunwithScience

7. Add a reference(remote) to the original repository.

git remote add upstream https://github.com/Trisha-tech/OnlineBookSales.git

8. Check the remotes for this repository.

git remote -v

9. Always take a pull from the upstream repository to your main branch to keep it updated as per the main project repository.

git pull upstream main

10. Create a new branch(prefer a branch name that relates to your assigned issue).

git checkout -b <YOUR_BRANCH_NAME>

11. Perform your desired changes to the code base.

12. Check your changes.

git status

git  diff

13. Stage your changes.

git add . <\files_that_you_made_changes>

14. Commit your changes.

git commit -m "relavant message"

15. Push the committed changes in your feature branch to your remote repository.

git push -u origin <your_branch_name>

16. To create a pull request, click on compare and pull requests.

17. Add an appropriate title and description to your PR explaining your changes.

18. Click on Create pull request.

Congratulations🎉, you have made a PR to the FunwithPhysics. Wait for your submission to be accepted and your PR to be merged by a maintainer.

How to run the webpage on your local system

1. Go to the OnlineBookSales directory.

cd OnlineBookSales

2. Write the command.

npm install

3. For Frontend Go to 'client' directory write command

   npm install
   

4. Write the command.

yarn start / npm start

If you have any doubts, please let us know in the comments.

Using GitHub Desktop

Alternatively, you can use GitHub Desktop to manage this repository. Here's how:

1. Download and Install GitHub Desktop:

   • Go to the GitHub Desktop website and download the GitHub Desktop application.
   • Follow the installation instructions to install GitHub Desktop on your computer.

2. Clone the Repository:

   • Open GitHub Desktop and sign in to your GitHub account.
   • Click on the "File" menu, then select "Clone Repository..."
   • Choose the repository you want to clone from the list or enter its URL.
   • Choose the local path where you want to clone the repository and click "Clone".

3. Make Changes:

   • After cloning the repository, you can make changes to the files locally using your preferred code editor.

4. Commit Changes:

   • Once you've made changes, open GitHub Desktop.
   • You'll see a list of files with changes. Write a summary and description of your changes in the text fields.
   • Click "Commit to main" to commit your changes locally.

5. Push Changes:

   • To push your changes to the remote repository on GitHub.com, click "Push origin".

6. Pull Changes:

   • If there are changes on the remote repository that you don't have locally, you can pull them by clicking "Fetch origin" or "Pull origin".

7. Sync Changes:

   • To synchronize your local repository with the remote repository, click "Sync" to push and pull changes in one step.

That's it! You can now use GitHub Desktop to manage this repository efficiently.

Table of Contents

1. MVC Diagram
2. Database Design
   • Customer Collection in MongoDB
   • Product Collections in MongoDB
   • Order Collection in MongoDB
3. Usecase Diagram
4. Activity Diagram
   • Login Activity Diagram
   • Registration Activity Diagram
   • Admin Registration Activity Diagram
   • Admin Login Activity Diagram
   • User Activity Diagram
5. Screenshots of the Project
6. Customer Database (MongoDB) Schema
7. Product Database (MongoDB) Schema
8. Order Database (MongoDB) Schema
9. Customer Routes
10. Product Routes
11. Order Routes
12. Middleware for Customer Authentication
13. Middleware for Error Handler
14. Implementation of JWT Token
15. New Customer Registration Route/API
    • POST Request for Customer Registration
16. Customer Login Route/API
    • POST Request for Custom Login
17. Get Customer Details Route/API
18. Update Customer Profile Route/API
    • Customer Details Update Route
19. Update Customer Password Route/APl
20. Product Creation Route/API
    • POST Request for Production Creation Route
21. Get all Products (Admin) Route/API
    • GET Request for Get All Products Route
22. Get Product Details Route/API
    • GET Request Get Product Details Route
23. Update Product (Admin) Route/API
    • PUT Request for Update Product Route
24. Delete Product Route/API
    • DELETE Request for Delete Product Route
25. New Order Creation Route/API
    • POST Request for New Order Creation Route
26. Get Single Order Route/API
    • GET Request for Get Single Order Route
27. Get Logged in Customer Order Route/API
    • GET Request for Get Logged in Customer Order Route
28. Update Order Status (Admin) Route/API
    • PUT Request for Update Order Status Route
29. Delete Order(Admin) Route/API
    • DELETE Request for Delete Order Route

MVC Diagram

Database Design

1. Customer Collections in MongoDB

2. Product Collections in MongoDB

3. Order Collections in MongoDB

Use-Case Diagram

Activity Diagram

1. Login Activity Diagram

2. Registration Activity Diagram

3. Admin Registration Activity Diagram

4. Admin Login Activity Diagram

5. User Activity Diagram

📸 Screenshots Of The Project

1. Customer Database (MongoDB) Schema

2. Product Database (MongoDB) Schema

3. Order Database (MongoDB) Schema

4. Customer Routes

5. Product Routes

6. Order Routes

7. Middleware for Customer Authentication

8. Middleware for Error Handler

9. Implementation of JWT Token

10. New Customer Registration Route/API

POST Request for Customer Registration

11. Customer Login Route/API

POST request from Customer Login

12. Get Customer Details Route/API

13. Update Customer Profile Route/API

Customer Details Update Route

14. Update Customer Password Route/API

15. Product Creation Route/API

POST request for Product Creation Route

16. Get All Products (Admin) Route/API

GET request for Get All Products Route

17. Get Product Details Route/API

GET request for Get Product Details Route

18. Update Product (Admin) Route/API

PUT request for Update Product Route

19. Delete Product Route/API

DELETE request for Delete Product Route

20. New Order Creation Route/API

POST request for New Order Creation Route

21. Get Single Order Route/API

GET Request for Get Single OrderRoute

22. Get Logged in Customer Orders Route/API

GET request for Get Logged In Customer Orders Route

23. Update Order Status (Admin) Route/API

PUT request for Update Order Staus Route

24. Delete Order (Admin) Route/API

DELETE request for Delete Order Route

Our Contributors ❤️

Thank you for contributing to our repository

💙 Thank You !!! 💙