https://github.com/abdulawalarif/ecommerce_backend_drf
E-commerce Product API app using Django REST framework
https://github.com/abdulawalarif/ecommerce_backend_drf
authentication django django-rest-framework ecommerce python rest-api
Last synced: about 1 month ago
JSON representation
E-commerce Product API app using Django REST framework
- Host: GitHub
- URL: https://github.com/abdulawalarif/ecommerce_backend_drf
- Owner: abdulawalarif
- License: mit
- Created: 2024-10-12T02:47:22.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-10-21T23:35:32.000Z (12 months ago)
- Last Synced: 2025-04-28T15:48:28.631Z (6 months ago)
- Topics: authentication, django, django-rest-framework, ecommerce, python, rest-api
- Language: Python
- Homepage:
- Size: 39 MB
- Stars: 3
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Django REST Framework E-commerce API with Authentication (GET, POST, PUT, DELETE)
## This project provides a Django REST API for an e-commerce platform, supporting CRUD operations (Create, Read, Update, Delete) for products. It includes user authentication for secure access to product data manipulation only (update, delete and create). But user can read for data without auth token.
## Features
* Secure authentication using Django Rest Framework Authentication (JWT Toke)
* Full CRUD support for managing products
* Supports multiple images uploads for products
* API endpoints GET, POST, PUT, and DELETE
* Lightweight and fast, perfect for small to medium-scale e-commerce platforms
## Authentication
Use the provided authentication mechanism to obtain tokens.
* Register User:
* Fill these 3 fields
```bash
URL: POST to Base_URL/api/auth/register
username #PK
email
password
```
* Login User:
```bash
POST to Base_URL/api/auth/login
username
password
```
![Login and Registration visualized ]()
On successful login, you will receive an authentication token to be used in the header for subsequent write requests.
# API Endpoints
## Product Endpoints
* Get All Products:
```bash
GET request to Base_URL/api/products
```
* Get a Single Product:
```bash
GET request to Base_URL/api/product/product_id
```
![Fetching products from Database ]()
* Create Product (Authenticated):
```bash
POST request to Base_URL/api/product/products
# with title, description, num_of_prod_on_stock, price, uploaded_images
# With Auth token
```
![Creating products]()
* Update Product (Authenticated):
```bash
PUT request to Base_URL/api/product/id_of_item
# with title, description, num_of_prod_on_stock, price, uploaded_images
# With Auth token
```
![Update products]()
* Delete Product (Authenticated):
```bash
DELETE request to Base_URL/api/product/delete/id_of_item
# With Auth token
```
## Run Locally
1. Clone the project
```bash
git clone https://github.com/abdulawalarif/ecommerce_backend_DRF.git
```
2. Go to the project directory
```bash
cd ecommerce_backend_DRF && cd ecommerce_backend
```
3. Create a virtual environment
```bash
python3 -m venv .ecom_env
```
4. Activate the virtual environment
```bash
source .ecom_env/bin/activate
```
5. Install all the packages
```bash
pip install -r requirements.txt
```
6. go to the ecommerce_backend/settings.py and change the databse to Sqlite
```bash
DATABASES = {
'default': {
'ENGINE': 'django.db.backends.sqlite3',
'NAME': BASE_DIR / 'db.sqlite3',
}
}
```
Or you can crate a SQL if you want to.
7. Now create migration for your database
```bash
python manage.py makemigrations
```
8. Now Create Tables and Fields for the database
```bash
python manage.py migrate
```
9. Run the project
```bash
python manage.py runserver
```
Now fill some data first with this URL POST request
## How to tweak this project for your own uses
It's a good starter boilerplate, for an ecommerce app, Create models for categories and user's follow a good design architecture and make sure to Normalize the datababse for preventing overload or duplication of same data in multiple places.
## Found a bug?
If you found an issue or would like to submit an improvement to this project,
please submit an issue using the issues tab above. If you would like to submit a PR with a fix, reference the issue you created!
## Known issues (Work in progress)
* Update method do no delete images it just add new images with existing image list.
## Author
- [@abdulawalarif](https://github.com/abdulawalarif)
## License
[MIT](https://choosealicense.com/licenses/mit/)