API created to manage notes
python3 -m venv .venv
source .venv/bin/activate
pip3 install -r requirements.txt
Server that serve the API
To create the SQLite database execute
cd utilities
python3 create-database.py
To start the back-end server run
python3 server/manage.py start-server
Runs by default at http://localhost:8000
Other execution parameters can be passed. To see the help run:
python3 server/manage.py start-server -h
It will show:
Usage: manage.py start-server [OPTIONS]
Options:
-ip, --ip TEXT Set application server ip
-p, --port INTEGER Set application server port
-d, --debug INTEGER Set application server debug. 0 -> False. 1 -> True
-h, --help Show this message and exit.
The parameters can also be set in an .env file that is lifted from the root of the project. Check .env.sample file for watch the possible variables.
| End-point | Method | Response | Requirements |
|---|---|---|---|
| /users/signup/ | POST | JSON with errors or success message | Needs the header Content-Type application/json |
| /users/login/ | GET | JSON with the user token | Needs the header Authorization Basic with username and password |
| /notes/ | POST | JSON with the created note | Needs the headers Content-Type application/json and Authorization with the user token (Syntax: Token <user token>) |
| /notes/ | GET | JSON with the list of user's notes. Empty if the user has not created any | Needs the header Authorization with the user token (Syntax: Token <user token>) |
Basic front To start it run
cd client
python3 client.py
Runs at http://localhost:5000