Foursball REST API

Rest API for Foursball

Running

Clone and run with the following commands:

npm install -g sails
git clone https://github.com/Foursball/foursball-api.git
cd foursball-api
npm install
sails lift

Then navigate to http://127.0.0.1:1337. NOTE: Please read the OAuth section below to configure the authentication providers.

OAuth

This app uses OAuth for authentication. Any combination of GitHub, Google, and Twitter can be used, but the OAuth application properties must be passed in. Create a Google app, GitHub app, and/or Twitter app. Make sure to use the full URL you will use to run this app during configuration.

Once the apps have been created you need to pass in the Client ID and Client Secret variables as the following environment variables:

• GitHub - GITHUB_ID, GITHUB_SECRET
• Google - GOOGLE_ID, GOOGLE_SECRET
• Twitter - TWITTER_KEY, TWITTER_SECRET

Finally, pass in the SERVER_URL variable as the full URL of your application.

Local Dev

For easier local dev you can copy /config/oauth.js to /config/local.js (which is under .gitignore) and replace the OAuth variables with you application credentials. This removes the need to run the app with the OAuth environment variables every time.

You can also run the app with automatic restart on code change

npm run dev

Running in Docker

Docker is the easiest way to run the Foursball REST API. Run with docker run -d -p 80:80 foursball/foursball-api. The OAuth environment variables are ommited from the docker run command, so add them in once you have followed the above instructions (e.g. docker run -d -e GITHUB_ID=[my-id] -e GITHUB_SECRET=[my-secret] -e SERVER_URL=http://127.0.0.1 -p 80:80 foursball-api).

UI Proxy

This API can be run with the Foursball UI by proxying all non-API calls to the UI. Use the following environment variables to configure the proxy:

• PROXY_ENABLED (default: false) - Toggle for the proxy
• PROXY_URL (default: http://localhost:4200) - URL to proxy non-API requests to

Restoring data from Firebase

With the proper zip file unpacked, this API can restore data from Firebase. Download the zip file from the #ops backups in Slack and unzip it in a top-level folder called restore.

-foursball-api
 |_restore
    |_foosballers.json
    |_games.json
    |_leagues.json
    |_rules.json
    |_tables.json
    |_teams.json
    |_tenants.json

Enable the following environment variable:

• DATA_RESTORE=true

Full command used for local dev restoring data from Firebase: rm .tmp/localDiskDb.db && PROXY_ENABLED=true DATA_RESTORE=true npm run dev

Running with MySQL

The default database is on disk, so it is recommended to run the Foursball REST API with a MySQL DB in production. Use the following environment variables:

• MYSQL_HOST (MySQL will be used as the datastore if this is supplied)
• MYSQL_USER (default: sails)
• MYSQL_PASSWORD (default: sails)
• MYSQL_DB (default: sails)

The easiest way to run a MySQL instance is to run it in Docker using the following command:

docker run -d -p 3306:3306 -e MYSQL_DATABASE=sails -e MYSQL_USER=sails -e MYSQL_PASSWORD=sails -e MYSQL_RANDOM_ROOT_PASSWORD=true mysql