Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/vsergeev/briefsky
A free weather frontend to a variety of weather providers
https://github.com/vsergeev/briefsky
weather
Last synced: 17 days ago
JSON representation
A free weather frontend to a variety of weather providers
- Host: GitHub
- URL: https://github.com/vsergeev/briefsky
- Owner: vsergeev
- License: other
- Created: 2023-02-24T11:48:42.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2024-08-10T19:28:03.000Z (3 months ago)
- Last Synced: 2024-08-11T08:34:21.596Z (3 months ago)
- Topics: weather
- Language: TypeScript
- Homepage: https://briefsky.app/
- Size: 759 KB
- Stars: 244
- Watchers: 3
- Forks: 23
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# briefsky [](https://github.com/vsergeev/briefsky) [](https://github.com/vsergeev/briefsky/blob/master/LICENSE)
[briefsky](https://briefsky.app/) is a free weather frontend to a variety of
weather providers, with an interface reminiscent of the late [Dark
Sky](https://darksky.net/).
briefsky retains all configuration in URL parameters, so you can bookmark
multiple locations or weather providers. briefsky is implemented as a
client-side app. It doesn't collect user information, show ads, or store
cookies.
briefsky currently supports the following weather providers:
- [Open-Meteo](https://open-meteo.com) (default)
- [Visual Crossing](https://www.visualcrossing.com/)
- [Tomorrow.io](https://www.tomorrow.io/)
- [Pirate Weather](https://pirateweather.net/)
- [WeatherFlow Tempest](https://weatherflow.github.io/Tempest/)
Some weather providers may require a free API key.
## Building
Install packages:
```
$ npm install
```
Run local development server:
```
$ npm run dev
```
Build production bundle:
```
$ npm run build
```
Preview production bundle:
```
$ npm run preview
```
Format, lint, and check:
```
$ npm run format && npm run lint && npm run check
```
## Unsupported Providers
briefsky strives to support free weather providers with open APIs or with free
API keys. However, some providers are missing weather data needed by the
frontend, or lack sufficient weather data with a free API key. Below is a list
of currently unsupported weather providers:
- [National Weather Service](https://www.weather.gov/documentation/services-web-api)
- Missing usable condition icons
- Missing sunrise/sunset data
- [OpenWeather](https://openweathermap.org/api)
- Missing free daily forecast in standard API
- Missing sufficient free hourly forecast in One Call API (only 48 hours
free)
- [Meteomatics](https://www.meteomatics.com/en/weather-api/)
- Does not support CORS
- Missing apparent temperature, humidity, and dew point in free parameters
- [Weatherbit](https://www.weatherbit.io/)
- Missing free hourly forecast
- [Weatherstack](https://weatherstack.com/)
- Missing free daily and hourly forecast
- [Accuweather](https://developer.accuweather.com/)
- Missing sufficient free hourly forecast (only 12 hours free)
- [Stormglass.io](https://stormglass.io/)
- Does not provide daily forecast
## File Structure
- [src/](src/) - Sources
- [components/](src/components/) - Components
- [primitives/](src/components/primitives/) - Primitives
- [providers/](src/providers/) - Weather Providers
- [public/](public/) - Static assets
- [index.html](index.html) - Top-level HTML
- [package.json](package.json) - npm package configuration
- [package-lock.json](package-lock.json) - npm package lock
- [tsconfig.json](tsconfig.json) - TypeScript (Web) configuration
- [tsconfig.node.json](tsconfig.node.json) - TypeScript (Node) configuration
- [vite.config.ts](vite.config.ts) - Vite configuration
- [svelte.config.js](svelte.config.js) - Svelte configuration
- [postcss.config.cjs](postcss.config.cjs) - PostCSS configuration
- [tailwind.config.cjs](tailwind.config.cjs) - Tailwind configuration
- [CHANGELOG](CHANGELOG.md) - Change log
- [LICENSE](LICENSE) - MIT License
- [README.md](README.md) - This README
## License
briefsky is MIT licensed. See the included [LICENSE](LICENSE) file.