Django Note Management App

Overview

This Django application is designed to manage notes with user authentication and CRUD (Create, Read, Update, Delete) functionalities. It uses PostgreSQL as the database and is containerized with Docker for both the backend and the database.

Getting Started

Prerequisites

• Docker: Ensure Docker is installed on your machine.
• Docker Compose: Make sure Docker Compose is installed.

Setup

1. Clone the Repository

   git clone [email protected]:nimaqalizadeh/manage-notes.git
   cd manage-notes

2. Build and Start Containers

   docker compose up --build

3. Database Migrations

The migrations are handeled in Dockerfile file.

Application Usage

1. User Registration and Authentication

• Register: /accounts/register
• Login: /accounts/login
• Logout: /accounts/logout

Register a new user, log in, and log out to manage your note records.

2. Note Management

After logging in, you can manage your notes through the following URL:

• View and Add Notes: /notes/

Use the form to add new notes. This operation is handled via AJAX.

3. API Endpoints

The application provides a RESTful API for managing notes (Only authenticated users can access this endpoint):

• List and Create Notes: GET /notes/api/v1/list and POST /notes/api/v1/list

• Read, Update, and Delete Notes: GET /notes/api/v1/detail/<id>/, PUT /notes/api/v1/detail/<id>/, DELETE /notes/api/v1/detail/<id>/

License

This project is licensed under the MIT License.

Feel free to submit issues and pull requests to contribute to this project.