https://github.com/blakek/weather-outlook-api
A weather API built on the NWS and Storm Prediction Center that provides the categorical, tornado, hail, wind, etc. outlooks for a location.
https://github.com/blakek/weather-outlook-api
Last synced: about 1 month ago
JSON representation
A weather API built on the NWS and Storm Prediction Center that provides the categorical, tornado, hail, wind, etc. outlooks for a location.
- Host: GitHub
- URL: https://github.com/blakek/weather-outlook-api
- Owner: blakek
- Created: 2024-05-22T17:24:43.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2026-04-27T20:42:14.000Z (3 months ago)
- Last Synced: 2026-04-27T22:19:16.996Z (3 months ago)
- Language: JavaScript
- Homepage: https://weather-outlook-api.vercel.app/api/graphql
- Size: 523 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Weather Outlook API
> ⛈️ A weather API built on the [NWS](http://www.weather.gov/) and
> [Storm Prediction Center](https://www.spc.noaa.gov/) that provides the
> categorical, tornado, hail, wind, etc. outlooks for a location.
This fills a gap until the NWS provides a public API for SPC outlooks for a
location. This API just downloads the outlook GeoJSON files and uses them to
provide the outlooks for a location.
## Getting Started
[Bun] is required to run this project.
To install dependencies, run:
```bash
bun install
```
To run the project, run:
```bash
bun start
```
To run the tests, run:
```bash
bun test
```
See below for other scripts.
### Useful Commands
| | |
| ------------------- | ----------------------------------------------- |
| `yarn build` | Builds the project to `./dist` |
| `yarn format` | Format the source following the Prettier styles |
| `yarn test` | Run project tests |
| `yarn test --watch` | Run project tests, watching for file changes |
## License
MIT
[bun]: https://bun.sh/