Skip to content

Latest commit

 

History

History
44 lines (32 loc) · 1.83 KB

README.md

File metadata and controls

44 lines (32 loc) · 1.83 KB
Raw

weather-api

The weather API serves weather data for the conterminous United States.

Table of Contents:

Tech Stack

  • Node.js

Features

The API is documented at https://weather.covercrop-data.org/

Local Installation Steps

Prerequisites:

  1. You must be a member of the PSA team.
  2. Your IP address must be added to the Postgres database that's serving the weather data. Contact @rickhitchcock with that information.
  3. Node and NPM Download Here
  4. Git Download Here
  5. A code editor (we recommend VS Code) Download Here

Steps:

  1. Open a new Terminal for Mac/Linux or Command Prompt for Windows
  2. Move to the desired folder cd /path/to/folder
  3. Clone this repository into that folder git clone https://github.com/precision-sustainable-ag/weather-api
  4. From the Terminal/Command Prompt, move into the cloned directory cd weather-api
  5. From the same command window, run npm install to install project dependencies. A full list of the dependencies can be found in package.json. If you are running on a windows machine, delete package-lock.json prior to running the below command.
  6. Create a file called .env in src/shared. The file will contain the below keys. This document is in the git ignore, so it (and your API keys) won't be pushed to the repository. Ask @rickhitchcock for the values of the keys
Weather|postgres|<weather server key>
GoogleAPI||<google api key>
  1. After the dependencies have been installed and the .env file has been created, run npm start to run the code locally.
  2. Open http://localhost.

Date Created: 08/15/2022

Date Last Modified: 06/08/2023