README.md

[](#contributors-)

Oxygen

An API Ready starter boilerplate with Django and Django Rest Framework

Features

• Login/Registration/Logout
• JWT Based Authentication
• Session Based Authentication
• Cookie Based Authentication
• Customized User Model
• OTP Based Login System
• Email Verification
• Docker Ready

Endpoints

1. Login: (Two Endpoints for currently)

   POST: account/login/ OTP is not Supported

   Payload:

   {
     "email": "",
     "password": ""
   }

   Response: 200

   {
     "access_token": "",
     "refresh_token": "",
     "user": {
       "pk": 1,
       "email": ""
     }
   }

   POST: account/token/ OTP is Supported, Session Authentication Supported

   Payload:

   {
     "email": "",
     "password": ""
   }

   Response: 200

   {
     "refresh": "",
     "access": ""
   }

2. Resigtration:

   POST: account/registration/

   Payload:

   {
     "email": "",
     "username": "",
     "password1": "",
     "password2": ""
   }

   Response:

3. Logout: Only for Cookie Based Authentication

   POST: account/logout/

   Payload:

   Response: 401

   {
     "detail": "Refresh token was not included in request data."
   }

4. Password Change:

5. Forget Password:

6. Validate Password:

7. Activate OTP:

8. Login With OTP:

9. Email Verification:

10. etc.

Run Project

To Run this project View This Documentation

Contribution

You can contribute to this project one of the following ways.

Make improvement

I know that this project has a lot of improvement to do. If you want to make improvement you can fork this project and make a pull request with your improvement.

N.B. Make sure to provide a good documentation of your pull request.

NOTE: We use black and isort as code formatter. So while contributing make sure to run below command in your git-bash terminal to activate pre commit

bash pre-commit.sh

Give star and share

You can give star to this project and share with your developer friends. So that they can start their next big startup easily from here.

Buy me a coffee

If you feel generous, you can donate to this project to this following link.

---

Contributors:

Made with contrib.rocks.

Contributors

Nahidujjaman Hridoy 🚧 🤔

Current Donators:

TODO

• Create Better Documentation
• Optimize Code
• Improve the endpoints
• Make single endpoint for login
• Include Social Authentication
• Create a demo frontend
• And More