-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
5d6fde1
commit a742c69
Showing
1 changed file
with
28 additions
and
23 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,25 +1,29 @@ | ||
| # Todo-Rest-API: Tasks Management REST API | ||
| # ✅ Minimalist Todo Django REST API | ||
|
|
||
| <!--  (Replace this link with a relevant banner image if available) --> | ||
| [](https://github.com/matiasvallejosdev/todo-rest-api-django/search?l=c%23) | ||
|  | ||
|  | ||
|  | ||
|  | ||
|
|
||
| ## Overview | ||
| 🚀 Experience Minimalist in action: [View Production](https://minimalist-tasks.vercel.app/) | ||
|
|
||
| Todo-Rest-API is a powerful Tasks Management REST API developed using Python and Django REST Framework. This project serves as the backend for a task management application and includes features such as social authentication using Google, unit testing with Test Driven Development (TDD) principles, and integration with MySQL database. The ultimate goal of this project is to imitate the functionality of "https://www.getminimalist.com/" while providing seamless integration with the frontend application developed in Next.js. | ||
| ## 📘 Introduction | ||
|
|
||
| <!--  --> | ||
| Welcome to the Minimalist Todo Django REST API repository, a backend solution designed for efficient task management. This project is built using Python and the Django REST Framework, catering to applications that require high-performance task handling capabilities. | ||
|
|
||
| ## Key Features | ||
| ## ✨ Key Features | ||
|
|
||
| - **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. | ||
|
|
||
| ## Frontend Repository | ||
| ## 🧑🏻💻 Frontend Repository | ||
|
|
||
| For the frontend part of this project, the Next.js 13 application can be found in the following repository: [Minimalist Todo App Next.js](https://github.com/matiasvallejosdev/minimalist-todo-app-nextjs). | ||
| For the frontend part of this project, the Next.js 14 application can be found in the following repository: [Minimalist Todo App Next.js](https://github.com/matiasvallejosdev/todo-rest-api-django). | ||
|
|
||
| ## Installation | ||
| ## 🛠 Installation | ||
|
|
||
| To run Todo-Rest-API locally or in your own server, follow these steps: | ||
|
|
||
|
|
@@ -29,37 +33,38 @@ To run Todo-Rest-API locally or in your own server, follow these steps: | |
| 4. Perform database migrations: `python manage.py migrate` | ||
| 5. Start the development server: `python manage.py runserver` | ||
|
|
||
| ## API Documentation | ||
| ## 📃 API Documentation | ||
|
|
||
| The API endpoints and their usage are documented using [Swagger](https://swagger.io/). Once the development server is running, you can access the API documentation by navigating to `http://localhost:8000/swagger/` in your web browser. | ||
|
|
||
| ## Running Tests | ||
| ## 💡 Usage | ||
|
|
||
| 1. Visit the deployed app in your browser. | ||
| 2. Log in with Google via NextAuth. | ||
| 3. Manage your tasks efficiently. | ||
|
|
||
|
|
||
| ## 🧪 Running Tests | ||
|
|
||
| To run the unit tests for the application, execute the following command: | ||
|
|
||
| ```bash | ||
| python manage.py test | ||
| ``` | ||
|
|
||
| ## 🤝 Contributing | ||
|
|
||
| ## Contributing | ||
|
|
||
| Contributions to Todo-Rest-API are welcome! If you find any bugs or have suggestions for new features, please feel free to open an issue or submit a pull request. For major changes, please open an issue first to discuss the proposed changes. | ||
|
|
||
| ## License | ||
|
|
||
| This project is licensed under the [MIT License](https://opensource.org/licenses/MIT). | ||
| 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. | ||
|
|
||
| ## Contact | ||
| ## 📞 Contact | ||
|
|
||
| If you have any questions or need further assistance, you can contact the project maintainer: | ||
|
|
||
| - Name: Matias Vallejos | ||
| - GitHub: [@matiavallejosdev](https://github.com/matiavallejosdev) | ||
| - Email: [email protected] (Replace this with your actual email address) | ||
| - 🌐 [matiasvallejos.com](https://matiasvallejos.com/) | ||
|
|
||
| Feel free to reach out if you have any inquiries or need any additional information about the project. | ||
|
|
||
| --- | ||
| ## 📄 License | ||
|
|
||
| Thank you for considering Todo-Rest-API for your tasks management needs. We hope this REST API serves as a solid foundation for your task management application. We look forward to your valuable contributions and feedback! | ||
| This project is open source and available under the [MIT License](LICENSE). | ||