Notine is a note-taking application built with DRF.
- CRUD operations for managing notes.
- Token-based authentication for secure access.
- Customizable permissions for different user roles.
- Django
- Django REST Framework
- Postgres (or your preferred database)
- Other dependencies specified in
requirements.txt
-
Clone this repository to your local machine.
-
Navigate to the project directory.
-
Create a virtual environment (optional but recommended):
python -m venv venv
-
Activate the virtual environment:
- On Windows:
venv\Scripts\activate
- On macOS and Linux:
source venv/bin/activate
-
Install dependencies:
pip install -r requirements.txt
-
Apply migrations:
python manage.py migrate
-
Create a superuser (for admin access):
python manage.py createsuperuser
-
Run the development server:
python manage.py runserver
-
Access the API at
http://localhost:8000/
.
/notes/
: List and create notes./notes/<id>/
: Retrieve, update, or delete a specific note./auth/
: Authentication endpoints for Djoser./admin/
: Django admin panel./swagger/
: Swagger documentation./redoc/
: ReDoc documentation./__debug__/
: Django Debug Toolbar (in development mode)./category/
: Endpoints for managing categories./note/colors/
: Endpoint for listing available note colors.
- Token-based authentication is used for accessing protected endpoints.
- Obtain a token by sending a POST request to
/auth/jwt/create/
with valid credentials.
- Use tools like Postman or curl to interact with the API endpoints.
- Authenticate using the obtained token for accessing protected endpoints.
Contributions are welcome! If you'd like to contribute to this project, please follow these steps:
- Fork the repository.
- Create a new branch (
git checkout -b feature/my-feature
). - Make your changes.
- Commit your changes (
git commit -am 'Add new feature'
). - Push to the branch (
git push origin feature/my-feature
). - Create a new Pull Request.
This project is licensed under the MIT License.
If you have any questions or suggestions, feel free to contact me at [email protected].