lunaticsatoshi / django-auth-api

A base template for a simple Django based backend API with JWT Authentication

Django Auth API

A base template for a simple Django based backend API with JWT Authentication

Features

• Register as a User
• Create posts anonymously
• Comment on posts

🏗️ Built With

🧩 Getting Started

To get a local copy up and running follow these simple steps.

Clone the repo

1. Clone the repository using the following command

git clone https://github.com/Lunaticsatoshi/Django-Auth-Api.git
# After cloning, move into the directory having the project files using the change directory command
cd django-auth-api

Starting the development server with docker 🐳 (Recommended)

Prerequisites

Make sure you have Docker and docker-compose installed on your machine.

Steps to start the server

1. Add environment file .env in server directory with the variables fiven in the .env.example file.

2. Run the following command to build the docker containers in the project directory itself.

   docker-compose -f docker/docker-compose.debug.yml build

3. Run the following command to run the docker containers in the project directory itself.

   docker-compose -f docker/docker-compose.debug.yml up

4. Open http://localhost:8000 to view it in the browser.

Starting the development server without docker 📡

Prerequisites

Make sure you have Python installed on your machine.

NOTE:

The project was made with python version 3.9. and requires pipenv

Install pipenv globally

pip install pipenv

1. Create a virtual environment using pipenv where all the required python packages will be installed

# Use this on Windows
py -m pipenv shell
# Use this on Linux and Mac
python -m pipenv shell

2. Install pipenv

# Windows
pip install pipenv
# Linux and Mac
pip install pipenv

3. Install all the project Requirements

pipenv install 

-Apply migrations and create your superuser (follow the prompts)

# apply migrations and create your database
python manage.py migrate

# Create a user with manage.py
python manage.py createsuperuser

4. Run the development server

# run django development server
python manage.py runserver

🔐 License

This project is licensed under the MIT License - see the LICENSE.md file for details

Suggestions and Bug Reports

Since this is an open source project all suggestions, requests and bug reports are always welcomed. If you have any don't forget to leave them in the issues section. But we recommend creating an issue or replying in a comment to let us know what you are working on first that way we don't overwrite each other.