hackAIR REST API based on Lumen v5.3

Deprecation notice

This is an old version of the hackAIR web application, and is not actively supported.

Description

Backend RESTful API based on Lumen v5.3 used for exchanging information with the hackAIR web app and the hackAIR mobile app.

Key libraries used:

• Dingo API package for Lumen (Dingo API)
• Laravel MongoDB package to provide support for MongoDB Laravel MongoDB
• JSON Web Token Authentication package for Lumen JWT Auth
• Mandrill's API for transactional email as a service (Mandrill API)
• Sentry's integration with Laravel for exception and error alerts (Laravel Sentry)
• Guzzle PHP HTTP client used for external API calls (Guzzle)

Requirements

• PHP >= 5.6.4
• OpenSSL PHP Extension
• PDO PHP Extension
• Mbstring PHP Extension

Installation instructions

• Clone project
• Install dependencies

composer install

• Update class autoloader

composer dump-autoload

• Setup permissions

chmod -R 775 /var/www/html/storage
chmod -R 775 /var/www/html/public

• Copy .env.example to .env and setup configurations
• Generate and add APP_KEY to .env file e.g. APP_KEY=lk7IqejFTEqaIep8guBE16Mg5JWpZtHj
• Run migrations & seeds

php artisan migrate --seed

Documentation

Please refer to our online documentation for more information.

• API Documentation

License

The hackAIR API is open-sourced software licensed under the GNU AGPLv3 license