Skip to content

Minenhle-Ngubane/notes-app

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

8 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

🗒️ Django Notes App (Demo Project)

Notes App Demo

A demo note-taking application built with Django, HTMX, and Bootstrap.
This project showcases full CRUD functionality, authentication, profile management, search, filtering, and server-driven interactivity.


🚀 Features

🔐 Authentication & Profiles

  • User registration, login, and logout
  • Profile update functionality

🗒️ Notes Management (CRUD)

  • Create, read, update, and delete notes
  • Responsive forms and layouts styled with Bootstrap

🔍 Search & Filtering

  • Live search using HTMX
  • Filter notes by favorites for quick access

❤️ Favorites

  • Mark notes as favorites
  • Filter favorite notes separately

⚡ HTMX Integration

  • Dynamic updates without full page reloads
  • Partial templates for smooth interactivity

🎨 Bootstrap Styling

  • Clean and responsive UI
  • Mobile-friendly layout

🛠️ Tech Stack

  • Django – Web framework
  • HTMX – Dynamic interactivity without heavy JS
  • Bootstrap – Responsive UI framework
  • SQLite (default)

📦 Installation & Setup

  1. Clone the repo

    git clone https://github.com/Minenhle-Ngubane/notes-app.git
    cd notes-app
    
  2. Create and activate a virtual environment

        # Activate virtual environment
        # On Linux/Mac:
        source venv/bin/activate
        # On Windows:
        venv\Scripts\activate
  3. Install dependencies pip install -r requirements.txt

  4. Apply migrations python manage.py migrate

  5. Create a superuser (admin) python manage.py createsuperuser

  6. Run the development server python manage.py runserver

  7. Access the app

About

A lightweight Notes web application built with Python 3, Django 5, and HTMX. It lets registered users create, read, update, and delete (CRUD) personal notes without page‑reloads, thanks to HTMX’s small‑footprint AJAX calls.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors