Apiary is a tool for managing the membership and operations of RoboJackets, a student organization at Georgia Tech.
This project grew out of frustration with the limitations imposed by Georgia Tech's student organization management system, OrgSync. We found that while it may be an excellent tool for managing small groups, it does not scale very well. To that end, we've tried to design an application that can better support our student organization at its current size, and grow and develop along with our group.
This project has been tailored to support the specific workflow of RoboJackets and is not currently built in a manner that would be easily adaptable to another organization. The decision to limit the scope of this project was made in light of the extensive approvals process to access the amount of student data we currently store. We believe it is unlikely that another org will be able and willing to navigate that process.
- For development of Apiary, open a Github issue or ask in #apiary on Slack
- For production support of MyRoboJackets, ask in #it-helpdesk on Slack
- API documentation can be found here. Report any issues/inaccuracies through GitHub.
Getting Started with Local Development
Apiary is written entirely in languages that can be run from any operating system; however, support is only provided for Linux environments. All instructions below assume that the user is running on a modern, Debian-based Linux distribution.
For an easier setup, you may wish to use Laravel Homestead. Homestead is a pre-packaged Vagrant box maintained by the Laravel creators designed for Laravel development. It takes care of most of the server configuration so that you can get up and running quickly. If you opt to use Homestead, all steps listed below should be performed inside the Vagrant box, rather than on the host machine.
Laravel Mix is used to compile browser assets. Currently, we're concatenating and minifying all of our JS and CSS. This step is also where we compile our SCSS into CSS. In your local dev environment, you should run
webpack.mix.js to be compiled. See the relevant Laravel documentation for more details.
Most of the backend code lives under
app/Http, with templates under
resources/assets/js, but you're encouraged to browse through the project tree to get a better feel of where different components live. The
php artisan command can generate new classes for you in the correct locations automatically - run it with no parameters to see all the options.
This is a pretty conventional Laravel project, so we recommend following the official guide to get your workspace set up. At minimum, you will need PHP 7.1.3+,
npm, and a MySQL 5.7+ compatible database available on your machine.
If you're using Homestead, this section is taken care of for you out of the box.
You can install all of the required php extensions with:
$ sudo apt install php php-common php-cli php-mysql php-mbstring php-json php-opcache php-xml php-bcmath php-curl php-gd php-zip
Due to the nature of the data stored in certain tables in Apiary, some tables require encryption. This is implemented with MySQL's Keyring. For migrations to run successfully, you must also have a proper keyring set up in your development and production environments.
To enable the Keyring functionality, edit your
my.cnf as follows, then restart MySQL:
To check if the Keyring plugin was enabled successfully, run the following command from a MySQL command line.
mysql> SELECT PLUGIN_NAME, PLUGIN_STATUS FROM INFORMATION_SCHEMA.PLUGINS WHERE PLUGIN_NAME LIKE 'keyring%'; +--------------+---------------+ | PLUGIN_NAME | PLUGIN_STATUS | +--------------+---------------+ | keyring_file | ACTIVE | +--------------+---------------+
Further documentation about MySQL Keyring can be found in the MySQL documentation.
Apiary uses Redis for queueing jobs, with Laravel Horizon used to manage them. You should be able to just install Redis and the corresponding PHP extension. Once you get Apiary configured below, you can run
php artisan horizon to process jobs.
Clone the repository onto your local machine:
$ git clone https://github.com/RoboJackets/apiary.git
If you a member of RoboJackets, reach out in #apiary on Slack and ask for a copy of a mostly configured
Copy the example environment file to configure Apiary for local development:
$ cp .env.example .env
For a basic development environment, you'll need to modify the following settings:
|APP_URL||Set to the hostname of your local dev environment, ex.
|DB_*||Set appropriately for your database.|
|MAIL_*||Mailgun is the suggested mail driver, but you can easily configure Mailtrap or a local mail server referencing the Laravel documentation.|
|CAS_HOSTNAME||FQDN of the CAS server to use, ex. login.gatech.edu|
|CAS_REAL_HOSTS||Should match CAS_HOSTNAME|
|CAS_LOGOUT_URL||CAS logout URL, ex. https://login.gatech.edu/cas/logout|
|CAS_MASQUERADE||If set, bypasses the CAS authentication flow and authenticates as the specified username.|
|CAS_MASQUERADE_gtGTID||GTID number for the masquerading user (90xxxxxxx)|
|CAS_MASQUERADE_email_primary||Primary email address for the masquerading user|
|CAS_MASQUERADE_givenName||Given Name (First Name) for the masquerading user|
|CAS_MASQUERADE_sn||SN (Second/Last Name) for the masquerading user|
$ composer install && npm install
Please note that we are using Laravel Nova for some admin pages. You will be prompted for credentials when running Composer if an update to Nova is required. Get in touch with us in #apiary when this happens.
You will need to run these commands again in the future if there are any changes to required packages.
Before Your First Run
Generate an application key (run this only once for initial setup.)
$ php artisan key:generate
Run database migrations to set up tables (run this for initial setup and when any new migrations are added later.)
$ php artisan migrate
Seed the database tables with base content (run this only once for initial setup.)
$ php artisan db:seed
Generate static assets (run this every time Vue or JS files are edited.)
$ npm run dev
Starting the Local Development Server
You can use
php's built in development web server to easily test your application without needing to configure a production-ready web server, such as
apache. To start this server:
$ php artisan serve
This is not necessary if you are using Homestead - you should use the configured hostname from
Homestead.yaml instead, ex.
Tips for Development
npm run watch
Automatically rebuilds your front-end assets whenever the files change on disk. It's the same as running
npm run dev. Some platforms will need
npm run watch-poll to see changes to files, rather than just
php artisan tinker
Tinker allows you to interact with Apiary on the command line including the Eloquent ORM, jobs, events, and more. A good introduction to Tinker can be found here.
Moving to Production
There are a few additional changes needed to
.env when moving to production.
|APP_NAME||MyRoboJackets (or other as you see fit)|
|APP_LOG_LEVEL||info (or other as you see fit)|
|APP_URL||DNS hostname for production environment|
|GA_UA||Google Analytics identifier, if desired|
|SQUARE_*||Square API credentials (Get these from the Square Developer Dashboard)|
Review the Laravel documentation on deploying Horizon to a production environment.
Also be sure to set up a cron job to run scheduled tasks - Horizon uses this to keep track of statistics.
Any security issues with the Apiary code or any RoboJackets-managed Apiary deployment (*.robojackets.org) should be reported to email@example.com. This will notify our development and operations teams and you should receive a response within 8 business hours Eastern Time.