anas12091101 / scratchdjango

Django Scratch

A SaaS based django application built from scratch.

Run Locally

Clone the project

  git clone https://github.com/Anas12091101/ScratchDjango

Go to the project directory

  cd ScratchDjango

Add .env file

  touch .env
  // Following variables should be set in environment
    DJANGO_SECRET_KEY = "Your Django Secret Key"
    DATABASE_URL = "postgres://postgres:<password>@0.0.0.0:5432/<Your database name>"
    EMAIL_HOST_PASSWORD = "Provided by your email service provider(gmail etc)"
    EMAIL_HOST_USER = "Provided by your email service provider(gmail etc)"
    PAYPAL_CLIENT_ID = "Your Paypal client ID of your account"
    PAYPAL_CLIENT_SECRET = "Your Paypal client secret of your account"

Running with docker

  docker compose up
  docker exec -it <web container name> -bash
  python manage.py migrate

Running without docker

  pip install -r req/local.txt
  python manage.py migrate
  python manage.py runserver

API Reference

Register User

Registers the user

  POST /user/register_user/

Parameter	Type	Description
name	string	Required Your name
otp_enabled	string	Required None or "GA"(for google Authenticator) or "Email"(for email based OTP)
email	string	Required Your valid email
password	string	Required Password

Login

Returns JWT token on valid credentials if OTP is not enabled else the type of OTP

  POST /user/login/

Parameter	Type	Description
email	string	Required
password	string	Required

Check OTP

Returns JWT token on valid credentials and OTP

  POST /user/check_otp/

Parameter	Type	Description
email	string	Required
password	string	Required
otp	string	Required

Password Reset

Sends email with the reset token

  POST /user/api/password_reset/

Parameter	Type	Description
email	string	Required

Password Confirm Reset

Resets the password

  POST /user/api/password_reset/confirm/

Parameter	Type	Description
token	string	Required
password	string	Required