/bn-api

The unified Big Neon API

Primary LanguageRustBSD 3-Clause "New" or "Revised" LicenseBSD-3-Clause

Big Neon API

Build Status Docker Repository on Quay

This is the Big Neon API repository, part of the Big Neon ticketing system.

Overall project architecture

Big Neon is a multi-tiered MVC Web API architecture for selling and managing tickets. The software system is made up of multiple components. To get an overall picture of how everything fits together have a look at the docs repository

Building this project from source

To download and build this project,

  1. Clone the source

     git clone https://github.com/big-neon/bn-api.git

  2. Compile

     cargo build

Configuring the local development environment

To simplify the management of your local environment, we've created the Big Neon repository that uses Docker to set up and configure your local development environment.

See the README for that repo for more details.

Setting up Facebook login

Facebook login is optional. If you would like to enable it, you will need to get an app id via the Facebook Developer page.

On the Facebook Developer page, you will also need to set the Valid OAuth Redirect URIs.