Creatr API

This is the API for Creatr.

Creatr

“Creatr” is a project of the University Christian Group Student Life that allows a movement of people whether a church, youth group or mission organization to organize & monitor digital outreaches so they can focus on connecting with people.

Don’t hesitate to contact us if you any questions or comments.

How does Creatr work?

1. An individual creates a movement that represents a real world group.
2. He/She generates his/her campaigns, inputting questions etc.
3. He/She invites others to participate in that campaign.
4. He/She follows up the participants using a CRM

http://api.creatr.io/

Setting Up Creatr API

Setup configuration files

Make any necessary edits to these if the defaults don’t work for you.

Database
bc. cp config/database.example.yml config/database.yml

Environment Variables
bc. cp .env.example .env

Run basic setup tasks

rake db:create:all
rake db:migrate
rake db:populate
bundle install

Start your local server

foreman start

Start your continuous testing environment

bundle exec guard

Creatr API should now be running on your computer at the URL http://localhost:5000

Creatr API Documentation

On your local server you can find the documentation hosted at the URL http://localhost:5000/api/docs