le3ah / thirsty_plants Goto Github PK

Mod 3 group project

Ruby 78.49% JavaScript 1.92% CSS 2.62% HTML 16.96%

thirsty_plants's Introduction

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:

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

Teamwork Makes the Dream Work

Acknowledgments

thirsty_plants's People

Contributors

Stargazers

Watchers

Forkers

asmolentzov abenetka bendelonlee

thirsty_plants's Issues

Set Up VCR

Create Sign Out Path

Create a Sign Out Path and link the Nav Bar with such.
https://developers.google.com/identity/sign-in/web/sign-in#sign_out_a_user

Dream: Better Plant creation - multiple at once, or dynamic addition of Add Plant fields

Dream: Generate notices based on temperature

Notify user if temperature is above x% higher than the previous week

Thirstiness of Plants

Add thirstiness level to garden show page and method to determine thirstiness

bug: Session create always creates a user

Each time you log in to the app, it creates a new user

Generate Schedule

On my dashboard, I see a link to generate my watering schedule. When I click this button, I am redirected to the schedule index page. The index page shows the schedules for each of my gardens.

The schedule index page should show the schedule for each of my gardens. The schedule includes then watering schedule for each plant.

(reference wireframes)

Refactor: refactor error handling

Setup Travis CI

Lesson on what it is (start here and select the links at the bottom to signup for Travis CI):

http://backend.turing.io/module3/lessons/ci_and_staging_environments

User location

as a user
When I create a garden
I am asked if I want to give permission to share my location
Now weather data is specific to my location

Consume API

styling 404 page

As a visitor to the site who is not logged in
When I visit any path other than '/'
I see some sort of 'error page not found' page with a 404 status.
("Sad plants! Can't find this page!" maybe??)

schedule plant icon instead of checkbox

Instead of a checkbox, I see a plant icon. The plant icon is yellow. I click on the plant name or the icon. In either case, the plant turns green. The plant name is crossed off.

Deploy to Heroku

User Registration

As a user, when I visit the root_path, I should see a link to login or register.
If I click on 'sign up' and I will be taken to Google's OAuth information page. If I click on login, I am redirected to a login page, where I can enter my email address, which will start the OAuth process.

Tutorial for TDD of Google OAuth & Rails (made by Jesse - a Turing grad):
http://www.jessespevack.com/blog/2016/10/16/how-to-test-drive-omniauth-google-oauth2-for-your-rails-app

Redirect to my user dashboard.

required by #3
required by #7
required by #11
required by #10
required by #4
required by #8
required by #9
required by #6
required by #5
required by #2

Dream - Plant API Consumption

A user can tag their plant as being a member of a species.
Using a plant API, there is now a default image available for their plant.

Garden Browser Current Location

Give user option to use current location from browser instead of zipcode

LoggedIn User redirect for Welcome page - low priority

It would be nice for a logged-in user to be redirected to the dashboard.. if they visit the welcome page.

Schedule Index Page

The schedule show page should show the schedule for each of my gardens. The schedule includes the weather & watering schedule for each plant.

Add Plant to Garden

From my garden's show page, I can click a link to add a plant to my garden. When I click this link, I am redirected to a create plant page. On this page, I can add a plant name and times per week. After I select 'create plant', I am redirected to my garden show page and I see a flash message that says, "Party in my plants, you've created a new plant!"

Create Nav Bar

(reference wire frame)

Dream - Garden Grid

aka specific plant location

Delete garden

On my garden show page there is a button to delete a garden.
When I click, a pop-up box asks to confirm.
I confirm.
And I am taken to my dashboard and I see there that the garden does not appear.

Dream - Weather Synopsis

Plant picture

User can add pictures of plants

Refactor: Limit range of times_per_week for plants

next_seven_days refactor

Take another look at this method in the users controller to clean up this method.

Create Garden

From my dashboard, when I select 'create garden', I am redirected to the create_garden_path. I can fill in a garden name, zip code, and multiple plants. Each plant has a name and watering requirements.
After I select 'create my garden' I am redirected to that garden's show page where I see the appropriate details.

Rainy Day Notice

As a user,
When I have a watering scheduled on Monday,
On the day before the watering is scheduled,
If the forecasted chance for precipitation is high,
I receive a text message notice.
This notice informs me of the precipitation forecast.
I also see a link to cancel the watering.

(Dream/eventually, A message: "Don't worry, if it doesn't actually rain we'll let you know and you can reschedule")
#epic

update garden

On my garden show page there is a link to edit the garden.
When I click I see the old values in each field
I input new values
and click update
And I am taken back to the garden show page
There I see the new values

• include sad path

Dream - Schedule Show Page

Google Calendar Integration

Update Plant

From my garden's show page, I can click 'update my plant'. When I select this, I am redirected to my edit page, and I can update the times per week and the name. After I click 'update my plant', I am redirected to my garden's show page, and I see a flash message indicating that my plant has been successfully updated.

Dream - Update schedule

Manually

Add Heroku to Travis CI

Research Twilio - texting integration

Garden Show Page

When I visit the show page for one of my gardens, I should see my garden's name, the names of the plants inside my garden, my garden's location, and the thirstiness level of my plants

Update schedule

On my schedule index page:

I am able to add and remove waterings
I am able to move a watering from one day to another
(stretch: I am able to move multiple waterings at once from one day to another)

Convert zip to lat & long

When I enter my zip code, the coordinates are converted to latitudinal and longitudinal values

https://developers.google.com/maps/documentation/geocoding/intro

checking off plant updates database

I go to the page, I check off a box. I go back and it's still checked. I uncheck it. I leave and return to the page. It remains unchecked.

User Dashboard

When I visit my dashboard, I can see all of my existing gardens or a message indicating that I have no gardens. I can also see a link to create a new garden .
Each garden name is a link to that garden's show page.

Dream: Let users decide if they want text or email notifications

Remove Plants

From my garden's show page, I have the ability to delete my plant. When I select the delete button, I am returned to my garden's show page, and I no longer see that plant. I see a flash message saying "goodbye dear plant"

Dream - Hot Temperatures

Change watering schedule based on heat

Implement Wireframes

*Requested by Tuesday check-in.

Dream - Future & Past Waterings

App Optimization

Consider:
Caching (ie nav bar and persistent elements)
CSS

Get metrics from suggested websites on current load times

check out links mentioned in rubric
Card 102 is a start on this card.

Dashboard Weather Icons

The DarkSky API has an icon under ["daily"]["icon"] which correlates with the weather for that day. Insert conditionals into the dashboard view so that an image ie rain drop appears if the icon is -rain- for that day.

*Before implementing take a look at the data to insure that the icon correlates with the ["precipProbability"].

** By the time this card is being worked on, the API call for "icon" will be created.