To run this Python and (especially) pip is required. They can be downloaded here or from your OS' package manager. Once installed run make env && make install. This will create a Virtual environtment under env folder and install all dependencies in that directory.
It is recommended to run this with debug=False which means you should start with make start. There is also make start-dev but, as name suggests, it's there for debugging/development purposes.
There is one SDK in PHP
All tests are stored in /test, they use PyRestTest library. So far, they are defined for the following endpoints:
-
/api/note- it has to be decided if there will be option to choose public or private note type, or which will be enforced globally -
/api/category- individual for each user, contains a collection of user notes -
/api/tag- tags assignable to notes, common throughout the whole api -
/api/login- auth endpoint, returns JWT tokens generated with help of PyJWT library
This is part of a suite of apps which I've written for Internet Programming course on my BSc Computer Science studies.