README.md

Django implementation of the community's backend.

It implements a simple authentication using dj-rest-auth.

Github authentication to be added later.
check the api/urls.py files for authentication api path

It has a custom user model.

The custom user model is in the api folder , the user manager has not yet been implemented.

Collaboration

Please contribute to the repo.

Create an issue before cloning and later on creating a pull request.

Set Up , Install & Run

Clone Repository

git clone https://github.com/savannah-Silica/django-backend

Create a Virtual Environment

It is suggested to have a dedicated virtual environment for each Django project, and one way to manage a virtual environment is pipenv or venv, which is included in Python.

With venv, you can create a virtual environment by typing this in the command prompt, remember to navigate to where you want to create your project.

Windows:

py -m venv myproject

Unix/MacOS:

python -m venv myproject

This will setup a virtual environment. Then you have to activate the environment, by typing this command:

Windows:

myproject\Scripts\activate.bat

Unix/MacOS:

source myproject/bin/activate

Once the environment is activated, you will see this result in the command prompt:

Windows:

(myproject) C:\Users\Your Name>

Unix/MacOS:

(myproject) ... $

Note: You must activate the virtual environment every time you open the command prompt to work on your project.

Install dependencies

Ensure you have python running on your machine.

pip install -r requirements.txt

Run

Open the terminal in the main directory and run

python manage.py runserver