Skip to content

🌱🌻 A garden maintenance NERDS tech-stack application with the Trefle and OpenWeatherMap API

Notifications You must be signed in to change notification settings

sdhani/PlantPal

Repository files navigation

🌱🌻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 git@github.com: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.

About

🌱🌻 A garden maintenance NERDS tech-stack application with the Trefle and OpenWeatherMap API

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published