NoteApp is a full-stack note-taking application built with Django for the backend, and vanilla HTML, JavaScript, and Tailwind CSS for the frontend. This project provides a user-friendly interface for user authentication, note creation, editing, and management.
- User authentication (signup and login)
- Create and edit notes
- View all user notes
- Markdown support for note content
- Responsive design using Tailwind CSS
To get started with NoteApp, follow these steps:
-
Clone the repository:
git clone https://github.com/your-username/noteapp.git
-
Navigate to the project directory:
cd noteapp -
Set up the backend:
cd backend python -m venv venv source venv/bin/activate # On Windows use `venv\Scripts\activate` pip install -r requirements.txt python manage.py migrate
-
Set up the frontend:
cd ../frontend npm install -
Create a
.envfile in the root directory and add the following environment variables:DJANGO_SECRET_KEY=your_secret_key_here DEBUG=True -
Start the Django development server:
cd ../backend python manage.py runserver -
In a new terminal, start the frontend development server:
cd ../frontend npm run start
The application should now be running. The backend will be available at http://localhost:8000, and the frontend will be served at http://localhost:3000.
-
Open your web browser and navigate to
http://localhost:3000. -
If you're a new user, click on the "Sign Up" button and create an account.
-
If you already have an account, click on the "Login" button and enter your credentials.
-
Once logged in, you'll be taken to your dashboard where you can view your existing notes or create new ones.
-
To create a new note, click on the "+ create" button and start writing. You can use Markdown syntax for formatting.
-
To edit an existing note, click on "edit" button in the navigation bar.
-
After editing the note, click "save" button to save the edited note.
-
To log out, click on the "Logout" button in the navigation bar.