Freepee documentation

Live link: freepee.

Freepee makes it easy to find a loo near you.

Tech stack:

• Ruby on Rails;
• MVC infrastructure;
• 3 models: User, Loos, and ratings;
• Google map api for directions.

Freepee uses these gems:

• Devise: handles user authentication
• Cancancan: formerly cancan, handles authroization per session instance
• Figaro: keeps API information secure for pushing code to Github
• Pry: For development
• Bootstrap: includes Twitter bootstrap in our project
• Foursquare2: the Foursquare API for finding venues with lat/long input
• Mailform: sends email straight from a form.

Getting started

If you would like to create a local version of Freepee:

git clone https://github.com/mklemme/freepee.git

Since we are using API keys, you will need to add your own using the gem, Figaro.

Add Figaro to your gemfile

gem 'figaro'

Run the bundle command to install it.

Next, you need to run the Figaro generator:

figaro install

Add API keys to the file Figaro generated in config/application.yml. This app expects these API values defined:

mandrill_username: mandrill_login
mandrill_api: api-key_abcdef123456

Create local instance of the database:

rake db:create && rake db:migrate

Contributors

We have a long list of valued contributors. Check them all at:

https://github.com/mklemme/freepee/graphs/contributors

Bug reports

If you discover a problem with Freepee, we would like to know about it. However, we ask that you please review these guidelines before submitting a bug report:

https://github.com/mklemme/freepee/wiki/?Bug-reports

License

insert license info