sommmtoooo / quik-note

a web application used to teach my student entity relationship ( flask & mysql )

Quik Note

Welcome to Quik Note! 📓

Quik Note is a minimal web application designed to demonstrate the practical application of one-to-one and one-to-many entity relationships to my relational database (MySQL) students. This was built to help those who are struggling to grasp these concepts, this project aims to make them more relatable and engaging. By showcasing a real-world use case, I hope to spark their interest and make database relationships more tangible and exciting.

Features

• CSRF Security 🛡️
• Flexible Configuration ⚙️
• Flask Blueprints 🗺️

Getting Started

To get started with this project, follow these steps:

1. Clone the repository:

   git clone [e-mail]:sommmtoooo/quik-note.git
   cd your-repo

2. Install dependencies:

   pip install -r requirements.txt

3. Set up your environment:

   Create a .env file or set environment variables as needed.

4. Run the application:

   python run.py

Contributing

Contributions are welcome! If you’d like to contribute, please fork the repository and create a pull request with your changes. Make sure to follow the coding standards and write clear commit messages.

License

This project is licensed under the MIT License. See the LICENSE file for details.