Birthdays Manager

About the project

Birthday Manager is a simple web application built with Flask that allows users to add and manage birthday entries in a database. Users can add names along with their corresponding birth months and days, and view all stored entries.

Table of Contents

• Birthday Manager
  • About the project
  • Table of Contents
    • Directory directory structure
  • Features
  • Getting started
    • Prerequisites
    • Read the docs
    • Run the app
    • Run the application in a Docker container:
    • Update the instance\birthdays_db.db file because of db model changes
  • Resources used to create this project
  • License
  • COPYRIGHT
  • Code of Conduct

Directory directory structure

.
├── CODE_OF_CONDUCT.md - project code of conduct
├── COPYRIGHT - project copyright
├── docs/ - documentation sources
├── instance/ - database
├── migrations/ - generated migrations scripts byFlask-Migrate. Files in there should be deleted when database has to be generated from scratch.
├── static/ - contains static files (css, js)
├── templates/ - contains html templates
├── tests/ - all kinds of test scripts
├── app.py - flask application and program entry
├── LICENSE - license file
├── README.md - project descriptions and instructions
└── requirements.txt - project requirements

Features

• Add and delete new birthday entries.
• View all stored birthday entries.
• Simple and intuitive user interface.

Getting started

Prerequisites

0. Clone the repository:

git clone https://github.com/CH6832/birthdays-management.git

1. Extract the repository:

tar -xf birthdays-management.zip

2. Navigate into root directory:

cd birthdays-management

3. Install requirements:

pip3 install -r requirements.txt

Read the docs

• HTML
• PDF

Run the application in a Docker container:

0. Build the docker image

docker build -t flask-app .

1. Run the docker container:

docker run -d -p 5000:5000 flask-app

2. FLask application is now running in a docker container reachable in your webbrowser:

http://localhost:5000

Update the instance\birthdays_db.db file because of db model changes

0. Make changes to 'UserModel' class in app.py

1. Generate migration scripts in migrations folder:

flask db migrate -m "describe your changes"

2. Apply the migrations:

flask db upgrade

Resources used to create this project

• Python
  • Python 3.12 documentation
  • Built-in Functions
  • Python Module Index
  • PEP 8 – Style Guide for Python Code
• Flask
  • Flask
• HTML
  • HTML: HyperText Markup Language
• CSS
  • CSS: Cascading Style Sheets - MDN Web Docs
• Docker
  • Docker Docs
• Markdwon
  • Basic syntax
  • Complete list of github markdown emofis
  • Awesome template
  • .gitignore file
• Editor
  • Visual Studio Code

🔖 License

This project is licensed under the terms of the MIT License.

©️ Copyright

See the COPYRIGHT file for copyright and licensing details.

📏 Code of Conduct

Please review our Code of Conduct before contributing to this project.