Git Product home page Git Product logo

markdown-note-taking-app's Introduction

NoteAppBackend

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.

Table of Contents

Installation

To get started with NoteAppBackend, follow these steps:

  1. Clone the repository:

    git clone https://github.com/drowsyzen/markdown-Note-taking-App.git
  2. Navigate to the project directory:

    cd noteappbackend
  3. Install the required dependencies:

    pip install -r requirements.txt
  4. Apply migrations:

    python manage.py migrate
  5. Start the development server:

    python manage.py runserver

API Endpoints

Authentication

  • Token Obtain Pair

    • URL: /api/token/
    • Method: POST
    • Description: Obtain a new JWT token pair (access and refresh tokens) by providing valid user credentials.
  • Token Refresh

    • URL: /api/token/refresh/
    • Method: POST
    • Description: Refresh the access token using a valid refresh token.

User Registration

  • Register User
    • URL: /register/
    • Method: POST
    • Description: Register a new user by providing necessary user details.

Note Management

  • Check Grammar of Note

    • URL: /checkgrammer/
    • Method: POST
    • Description: Check the grammar of a provided note.
  • Render Markdown to HTML

    • URL: /rendermdtohtml/
    • Method: POST
    • Description: Render a provided Markdown note to HTML format.
  • Create New Note

    • URL: /createnote/
    • Method: POST
    • Description: Create a new note by providing the note details.
  • Delete Current Note

    • URL: /deletenote/<int:id>/
    • Method: DELETE
    • Description: Delete an existing note identified by its ID.
  • Update Current Note

    • URL: /updatenote/<int:note_id>/
    • Method: POST
    • Description: Update an existing note identified by its note ID.
  • 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.
version 1(end date) - 3 july 2024

markdown-note-taking-app's People

Contributors

drowsyzen avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.