Welcome to the notes_api_jwt project! This application provides a secure way to manage your notes through an easy-to-use API. You can add, edit, delete, and view notes while keeping your data safe with JWT authentication.
On the Releases page, you will find different versions of the software. Select the version you want to use. Download and run the application following the instructions below.
Before you download, make sure your system meets these requirements:
- Operating System: Windows, macOS, or Linux
- Python Version: Python 3.6 or higher installed
- Django Version: Django 3.1 or higher installed
- Additional Dependencies: Use the provided
requirements.txtfile to install necessary libraries.
-
Download the software from the Releases page.
-
Extract the downloaded files to a folder of your choice.
-
Open your terminal or command prompt.
-
Navigate to the folder where you extracted the files.
-
Run the following command to install required dependencies:
pip install -r requirements.txt
-
Start the server using:
python manage.py runserver
-
Open your web browser and go to
http://127.0.0.1:8000/to access the application.
To use the API, you first need to authenticate. Here’s how:
- Create a user account by sending a POST request to
/api/register/. - Log in by sending a POST request to
/api/login/with your credentials. - Upon successful login, you will receive a JWT token. Use this token for subsequent requests.
You can perform Create, Read, Update, and Delete operations on notes through the API:
- Create a Note: Send a POST request to
/api/notes/with the note details. - Get Notes: Send a GET request to
/api/notes/to retrieve all notes. - Update a Note: Send a PUT request to
/api/notes/{id}/with the updated note details. - Delete a Note: Send a DELETE request to
/api/notes/{id}/to remove a note.
For complete API documentation, please refer to the documentation within the project files.
- Secure Authentication: Your data is safe with JWT authentication.
- Custom User Management: Manage your users with custom permissions.
- Note Management: Easily create, read, update, and delete notes.
- Throttling: Prevent abuse with built-in throttling features.
- Django REST Framework: Built using Django REST Framework for a scalable and efficient API.
If you encounter issues during installation or while running the application, consider these steps:
- Ensure all dependencies are correctly installed.
- Check that your Python version meets the requirements.
- Look for error messages in the terminal or command prompt.
You can also reach out through the Issues section of this repository for help from the community.
api, custom-user, django, django-rest-framework, drf, jwt-authentication, notes-api, permissions, python, rest, throttling
Do not forget to check the Releases page to download the latest version of notes_api_jwt.