-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
c69046f
commit 5c8b131
Showing
1 changed file
with
17 additions
and
9 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,6 +1,7 @@ | ||
# Taskky: A Task Management Web Application | ||
|
||
#### Video Demo: https://youtu.be/asmK4zMQ50g | ||
#### Live Website: ishant9805.pythonanywhere.com/ | ||
#### Description: | ||
Taskky is a web application designed for users to manage their daily tasks effectively. Built with Flask, this application allows users to register, login, add tasks, edit them, and mark them as completed. | ||
|
||
|
@@ -10,10 +11,14 @@ Taskky is a web application designed for users to manage their daily tasks effec | |
- **Profile Management**: Users can update their profiles, including email and other personal details. | ||
|
||
## File Structure: | ||
- `app.py`: The main file that runs the Flask application and handles routing. | ||
- `helpers.py`: Contains utility functions that assist with various tasks throughout the application. Copied from finance project of CS50 week 9. | ||
- `schema.sql`: SQL schema that defines the structure of the database used by the application. | ||
- `taskky.db`: SQLite database file where user and task data are stored. | ||
- `application`: This directory contains the taskky application. | ||
- `__init__.py`: Empty file to register application as module | ||
- `config.py`: Contains config for local development | ||
- `controllers.py`: Handles routing | ||
- `database.py`: Connects to database | ||
- `helpers.py`: Contains utility functions that assist with various tasks throughout the application. Copied from finance project of CS50 week 9. | ||
- `models.py`: Contains database models(Users, Tasks) | ||
- `db_directory/database.sqlite3`: This directory contains SQLite database file where user and task data are stored. | ||
- `static/`: Directory for static files. | ||
- `main.js`: JavaScript file that contains front-end logic for interactive elements. | ||
- `styles.css`: CSS file for custom styling beyond what's provided by Bootstrap. | ||
|
@@ -24,22 +29,25 @@ Taskky is a web application designed for users to manage their daily tasks effec | |
- `profile.html`: Template for displaying and updating user profiles. | ||
- `home.html`: Main dashboard template for displaying tasks. | ||
- `apology.html`: Template for displaying error messages. Copied from finance project of CS50 week 9. | ||
- `flask_session/`: Directory where Flask-Session stores session data. | ||
- `.gitignore`: To ignore unnecessary file for git tracking. | ||
- `main.py`: The main file that runs the Flask application and sets config. | ||
- `requirements.txt`: Python libraries that is required to run the app. | ||
- `schema.sql`: SQL schema that defines the structure of the database used by the application. | ||
|
||
## How to Run: | ||
1. Ensure Python is installed. | ||
2. Install required python libraries by using command `pip install -r requirements.txt`. | ||
3. Set up the database using the schema provided in `schema.sql`. | ||
4. Run the Flask application with `flask run` inside the project directory. | ||
3. Run the flask app with `python main.py` inside prject directory. | ||
|
||
## Design Choices: | ||
- **Flask**: Chosen for its simplicity and Pythonic conventions, making it ideal for small to medium web applications. | ||
- **Flask-SQLAlchemy**: Used it for connecting flask app with database. | ||
- **SQLite**: A lightweight database that doesn't require a separate server, perfect for development and smaller-scale applications. | ||
- **Bootstrap**: An awesome css library which was easy to use and design the website | ||
- **Bootstrap**: An awesome css library which was easy to use and design the website. | ||
|
||
## Conclusion: | ||
Taskky is a simplistic yet powerful tool for managing daily tasks, showcasing the power of Flask and SQLite for web application development. | ||
|
||
--- | ||
|
||
Taskky is developed by Ishant, Gopalganj, India. For any inquiries or contributions, please contact [email protected]. | ||
Taskky is developed by Ishant from India🇮🇳. For any inquiries or contributions, please contact [email protected]. |