An open API service indexing awesome lists of open source software.

https://github.com/trigensoftware/weather

Architecture demo app.
https://github.com/trigensoftware/weather

Last synced: 3 months ago
JSON representation

Architecture demo app.

Awesome Lists containing this project

README

        

# weather

[![Dependencies status][deps]][deps-url]
[![Dev dependencies status][dev-deps]][dev-deps-url]
[![Build status][build]][build-url]
[![Dependabot badge][dependabot]][dependabot-url]

[deps]: https://david-dm.org/TrigenSoftware/weather.svg
[deps-url]: https://david-dm.org/TrigenSoftware/weather

[dev-deps]: https://david-dm.org/TrigenSoftware/weather/dev-status.svg
[dev-deps-url]: https://david-dm.org/TrigenSoftware/weather?type=dev

[build]: http://img.shields.io/travis/com/TrigenSoftware/weather/master.svg
[build-url]: https://travis-ci.com/TrigenSoftware/weather

[dependabot]: https://api.dependabot.com/badges/status?host=github&repo=TrigenSoftware/weather
[dependabot-url]: https://dependabot.com/

Architecture demo app.

## Available scripts

```bash
# Lint only styles
yarn lint:styles
# Lint only scripts
yarn lint:scripts
# Lint all sources
yarn lint
# Run tests with Jest
yarn jest
# Run type checking
yarn typecheck
# Run lint, tests and build
yarn test
# Generate docs for TypeScript sources
yarn build:docs
# Start Storybook
yarn start:storybook
# Build standalone Storybook bundle
yarn build:storybook
# Start development server
yarn start
# Build our bundle for production
yarn build
# Serve files from `build` directory
yarn serve
```

## Environment variables

To be able to build this app, you should provide some environment variables:

```bash
OPENWEATHER_APPID=XXX # OpenWeather API App ID; not set by default
```

Optional variables:

```bash
PROXY_API_URI='' # valid URI; not set by default
DISABLE_BROWSER_SYNC=false # boolean; `false` by default
DISABLE_HISTORY_FALLBACK=false # boolean; `false` by default
```

You can create `.env` in project root with this variables.