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