joycodes / timesy

This is a Flask Application web app that allows students to organize their day and send reminders to themselves and their team members for group projects when a task is due.

Timesy

This is a Flask application that acts as a to-do app where a user can create and share their tasks and receive reminders when tasks are due.

Project Run-Through

• A few details about this project:

Contribution

• Kelvin Mburu 📖
• Faith Mwangi 📖
• Joyce Nguttu 📖
• Salma Ntidendereza 📖

Technology Used

1. Python3
2. Flask version 2
3. HTML, CSS and JavaScript
4. Flask Login, email validator, and password validator
5. C
6. Shell

Project Requirements & Prerequisites

1. IDE of Choice
2. Python3
3. Browser

• Please ensure you're working from a Windows/MacOS/Linux
• Install Flask through pip install flask

Project Setup and Installation

1. Proceed to this link and clone the repository.
2. Extract the folder and cd to the folder on your terminal or your prefered IDE
3. In the terminal, create a virtual/flask environment: python3 -m venv virtual and activate it through source virtual/bin/activate. In the case of flask, please use source flask/bin/activate or refer to this documentation for Flask virtual environment installation.
4. Alternatively, you can install your virtual environment through pipenv
5. Install all dependencies from the requirements.txt file; use pip or pipenv to install needed dependencies.
6. In the project folder, create a start.sh file which acts as a server at runtime.
7. In the terminal, and within the project folder, run chmod +x start.sh and ./start.sh to start the project.
8. View the application on your browser on http://127.0.0.1:5000. If you have another project running on another port, use flask run --host 0.0.0.0 --port 5001 to switch to a new port; You can use a different port number.

Behavior Driven Development (BDD)

The BDD focuses on how a user interacts with the application.

At a minimum, this is what the user should experience in the application:

Project Contribution or Development:

To contribute to this project, please follow the following steps:

• Fork this repository.
• Create a branch: git checkout -b <branch_name>.
• Make your changes and commit them: git commit -m '<commit_message>'
• Push to the original branch: git push origin <flask-news>/<main>
• Create the pull request.
• Once a PR is reviewed, the changes will be pushed to the main branch for integration.

Please see the GitHub documentation on Creating a Pull Request

Known Issues & bugs

To improve this project or fix a bug, please reach the following people via Email:

• [e-mail]
• [e-mail]
• [e-mail]
• [e-mail]

Alternatively, you can contact me via LinkedIn

License

Please view the project LICENSE for more information.