Git Product home page Git Product logo

plantpal's Introduction

🌱🌻PlantPal

A garden maintenance app where users can

  • Store a virtual garden list of both their indoor and outdoor plants (CRUD)
  • Sift through care tips for their particular plant. (via the Trefle API)
  • Get WEATHER and CARE indications for outdoor plants (via the OpenWeatherMap API)

Contributors

Install and Run

  1. Clone this repository. 
    HTTP: git clone https://github.com/sdhani/PlantPal.git
SSH: git clone [email protected]:sdhani/PlantPal.git
  2. Run yarn install-all in root directory.
  3. Run yarn start-all in root directory.

Running with a Local PostgreSQL DB

  1. Create a local PostgreSQL DB (i.e. createdb newDB).

  2. Create a .env file in the root directory, and add replace with your tokens.

    DATABASE_URL = "url-link-to-newDB"
TREFLE_TOKEN = "your-trefle-token"
OWEATHER_TOKEN = "your-open-weather-token"
SECRET_JWT = "your-secret-jwt-key"
OWEATHER_UNITS = "preference for units (imperial, metric, or kelvin (default))"

  3. Add require('dotenv').config(); to the top of your knexfile.js for development. OPTIONAL.

Set up your database tables relations.

  1. Run knex migrate:latest in the root directory (note: if knex command is not found, you can run npx knex migrate:latest).

Seed your database.

  1. Run knex seed:run in the root directory (note: see above regarding npx).
  2. Run yarn start-all in the root directory.
  3. Open http://localhost:3000 in your browser to view seed data of all users.

Check Out PlantPal's RESTful API Docs 🎉

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.