Skip to content

Latest commit

 

History

History
56 lines (38 loc) · 1.09 KB

README.md

File metadata and controls

56 lines (38 loc) · 1.09 KB

AuthApi

This project provides a set of REST API endpoints and HTML interface for registration, authentication , password reset, retrieve JWT token on successful login.

Get Started (Locally)

Environment Variables

To run this project, you will need to add the following environment variables to your .env file. If doesn't exists, create .env file.

JWT_SECRET_KEY = "any_randomkey_for_JWT_Token"
EMAIL_USER = "yourgmailid"
EMAIL_PASS = "yourpassword"

Clone the project

  git clone https://github.com/navi532/AuthApi.git

Go to the project directory.

  cd AuthApi

Make sure manage.py exists in current directory.

Install dependencies

For Python 2:

  pip install -r requirements.txt

For Python 3:

  pip3 install -r requirements.txt

(Make sure pip/pip3 is installed in your system)

If running the server for the first time

    python3 manage.py migrate

Start the server

  python3 manage.py runserver

API Documentation

To learn about API Endpoints, start the server and go to /swagger.