https://github.com/mikaelm1/ecommerce-api

An open source Django backend for e-commerce apps.
https://github.com/mikaelm1/ecommerce-api

Last synced: about 1 month ago
JSON representation

An open source Django backend for e-commerce apps.

• Host: GitHub
• URL: https://github.com/mikaelm1/ecommerce-api
• Owner: mikaelm1
• License: mit
• Created: 2017-09-05T19:34:28.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2018-02-18T01:39:35.000Z (about 7 years ago)
• Last Synced: 2024-11-11T17:48:40.554Z (3 months ago)
• Language: Python
• Homepage:
• Size: 68.4 KB
• Stars: 1
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Overview

An open source Django backend API for ecommerce apps.

## Getting Started

1. [Install Docker](https://docs.docker.com/engine/installation/)

2. Clone the repo: `git clone https://github.com/mikaelm1/ecommerce-api.git`

3. Rename `src/ecommerce/settings/dev.py.example` to `src/ecommerce/settings/dev.py` and replace the `xxx` values with your proper values.

4. Renamce `.env.example` to `.env` and replace the `xxx` values with those from settings.

5. Run: `chmod +x run.sh` to make a helper script executable.

6. Run `./run.sh d` to start up the development environment.

## API Documentation

You can view all the routes available in the app by visiting: `localhost:8080`.

API documentation is built using DRF's [built-in documentation tool](http://www.django-rest-framework.org/topics/documenting-your-api/).

## Authentication

Authentication is done using [JWT](https://github.com/GetBlimp/django-rest-framework-jwt).

All auth protected routes must have the following in the header:

```

Authorization: JWT the_token_here

```

## Running Tests

To run all the tests in the project: `./run.sh t`

## Running in Production

The production environment uses gunicorn as the web server and nginx as a reverse proxy. 

1. Rename `docker-compose.prod.yml.example` to `docker-compose.prod.yml`

2. Run: `./run.sh p`