api

This API is designed for managing dance events, specifically for tango groups.

Requirements

• PostgreSQL
  • For Mac users, I'd recommend the wonderful Postgres.app
  • For Windows users, take a look at the downloads page (sorry, I'm not too well versed in this)

Getting Started

💎 Ensure you have a modern version of ruby installed on your system. ruby-lang.org has good documentation on how to do this.

📦 Install dependencies by running bundle inside the folder of the project.

📖 Setup the database by running bin/rails db:create, and bin/rails db:migrate

💃 Start up the application by running bin/rails s

Where is this hosted?

This is hosted on AWS, using Elastic Beanstalk. AWS is a bit involved. For a quick rundown of what you need to know to administer this, see below.

Deploying

🌱 To deploy the api, you'll need to install the AWS elastic beanstalk command line tool.

On mac, this is fairly straightfoward with the command:

brew install awsebcli

Next thing is to get permission to deploy. Get in touch with one of the administrators and ask to get a user account on AWS. This will give you an access ID and a secret key which you'll use to login.

To start connecting to the app, run eb init. This will take you through a series of steps that will end up setting up your connection to the api. Once done, you should be able to deploy using eb deploy.