Converge Backend

converge-backend is the API and admin interface component of the Converge Proximity Social Network.

Status: Basic application structure created. In heavy development!

Environment

Converge uses Dotenv to load environmental variables from a file for Development and Test environments. To get started, copy .env.example file and adjust to your tastes.

$ cp .env.example .env

Note that there are a few environmental variables you must fill in yourself. Please peruse the file to ensure you've set what's needed!

Setup

1. Install all system dependencies (PostgreSQL, ElasticSearch) and ensure they're launched
2. Install Bundler and dependencies $ gem install bundler && bundle install
3. Create converge_dev and converge_test databases and users in PostgreSQL (using db:create or manually)
4. Run migrations $ bundle exec rake db:migrate
5. Start the server: $ bundle exec rails s

Future

• ???

Contributing

Please fork and submit a pull request if you'd like to contribute. It'd be super-keen if you followed this pull request authoring guide!