API for Ecommerce site

Requirements ==>

The project will have following features-

• The system should have multi-level access. Only admin can add, update or delete product. products will have 2 images, name, stock and price.
• The customers can search and view products.
• User can create orders.
• Admin can get all customer list.
• Admin can get all the order list.
• Admin can update status of orders as followed (delivered, returned)

Additional task requirements:

• Project should be uploaded in git and shared as a git link
• Project structure should follow the convention
• Provide a postman json link which will help us to test your code's functionality
• Code should be readable and properly structured.
• Provide necessary documentation.

Developed API

Login & verify user

SRL	METHOD	ROUTE	FUNCTIONALITY	ACCESS
1	POST	/jwt/create/	Login user	All users
2	POST	/jwt/refresh/	Refresh the access token	All users
3	POST	/jwt/verify/	Verify the validity of a token	All users

User API

SRL	METHOD	ROUTE	FUNCTIONALITY	ACCESS
4	POST	/api/auth/	Register new user	Allow any
5	GET	/api/auth/	List all user	Adminuser
6	PUT	/api/auth/id/	Update user	Adminuser
7	DELETE	/api/auth/id/	Delete user	Adminuser

Product API

SRL	METHOD	ROUTE	FUNCTIONALITY	ACCESS
8	GET	/api/product/	List All product	Allow any
9	PUT	/api/product/	Update product	Adminuser
10	POST	/api/product/	Add new product	Adminuser
11	DELETE	/api/product/id	Delete product	Adminuser
12	GET	/api/search/?search=text	Searched product and view	Allow any

Order API

SRL	METHOD	ROUTE	FUNCTIONALITY	ACCESS
13	GET	/api/order/	List all order	Adminuser
14	POST	/api/order/	Create new order	All users
15	PUT	/api/order/id/	Update order/status	Adminuser
16	DELETE	/api/order/id/	Delete order	All users
17	GET	/api/order/	List Indivisual user’s all order	All users

Tools

Back-end

Language:

Python (3.9.0)

Frameworks:

Django(4.1.1)
django rest framework (3.13.1 )

Other libraries / tools:

asgiref                       3.5.2
autopep8                      1.7.0
certifi                       2022.6.15
cffi                          1.15.1
charset-normalizer            2.1.1
coreapi                       2.3.3
coreschema                    0.0.4
cryptography                  38.0.1
defusedxml                    0.7.1
django-templated-mail         1.1.1
djangorestframework-simplejwt 5.2.0
djoser                        2.1.0
idna                          3.3
itypes                        1.2.0
Jinja2                        3.1.2
MarkupSafe                    2.1.1
mysqlclient                   2.1.1
oauthlib                      3.2.0
Pillow                        9.2.0
pip                           20.2.3
pycodestyle                   2.9.1
pycparser                     2.21
PyJWT                         2.4.0
python-dotenv                 0.21.0
python3-openid                3.2.0
pytz                          2022.2.1
requests                      2.28.1
requests-oauthlib             1.3.1
setuptools                    49.2.1
six                           1.16.0
social-auth-app-django        4.0.0
social-auth-core              4.3.0
sqlparse                      0.4.2
toml                          0.10.2
uritemplate                   4.1.1
urllib3                       1.26.12

Database:

MySQL

Setup

The first thing to do is to clone the repository:

$ https://github.com/MahmudJewel/API-ecommerce_for_mktech

Back-end

Create a virtual environment to install dependencies in and activate it:

$ cd API-ecommerce_for_mktech
$ python -m venv venv
$ source venv/bin/activate

Then install the dependencies:

(venv)$ pip install -r requirements.txt

Note the (venv) in front of the prompt. This indicates that this terminal session operates in a virtual environment set up by virtualenv2.

Once pip has finished downloading the dependencies:

(venv)$ python manage.py migrate
(venv)$ python manage.py runserver 8000

Happy Coding

From ==> Juwel Mahmud