Skip to content

VarshiniShreeV/Notes_App

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

5 Commits
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

πŸ“ Notes App

A simple, secure web-based notes app built using Flask, MySQL, Flask-Login, and SQLAlchemy.


πŸ“ Project Structure

website/

β”œβ”€β”€ static/

β”‚ └── index.js # JavaScript (optional UI enhancements)

β”‚

β”œβ”€β”€ templates/

β”‚ β”œβ”€β”€ base.html # Common layout template

β”‚ β”œβ”€β”€ home.html # Notes dashboard

β”‚ β”œβ”€β”€ login.html # Login page

β”‚ └── signup.html # Signup page

β”‚

β”œβ”€β”€ init.py # App factory and configuration

β”œβ”€β”€ auth.py # Auth routes (login/register)

β”œβ”€β”€ views.py # Core app routes (home, notes)

β”œβ”€β”€ models.py # SQLAlchemy models

β”œβ”€β”€ requirements.txt # Python dependencies

└── README.md # You're here!


βš™οΈ Features

  • User registration & login with session management
  • Add and delete personal notes
  • MySQL database integration
  • Responsive templates with Flask and Jinja2

πŸ§ͺ Local Setup Instructions

1. Clone the Repository

git clone https://github.com/yourusername/flask-notes-app.git
cd flask-notes-app/website
  1. Set Up Virtual Environment
python -m venv venv
source venv/bin/activate        # Windows: venv\Scripts\activate
  1. Install Dependencies
pip install -r requirements.txt
  1. Set Up Your MySQL Database Start MySQL server

Create a database:

sql

CREATE DATABASE notes;

Make sure your credentials match your MySQL setup.

πŸš€ Running the App Locally From the website/ folder:

python -m flask run

Then, visit: http://127.0.0.1:5000/

On the first run, it will create all necessary database tables automatically.

πŸ“¦ requirements.txt (Sample)

Flask
Flask-Login
Flask-SQLAlchemy

Snippets: User Login 1 User Registration 2 Add Notes 4 Delete Notes 5

About

A simple Notes App built using flask framework.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published