Developer Quickstart

The BoilerMake API has been written in a way that makes many assumptions regarding how your particular hackathon works. Luckily, this application is small and easy to build upon.

Before you start writing any code, we recommend reading through the Laravel 5.6 Documentation, as this API is built upon this framework.

---

Most of the pertinent code in this API is contained within the app/ folder. All the other folders are framework, configuration, test, or database related. Since this API has no views (UI), we don't have to worry about client assets. Let's dive in!

Http

This folder contains the "meat" of our API. The Kernel defines which middleware are active on a global level, and defines middleware that are available to be attached to specific routes. Because we use JWT as our authentication scheme, we define two route middlewares here. We also define a middleware for hackers. Remember that middleware adds information to an incoming request.

The Controllers/ folder contains all available API endpoints. The naming scheme should make it fairly obvious which files contain functionality that's relevant to whichever feature you're developing.