awesome-todo

This is a task record system created by Coleen Calma, Von Divino, and Reamonn Lois Domingo as a final requirement for CMSC 127: File Processing and Database Systems.

Documentation

1. Postman
2. Live Demo

Setup database

1. Open your MariaDB interpreter.
2. Inside MariaDB, enter source ./sql/seed.sql to seed the database.

Setup environment

1. At the root of your project directory, create a file name .env. Copy paste the code below:

USERNAME=
PASSWORD=
DATABASE=awesome_todo
SERVER_PORT=8000
CLIENT_PORT=3000
SECRET_KEY=2zyalxwXbyaZVoXqoXGUKJXBVQANzBo3
PORT=3306

2. Make sure to enter your USERNAME and PASSWORD credentials for your database. For the SECRET_KEY, you can just leave it like that or enter your own key.

Setup server

1. Create a project environment by using this command python3 -m venv ./venv. This will create a new Python environment for you. You can skip this step if you want to directly run in your global Python environment.
2. Every now and then, when working in the project, activate the environment by typing ./venv/Scripts/activate. If you are in WSL/Linux, prepend the source command. If succesfully done, you should see a new prompt prepended with (venv).
3. Install the latest dependencies by typing the command pip install -r requirements.txt.
4. If you encountered error on Python Mariadb Connection, you may want to visit this page.
5. Run server using this command python .\server\index.py.

Setup client

1. Go to client using this command cd client.
2. Install dependencies npm install.
3. Start the client npm run dev.