readme.md

BoilerMake API

Info

This API has been used for BoilerMake IV, V, and VI, powering the frontend website as well as other ancillary services for internal use.

Server Requirements

• PHP >= 7.1.3
  • OpenSSL PHP Extension
  • PDO PHP Extension
  • Mbstring PHP Extension
  • Tokenizer PHP Extension
  • XML PHP Extension
  • Ctype PHP Extension
  • JSON PHP Extension
• Nginx
• Composer
• MySQL or PostgreSQL

Installation

• Clone the repository

• Run composer install

• Copy .env.example to .env and configure your database credentials

• Run php artisan migrate

• Run php artisan db:seed

• Generate a JWT secret: php artisan jwt:secret

• Generate an application key: php artisan key:generate

• If you're using Apache, read this: https://github.com/tymondesigns/jwt-auth/wiki/Authentication

Phases:

These refer to the 3 phases a system can be in

1. Interest signups
2. Applications are open
3. Decisions are out