Anime fiverr Backend

Anime fiverr is a platform to freelance, shop, get the latest anime news, follow your favourite anime series etc.

API Docs

API documentation is automatically generated using Swagger. You can view documention by visiting at these paths

swagger/
redoc/

Local Development without Docker

Install

# note: this is bash running on windows env/scripts/activate might be env/bin/activate on a full linux environment

git clone [[repo]]

cd [[repo]]/backend

# create virtual environment
python3 -m venv env

# activate virtual environment, linux or git bash
source env/bin/activate

# windows cmd
env\scripts\activate

# create configuration file
cp .env.example .env

# install requirements
make install

make db_setup		# runs make migrate+superuser
make runserver
# python manage.py collectstatic --noinput

Run dev server

This will run server on http://localhost:8000

make runserver

Create superuser

If you want, you can create initial super-user with next commad:

make superuser

Setup database

The default database is sqlite (unsuitable for production), to switch to MySQL, ie. after renaming .env.example to .env, follow the following steps.

At your .env file

# Changed to False
USE_DEFAULT_BACKEND=False

# wil use sqlite 
USE_DEFAULT_BACKEND=True

# set to either mysql or postgres
ALT_BACKEND=mysql

# Set these according to your database server
DB_NAME=
DB_USER=
DB_PASSWORD=
DB_HOST=
DB_PORT=

Ensure mysqlclient is installed

# activate virtual environment first
pip install mysqlclient

That should do it.

With Docker

Docker is setup to work with postgres. to use docker change the following in your .env config file. (I'm not a docker person so if you do choose docker you are on your own)

Start the dev server for local development:

cp .env.dist .env
docker-compose up

Run a command inside the docker container:

docker-compose run --rm web [command]

Contributions

To contribute follow the instructions here