shubhankar5 / notes-api

An API that lets you add text notes and perform all CRUD operations on them.

notes-api

What is it?

An API that lets you add text notes and perform all CRUD operations on them.

Key features

• Access to APIs restricted with proper permissions
• Throttling added to limit the number of times the API is accessed
• Pagination added for lists
• Filtering added with django-filters
• Ordering and searching
• Inheritable code with CBVs

Tools used

Requirements have been added in requirements.txt. The main components are:

• Django Link
• Django REST Framework Link
• django-filters Link

How to use?

1. Install pip from this link
2. Install virtualenv from this link
3. Create a virtualenv and activate it. Refer here
4. Create a directory called notes_app
5. Download all the files in the repository under this directory
6. Change the directory to notes_app
7. Run pip install -r requirements.txt
8. Run python manage.py createsuperuser and create a superuser
9. Run python manage.py makemigrations
10. Run python manage.py migrate
11. Run python manage.py runserver

How to contribute?

Feel free to contribute to this repository and make this a better project. Thank you!