Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/geops/tree-app

PWA for tree recommendations
https://github.com/geops/tree-app

frontend

Last synced: 7 days ago
JSON representation

PWA for tree recommendations

Awesome Lists containing this project

README

        

# tree-app

This offline-first web application provides tree recommendations for different climate change scenarios.

## Installation

1. Install all dependencies: `yarn install`
2. Optionally customize vector tiles endpoint: copy `.env` to `.env.local` and modify the endpoint variable.
3. Build the app for production: `yarn run build`
4. [Serve](https://create-react-app.dev/docs/deployment/) the `./build` directory using your favorite HTTP server.
5. Make sure to redirect all paths to `index.html` to [support client-side routing](https://create-react-app.dev/docs/deployment/#serving-apps-with-client-side-routing).

## More

- [Development](https://github.com/geops/tree-app/tree/master/DEVELOPMENT.md)

## Bugs

Please use the [GitHub issue tracker](https://github.com/geops/tree-app/issues) for all bugs and feature requests. Before creating a new issue, do a quick search to see if the problem has been reported already..

## Deploy

Deploy master to production on https://www.tree-app.ch:

- Create a deploy branch (e.g. `johnDoe/deployProd20082024`) from the current master and push
- Create a pull request with base branch `production` and the deploy branch as compare branch.
- Merge with the option `Rebase and Merge` or `Squash and Merge` (github might not let you rebase due to conflicts)

## Run service-worker locally

To test offline-mode in development, the local build must be launched using http (not https).
This can be done with the following steps:

- `yarn build`
- `yarn global add serve`
- `serve -s build`