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 [email protected]: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 going forward the server check the next section "Environment Variables" right below

To create fake data for test use, utilize this command

python managenerate_full_data

There are some parms that can be used

how many users to generate --users_qty int

disciplines names to generate --discipline_names str str str

amount of scrumbles to create new contests (after initial generation) --tnoodle_scrambles_qty int

how many moves each new contest scramble with have --tnoodle_scrambles_moves_qty int

how many moves past contests' scrambles and current contest's scramble have --scrambles_moves_qty int

how many past contests to generate --contest_qty int

Example

python manage.py generate_full_data --users_qty 15 --discipline_names 3by3 2by2 --tnoodle_scrambles_qty 20 --contest_qty 5 --tnoodle_scrambles_moves_qty 8 --scrambles_moves_qty 10

Start the server

  python manage.py runserver

Start celery worker

celery -A vscubing.celery worker --loglevel=info

Start celery beat

celery -A vscubing.celery beat --loglevel=info

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 [email protected]