Table of Contents

1. Introduction
2. Features
3. Technical Requirements
4. Setup
5. Usage
6. Contributing
7. License

Introduction

NotesApp is a full-stack note-taking application built using Django, React, and PostgreSQL. It allows users to create, update, and delete notes.

Features

• Create notes with title and content
• Update existing notes
• Delete notes
• View all notes

Technical Requirements

• Django 4.1.7
• React 18.2.0
• PostgreSQL 14.5
• Node.js 16.17.0

Setup

Backend

1. Clone the repository: git clone https://github.com/your-username/notes-app.git
2. Navigate to the backend directory: cd notes-app/backend
3. Install dependencies: pip install -r requirements.txt
4. Apply database migrations: python manage.py migrate
5. Run the backend server: python manage.py runserver

Frontend

1. Navigate to the frontend directory: cd notes-app/frontend
2. Install dependencies: npm install
3. Start the frontend server: npm start

Usage

1. Open a web browser and navigate to http://localhost:3000
2. Click on the "Plus" button to create a new note
3. Fill in the title and content fields and click "Save"
4. To update a note, click on the Note and make changes
5. To delete a note, click on the "Delete" button

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

License

MIT