Directories

"app" holds all relevant Flask app files,

"static" inside of "app" holds the static pages for the frontend

"db" holds all database scripts

"api" holds all the API documentation

How to run

Sometimes Vue fails to mount, or fails to run JavaScript. If the app is not behaving correctly please refresh 1-2 times. I do not know what the problem is and works 99% of the time otherwise

# Start the app: ./run.sh
./run.sh

# Or alternativly, move to the app dir, as cert and key are relative
cd app/
./app.py

Info

When logging in, you are automatically registered to our service, and can begin creating presents

Searching

When searching, change to the browse tab and key in a name. To view how another user looks, search "ishoebot" or "bfanjoy" on the browse tab to view an example profile

Test Cases with CURL

# Log the user in
curl -i -k -H "Content-Type: application/json" -X POST -d '{"username": "name", "password": "pass"}' -c cookie-jar https://cs3103.cs.unb.ca:8034/auth/login

# Check for a login
curl -i -k -H "Content-Type: application/json" -X GET -b cookie-jar https://cs3103.cs.unb.ca:8034/auth/status

# Log the user out
curl -i -k -H "Content-Type: application/json" -X POST -b cookie-jar https://cs3103.cs.unb.ca:8034/auth/logout

# GET: Retrieve all presents from a specific username
curl -i -k -X GET https://cs3103.cs.unb.ca:8034/presents/ishoebot/

# POST: Create a new present
curl -i -k -X POST -H "Content-Type: application/json" -d '{"title": "Book", "link": "book.com"}' -b cookie-jar https://cs3103.cs.unb.ca:8034/presents/ishoebot/

# PUT: Update a specific present
curl -i -k -X PUT -H "Content-Type: application/json" -d '{"id": "42", "title": "Towels", "link": "towels.com"}' -b cookie-jar https://cs3103.cs.unb.ca:8034/presents/ishoebot/

# DELETE: Delete a specific present
curl -i -k -X DELETE -H "Content-Type: application/json" -d '{"id": "42"}' -b cookie-jar https://cs3103.cs.unb.ca:8034/presents/ishoebot/