aresnik11 / plant-nanny-backend

🌿 RESTful API built with Ruby on Rails, PostgreSQL database, and ActiveModel Serializer. Stores users, plants, and notes for the plant nanny app. Utilizes JWT and BCrypt to securely store user info.

Plant Nanny

Developed by Amy Resnik and Kunxi Griswold.

Plant Nanny is a plant app for users to keep track of their plants and add notes about them.

The backend repo is deployed via Heroku, and the frontend repo (here) is deployed via Netlify. Visit the site at https://plant-nanny.netlify.app.

Demo

You can watch a live demo of the app here or visit the site at https://plant-nanny.netlify.app.

Technology Used

• React
• React Router
• Semantic UI
• Custom CSS
• JWT Authentication
• Ruby on Rails
• PostgreSQL database
• ActiveModel Serializer

The GitHub repo for the frontend can be found here.

Features

Plant Nanny allows users to:

• Create an account
• Securely log in to an existing account
• Add a new plant
• Search through their plants
• Add a new note associated with a plant
• See notes associated with a specific plant
• See all of their notes
• Search through their notes
• Delete a plant
• Delete a note
• Securely log out

How To Use

Visit the site at https://plant-nanny.netlify.app.

To test on your own machine:

1. Clone this repository
2. Switch to Ruby version 2.6.1
3. Make sure postgreSQL is running on your computer, if not, download and run it
4. Create an .env file in the top level directory
5. In the .env file, create a constant variable JWT_SECRET_KEY and set it equal to whatever you want your secret key to be. Ex:

JWT_SECRET_KEY=test123

6. In terminal run

bundle install
rails db:create
rails db:migrate
rails s

7. Follow instructions here to run the frontend
8. You will need to update config/initializers/cors.rb to accept origin requests from wherever your frontend will be hosted

Enjoy!