Skip to content

Commit

Permalink
Chore: Update readme file
Browse files Browse the repository at this point in the history
  • Loading branch information
johndiginee committed Sep 16, 2023
1 parent 80d97a5 commit 879ea09
Show file tree
Hide file tree
Showing 2 changed files with 80 additions and 5 deletions.
82 changes: 80 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,83 @@
# Porto Shopping Mall API
Porto Shopping Mall API is an eCommerce store API that allows different software applications to communicate and interact with their platform.
Porto Shopping Mall API is an eCommerce store API that allows different software applications to communicate and interact with their platform. This API enables the exchange of data and functionality (such as product, inventory, cart, and customer management, order processing, etc) between their store and other systems, such as mobile apps, third-party software, payment gateways, and more.

## API Features

### User Authentication
* Register user
* Login user
* Change password
* Password reset request
* Password reset confirmation
* Refresh token
* Logout user

### User Profile
* Current user profile
* Update user profile

### Product
* Create product
* Upload product image
* Delete product
* Update product
* List all products
* Get single product

### Order
* Create order
* Get all orders
* Get single order
* Delete order
* Make payment
* Process order

### Review
* Create product review
* Update product review
* Delete product review

## Technologies Used
* Django
* Django Rest Framework
* JWT Authentication
* Mailtrap
* Stripe
* Amazon S3
* Postgres
* Github Actions (Continuous Integration/Continuous Deployment)
* Digital Ocean
* DRF-YASG (API Documentation)

## Installation on local machine

```bash
git clone https://github.com/johndiginee/Porto_Shopping_Mall_API.git
```
```bash
python3 -m venv venv
source venv/bin/activate
```
```bash
source venv/bin/activate
```
```bash
pip install -r requirements.txt
```
```bash
Set DEBUG = True in settings.py
```
```bash
python3 manage.py makemigrations
```
```bash
python3 manage.py migrate
```
```bash
python3 manage.py runserver
```

## Authors
John Diginee - [LinkedIn](https://www.linkedin.com/in/johndiginee/) / [X](http://x.com/johndiginee) / [Person Site](https://johndiginee.com)

## Acknowledgements
[Holberton School](https://www.holbertonschool.com/) & [ALX Africa](https://www.alxafrica.com/) (Mentors, Staff and Students)
3 changes: 0 additions & 3 deletions core/settings.py
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,6 @@
import os
from pathlib import Path
from decouple import config
# import dotenv

# dotenv.read_dotenv()

# Build paths inside the project like this: BASE_DIR / 'subdir'.
BASE_DIR = Path(__file__).resolve().parent.parent
Expand Down

0 comments on commit 879ea09

Please sign in to comment.