abenetka / thirsty_plants

Mod 3 group project

README

Description

Thirsty Plants is an 11-day, five-person project during Mod 3 of 4, for Turing School's Backend Engineering Program.

Our challenge was to create a web application from idea to inception. Project requirements include: authentication with a third-party service, consuming an api, and solving a real-world problem.

Thus, Thirsty Plants was born. Thirsty Plants is a web application designed to assist users in keep tracking of watering their gardens, in accordance with the precipitation in their local area. The application utilizes the languages of Ruby, Javascript, HTML, CSS, Bootstrap, the web framework of Rails, and authentication via Google OAuth. The Dark Sky weather API is utilized to consume precipitation data.

View Thirsty Plants in Production

Getting Started

To run Thirsty Plants on your local machine, navigate to the directory in which you would like the project to be located, then execute the following commands:

$ git clone [email protected]:le3ah/thirsty_plants.git
$ cd thirsty_plants
$ bundle
$ rails g rspec:install
$ rails db:create
$ rails db:migrate
$ bundle exec figaro install

Setup your environment variables:

Sign Up on the following API's:

• Dark Sky
• Twillio
• Google
• Google Maps

Add the following code snippet to your config/application.yml file. Make sure to insert the key/secret without the alligator clips ( < > ).

GOOGLE_CLIENT_ID: <insert>
GOOGLE_SECRET: <insert>

darksky_api_secret: <insert>
google_maps_api_key: <insert>

TWILLIO_ACCOUNT_SID: <insert>
TWILLIO_AUTH_TOKEN: <insert>

ADMIN_PHONE_NUMBER: '<insert number associated with your Twillio account>'

Running Tests

To run the test suite, execute the following command: redis-server. While that server is running, open a new terminal tab, run rspec.

Deployment

To view Thirsty Plants in development, execute the following command from the project directory: rails s. In a browser, visit localhost:3000, to view the application.

To view the application in production, from the project directory, execute the following commands:

$ createuser -s -r thirsty_plants
$ RAILS_ENV=production rake db:{drop,create,migrate}
$ rake assets:precompile
$ rails s -e production

Tools

• Travis CI
• Figaro
• Faraday
• Shoulda-Matchers
• Factory Bot
• Google OAuth
• Bootstrap
• Dark Sky
• Waffle.io
• GitHub
• FactoryBot
• RSpec
• Capybara
• Pry
• Launchy
• SimpleCov
• PostgreSQL
• Chrome Dev Tools
• Twillio
• Sidekiq
• New Relic
• Paperclip
• ImageMagick

Rubric/Project Description

http://backend.turing.io/module3/projects/terrificus

Authors

• Mackenzie Frey
• Ali Benetka
• Leah K. Miller
• Ben Lee
• Anna Smolentzov

Teamwork Makes the Dream Work

Acknowledgments

• Sal Espinosa
• Mike Dao