Minimal E-Commerce Solution APIs Assignment
Assignment statement - You need to build a very minimal eCommerce solution APIs, where a user can do the following things:
- Signup
- Login
- See the product list
- See the product in detail and can add it to the cart
- User can checkout cart by selecting one address and order will get placed (No payment system required, it will be cash on delivery only)
- Users can see their order list.
You need to build this using the below steps.
- Build Backend APIs first for above all points. (10 points)
- Push everything in a single git repository, you should keep pushing as you progress rather than pushing all at once. Commits should be with some meaningful commit message, weโll check your GitHub commits. (5 points)
- Write proper documentation for setting up the project, so that one can easily set up the project by following the steps there. (5 points)
- Include a demo video of your assignment, you can share youtube/Vimeo/google drive link (5 points)
Technologies to use:
- For Building Backend APIs, you can use any technologies you want. However, Django REST Framework is preferred.
- Database you can use any SQL, default SQLite will also work.
- For writing documentation i.e. README file, you can use markdown i.e. MD or Restructured Text i.e. RST
- You can use a screen recorder for the demo video
Note - The assignment is distributed above in multiple points, even if youโll complete anyone points out of the first two, You are welcome to submit your assignment, we donโt want to waste your effort without reviewing the code
Explanation / solution :
Download the Assignment Folder
-
First of all you need to download the folder using Download link <== YesAvail Assignment Folder
-
This will take you to a Web page where Your download will Get started Automatically
-
Save Zip file to your Required folder and Then Extract it as Well.
-
After Extracting you will see A Readme.md File and a Sub directory with project Name
-
Open this project folder (Dj_eComm).
Setting Up the server
-
Open it in a Terminal or vs code and open terminal there
-
Run the following command ` python manage.py runserver `
- And open the following link in your browser ` http://127.0.0.1:8000/ `
Using the APIs
-
Its a Basic Backend APIs solution. Therefore, I have not focused much on frontend.
-
Login
Login Page conatins two APIs : Get and POST
- GET API shows the All users registered on this Django APP
-
POST API Lets you Login in to the Web app using post request passing a json object in correct format.
-
Signup
Same goes for sign up page
-
Cart
Cart Page conatins two APIs : Get and POST
- GET API shows the All Products added to part of a particular user
-
POST API Lets you Checkout the cart to complete order by Adding Address to POST Request.
-
Orders
Order Page conatins one APIs : Get
-
GET API shows the All completed order till date of a particular user
-
Product list
Product list Page conatins to APIs : Get
-
GET API shows the All Products added to Django App
-
Product Detail
Product Detail Page conatins two APIs : Get and POST
- GET API shows the Specific Product Detail
- POST API Lets you Add that product to the Loged in users Cart
This is How the Whole Minimum ECommerce Solution APIs are Working.