Django Backend with OAuth

This is a Django backend with OAuth authentication. It uses the Django Rest Framework to create a REST API. The OAuth authentication is done using the dj-rest-auth package.

This template is designed for applications using a SPA (Single Page Application) frontend. The frontend is expected to handle the OAuth flow and send the access token to the backend. The backend will then use the access token to authenticate the user.

Features

• User creation/login/logout/reset password
• Creating client applications for OAuth
• OAuth authentication

Setup

1. Clone the repository
2. Create a virtual environment

python3 -m venv venv
source venv/bin/activate

or on Windows:

python -m venv venv
venv\Scripts\activate

3. Install the dependencies

pip install -r requirements.txt

4. Run the migrations

python manage.py migrate

5. Create a superuser

python manage.py createsuperuser

6. Run the server

python manage.py runserver

Additionally, there is a docker-compose file that can be used to run the backend, the PostgreSQL database, and a Redis server for caching. To use it, run:

docker-compose up

Usage

The API endpoints are available at http://localhost:8000/api/v1/. The admin panel is available at http://localhost:8000/admin/, and the dj-rest-auth endpoints are available at http://localhost:8000/auth/.

To create a new client application for OAuth, go to the admin panel and create a new Application. The Client id and Client secret will be generated automatically.

To authenticate a user, send a POST request to http://localhost:8000/auth/login/ with the following JSON body:

{
    "email": "your_email",
    "password": "your_password"
}

This will return an access token that can be used to authenticate future requests. Send the access token in the Authorization header with the value

Bearer your_access_token

License

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

Bugs, Security Vulnerabilities, and Contributing

If you find a bug or security vulnerability, please don't hesitate to create an issue or a pull request. Any contributions are welcome!

Built by

This project was built by Brandon Kong.