https://github.com/codewithgodstime/drf-authx
https://github.com/codewithgodstime/drf-authx
Last synced: 14 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/codewithgodstime/drf-authx
- Owner: codeWithGodstime
- Created: 2024-09-27T14:54:48.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2024-10-20T14:52:56.000Z (7 months ago)
- Last Synced: 2025-05-07T18:16:24.371Z (14 days ago)
- Language: Python
- Size: 30.3 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# DRF AuthCore Boilerplate
## Overview
A customizable Django REST Framework (DRF) authentication boilerplate with JWT support, email verification, password reset, and a focus on **Test-Driven Development (TDD)**. This provides a flexible foundation without unnecessary routes or dependencies.
## Features
- Custom User Model
- JWT Authentication
- Email Verification
- Password Reset
- TDD-based Test Suite
- Minimal Dependencies
## Installation
1. Clone the repo:
```bash
git clone https://github.com/yourusername/drf-auth-boilerplate.git
cd drf-auth-boilerplate```
2. pip install -r requirements.txt
3. Set up .env:
```.env
SECRET_KEY=your-secret-key
EMAIL_BACKEND=django.core.mail.backends.smtp.EmailBackend
EMAIL_HOST=smtp.your-email-provider.com
EMAIL_PORT=587
EMAIL_USE_TLS=True
[email protected]
EMAIL_HOST_PASSWORD=your-email-password
```
4. python manage.py migrate
```
python manage.py migrate
```
## Endpoints
- Register: /api/auth/register/
- Login: /api/auth/login/
- Logout: /api/auth/logout/
- Verify Email: /api/auth/verify-email/
- Password Reset: /api/auth/password-reset/
- Password Change: /api/auth/password-change/