This project uses composer. Just run :
Tuneefy needs a variety of tables to work properly; you can populate your database with the following :
mysql -u user -p database_name < ./structure.sql
To build the assets and the API documentation, I use npm and some modules.
npm install npm run build-assets npm run api-documentation
pumpfor building assets
I'm using JQuery to cover the DOM manipulation tasks and related stuff.
This project is a very basic composer project with a PSR-4 autoloader.
The source is in
src/tuneefy and is organised as such :
The tests are under the
./tests folder and I use Codeception to run them.
Just run :
vendor/bin/codecept run --steps
Beforehand, do not forget to launch a development web server so that the functional tests have an endpoint to test. For instance :
php -S localhost:8000 -t web php -S localhost:8001 -t web_api
There should be 36 tests containing 673 assertions.
Sometimes a platform fails to respond correctly due to network latencies or such. Re-run the tests in this case, it should pass fine the second time.
The API endpoints require an OAuth access token. The token is necessary to authenticate all requests to the API.
OAuth 2.0 is a simple and secure authentication mechanism. It allows applications to acquire an access token for tuneefy via a POST request to a token endpoint. Authentication with OAuth can be accomplished in the following steps:
You can get an API key and associated secret by sending an email to [email protected].
Limits are placed on the number of API requests you may make using your API key. Rate limits may vary by service, but the defaults are 100 requests per hour.
If you want to participate/contribute, feel free to create pull requests or issues so we can make Tuneefy better and more efficient !