NoteAppBackend is a backend project for a note-taking application built with Django. This project provides a set of APIs for user authentication, note management, and other functionalities related to note-taking.
To get started with NoteAppBackend, follow these steps:
-
Clone the repository:
git clone https://github.com/drowsyzen/markdown-Note-taking-App.git
-
Navigate to the project directory:
cd noteappbackend
-
Install the required dependencies:
pip install -r requirements.txt
-
Apply migrations:
python manage.py migrate
-
Start the development server:
python manage.py runserver
-
Token Obtain Pair
- URL:
/api/token/
- Method:
POST
- Description: Obtain a new JWT token pair (access and refresh tokens) by providing valid user credentials.
- URL:
-
Token Refresh
- URL:
/api/token/refresh/
- Method:
POST
- Description: Refresh the access token using a valid refresh token.
- URL:
- Register User
- URL:
/register/
- Method:
POST
- Description: Register a new user by providing necessary user details.
- URL:
-
Check Grammar of Note
- URL:
/checkgrammer/
- Method:
POST
- Description: Check the grammar of a provided note.
- URL:
-
Render Markdown to HTML
- URL:
/rendermdtohtml/
- Method:
POST
- Description: Render a provided Markdown note to HTML format.
- URL:
-
Create New Note
- URL:
/createnote/
- Method:
POST
- Description: Create a new note by providing the note details.
- URL:
-
Delete Current Note
- URL:
/deletenote/<int:id>/
- Method:
DELETE
- Description: Delete an existing note identified by its ID.
- URL:
-
Update Current Note
- URL:
/updatenote/<int:note_id>/
- Method:
POST
- Description: Update an existing note identified by its note ID.
- URL:
-
Get All User Notes
- URL:
/getallnotes/<int:user_id>/
- Method:
GET
- Description: Retrieve all notes belonging to a specific user identified by their user ID.
- URL: