vscubing api

RESTful api for vscubing.com powerd with Django Rest Framework

Badges

Tech Stack

Django, Django Rest Framework

api docs

Check api documentation in API Docs

Authors

• @HomaDev

Run Locally

Clone the project

  git clone git@github.com:vscubing/vscubing-backend.git -b dev

Go to the project directory

  cd vscubing-backend

Create venv (on linux)

  python3 -m venv venv

Activate venv (on linux)

  source venv/bing/activate

Install requirements

  pip install -r requirements.txt

Before starting the server check the next section "Environment Variables" right below

Start the server

  python manage.py runserver

Environment Variables

To run this project, you will need to add the following environment variables to your .env file

File direction /vscubing-backend/.env

SECRET_KEY = 'django-key'

DEBUG = 1 # 1 == True, 0 == False

GOOGLE_REDIRECT_URL = 'http://127.0.0.1:3000'

ALLOWED_HOSTS = '["127.0.0.1", "127.0.0.1:8000", "0.0.0.0:8000", "192.168.1.7"]'

Contributing

Contributions are always welcome!

See contributing.md for ways to get started.

Support

For support, email savytskyi.work@gmail.com