🚀 Experience Minimalist in action: View Production
Welcome to the Minimalist Todo Django REST API repository, a backend solution designed for efficient task management. This project was built using Python and the Django REST Framework, catering to applications that require high-performance task handling capabilities.
- Social Authentication: Utilizes dj-rest-auth, allauth, and JWT to enable users to authenticate via Google accounts.
- Task Management: Provides endpoints to manage tasks, including creating, reading, updating, and deleting tasks.
- Test Driven Development (TDD): Ensures the codebase is thoroughly tested using Django tests and follows TDD principles.
- MySQL Database: Integrates with MySQL for data storage, ensuring robust and scalable data management.
For the frontend part of this project, the Next.js 14 application can be found in the following repository: Minimalist Todo App Next.js.
To run Todo-Rest-API locally or in your own server, follow these steps:
- Clone this repository:
git clone https://github.com/matiavallejosdev/todo-rest-api.git
- Install the required dependencies:
pip install -r requirements.txt
- Configure the MySQL database settings in
settings.py
. - Perform database migrations:
python manage.py migrate
- Start the development server:
python manage.py runserver
The API endpoints and their usage are documented using Swagger. Once the development server is running, you can access the API documentation by navigating to http:https://localhost:8000/swagger/
in your web browser.
- Visit the deployed app in your browser.
- Log in with Google via NextAuth.
- Manage your tasks efficiently.
To run the unit tests for the application, execute the following command:
python manage.py test
The Minimalist Todo App Next.js is an open-source project, and contributions are welcome. Feel free to fork the repository, make your changes, and submit a pull request.
If you have any questions or need further assistance, you can contact the project maintainer:
- Name: Matias Vallejos
- 🌐 matiasvallejos.com
Feel free to reach out if you have any inquiries or need any additional information about the project.
This project is open source and available under the MIT License.