Usage¶

step-by-step guide¶

If you have performed the previous steps without problems you are ready to use my project. Then clone the repository to your computer using the following command:

git clone https://github.com/AntonioBerna/todo-app.git

For personal security reasons, it is good practice to save your access credentials in the system's environment variables. Then using the touch command we create a setenv.sh file which must contain the following code:

1
2
3
4
5
6
7

#!/bin/bash

export DB_NAME=todolist
export USERNAME= # please complete this
export PASSWORD= # please complete this
export PORT= # please complete this
echo "Set environment variables for DB_NAME, USERNAME, PASSWORD, and PORT."

in particular the PASSWORD should be the login password of your computer, while to find out which connection PORT is you can use the following command:

SELECT setting FROM pg_settings WHERE name = 'port';

Finally, the USERNAME represent the owner of the database, which is usually postgres if you have not changed it during the installation of PostgreSQL.

once the setenv.sh file is completed you can use the following commands:

chmod +x setenv.sh
source setenv.sh

to apply those environment variables to the shell currently in use.

Once you have set the environment variables you will need to compile the program. Then you can use the following command:

make

To test the program we can use the following command:

./build/todo

so as to obtain:

Usage: ./build/todo [add|rm|edit|ls] [description|id]

To remove the program from your computer you can use the following command:

make clean

Add tasks¶

Input:

./build/todo add homework "go to the toilet"

Output:

Adding of item "homework" successful
Adding of item "go to the toilet" successful

Print tasks¶

Input:

./build/todo ls

Output:

Todo list:
(1) homework
(2) go to the toilet

Delete tasks¶

Input:

./build/todo rm 1 2

Output:

Deletion of item 1 successful
Deletion of item 2 successful

Edit tasks¶

Input:

./build/todo edit 1 "go to the bathroom"

Output:

Update of item 1 successful