Skip to content

ssimonlp/Beerly

Repository files navigation

Beerly

Beerly logo

Beerly is an application that helps you find bars in Paris according to the brand or type of beer you want to drink.
For example if you are looking for a bar that serves Guiness just look it up on beerly and it will show you a map displaying all the bars around you serving Guiness.

🔧 Installation guide

$ git clone https://github.com/ssimonlp/Beerly.git
$ cd Beerly
$ bundle install
$ rails db:create db:migrate db:seed

Credentials setup

Our credentials.yml has the following layout :

google_maps: <key>

mailjet:
  public_key: <key>
  secret_key: <key>
  
brewery_db: <key>

omniauth:
  google:
    client: <key>
    secret:<key>
  facebook:
    app_id: <key>
    secret: <key>

Tests

You can run the tests on the test environement :

$ rake db:seed RAILS_ENV=test
$ rspec

(@AJuliette : Next time I'll seed using FactoryBot ! ;)

💎 Gems used

Devise / Manage user logins/sessions.
Geocoder / Geolocation util. Used to Geocode bar addresses.
Mailjet / Used to deliver emails.
Omniauth / Allow users to login through other services.
-- Omniauth-facebook / Login via Facebook.
-- Omniauth-google-oauth2 / Login via Google.
Pg_search / Full text search.
Httparty / HTTP request util, used to scrap data from APIs.
jQuery-rails / Javascript libary, speed up dev time.
CSV / CSV parser, used to seed our DB from CSV.
Pry-rails / Debugging tool, used to... well, debug.
Rspec-rails / Testing framework, used to test our crappy associations ^^'

Mailcatcher / Send emails to a local smtp server in dev | Setup : gem install mailcatcher > mailcatcher > Go to 127.0.0.1:1080

🎬 Where can I find the live website ?

The live website lives here : On Heroku

🐙 Who made this ?

Front-end

🎉 Mathieu Maillet, the "I did it all by myself" boy (@mathieumllt)
⌛ Louis Martin du Nord, the bar seeking dude (@louismn)

Back-end

🐱 juliette Audema, the Trello addict (@AJuliette)
🍺 Simon Le Pavec, the autocompletionist (@ssimonlp)
👾 Lucien Passera, the extreme debugger (@Crysicia)

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 3

  •  
  •  
  •