https://github.com/raykipkorir/ecommerce_savannah
Backend Technical Challenge
https://github.com/raykipkorir/ecommerce_savannah
django-rest-framework oauth2 rest-api
Last synced: 5 months ago
JSON representation
Backend Technical Challenge
- Host: GitHub
- URL: https://github.com/raykipkorir/ecommerce_savannah
- Owner: raykipkorir
- License: mit
- Created: 2024-02-14T04:46:26.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2025-02-02T08:12:46.000Z (over 1 year ago)
- Last Synced: 2025-02-02T09:20:10.485Z (over 1 year ago)
- Topics: django-rest-framework, oauth2, rest-api
- Language: Python
- Homepage: https://ecommerce-savannah.onrender.com
- Size: 118 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Ecommerce Savannah
## Overview
Backend Technical challenge
### Available functionalities
1. Users can sign in via Google or GitHub. Once signed in a cart instance is created.
2. Users can add products to cart as well as increment or decrement the quantity of the product in cart.
3. Once the product is added to cart, users can make an order. An SMS will be sent to the phone number provided by the user acknowledging the order made.
4. Staff and admin can update the status of the user's order.
### Tech stack
- Django
- PostgreSQL
- Render
- Amazon S3
- Docker and docker-compose
- GitHub Actions
- Africa's talking
### API documentation
- [Swagger documentation](https://ecommerce-savannah.onrender.com/api/schema/swagger/)
- [Redoc documentation](https://ecommerce-savannah.onrender.com/api/schema/redoc/)
- [Postman collection](https://www.postman.com/raykipkorir/workspace/public-workspace/request/19883034-99678c5d-b4dd-4fc9-9651-1bb48fc68bb6)
### Authentication
Users can sign up and login using Google or Github
- [Google Auth url](https://accounts.google.com/o/oauth2/v2/auth?redirect_uri=https://ecommerce-savannah.onrender.com/api/google-callback/&prompt=consent&response_type=code&client_id=611241998884-3vt81edvfbvca97515qrqpha6rghfcqt.apps.googleusercontent.com&scope=openid%20email%20profile&access_type=offline)
- [Github Auth url](https://github.com/login/oauth/authorize?client_id=b3613d55c08b9555021f&redirect_uri=https://ecommerce-savannah.onrender.com/api/github-callback/&scope=user)
### Database
Connected PostgreSQL database hosted on Render
[Database design](https://drawsql.app/teams/rays-team/diagrams/ecommerce-savannah)
### Tests
Backend test coverage - 95%
`coverage run manage.py test`
`coverage report`
### CI/CD
Integrated Github Actions
### Deployment
Deployed on Render -> [Ecommerce Savannah](https://ecommerce-savannah.onrender.com)
# Getting started
### Installation
Clone the repository in your terminal
```
git clone https://github.com/raykipkorir/ecommerce_savannah.git
```
Navigate into the repo
```
cd ecommerce_savannah
```
Create virtual environment
```
virtualenv venv
```
Activate virtual environment
- For windows users
```
venv\Scripts\activate
```
- For unix based systems
```
source venv/bin/activate
```
Install dependencies
```
pip install -r requirements.txt
```
Run migrations and server
```
python manage.py migrate
python manage.py runserver
```
## Contributing
Contributions are welcome!
## License
This project is available as open source under the terms of the [MIT License](https://opensource.org/license/mit/)