Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/opensavannah/floodsight
Community flood reporting map
https://github.com/opensavannah/floodsight
branch-backend bucket citizen-science crowdsource-monitoring frontend sea-level-rise storybook
Last synced: 18 days ago
JSON representation
Community flood reporting map
- Host: GitHub
- URL: https://github.com/opensavannah/floodsight
- Owner: opensavannah
- Created: 2019-06-19T22:35:11.000Z (over 5 years ago)
- Default Branch: dev
- Last Pushed: 2022-12-22T08:56:38.000Z (about 2 years ago)
- Last Synced: 2024-05-29T06:23:44.593Z (7 months ago)
- Topics: branch-backend, bucket, citizen-science, crowdsource-monitoring, frontend, sea-level-rise, storybook
- Language: JavaScript
- Size: 66.1 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 22
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Floodsight.org
Chatham County Citizen Flood Monitoring
- [Set Up Development Environment](#set-up-development-environment)
- [Run Tests](#run-tests)
- [Run Storybook](#run-storybook)
- [Deployment Process](#deployment-process)
- [Development Tips](#development-tips)
## Set Up Development Environment
💾 [Install yarn](https://yarnpkg.com/en/docs/install)
👯 Clone the repo
```
git clone https://github.com/opensavannah/floodsight
cd ctxfloods
yarn install
```
⌨️ Start the local server
```
yarn start-local
```
💾 Clone and install [Floodshight-backend](https://github.com/opensavannah/floodsight-backend)
🥂 Cheers! The frontend should now be up and running! Have fun clicking around!
## Run Tests
```
yarn test
```
If any storybook snapshots need updating, run `yarn test -u`
## Run Storybook
```
yarn storybook
```
## Deployment Process
Branch promotion works like this:
feature -> dev -> master
Create your feature branch as a branch off "dev". That feature branch will be merged into "dev", which will then be merged into "master."
CTXFloods uses TravisCI for continuous integration. Whenever you push to github, a TravisCI build will be triggered. By default this will only run the tests. If you want to deploy your feature branch on a git push, add the name of your feature branch to `deployment/devDeployConfig` with the option `deploy: true`. This will build a new S3 Bucket for your feature branch frontend. Subsequent pushes from the same branch will update this same bucket. If you want to connect it to a specific backend deployment, add the name of the backend branch under the `backend` option. Ex:
```
"195-camera": {
deploy: true,
backend: "195-camera"
}
```
If `deploy: true` is set without a specified backend, your frontend will point to the "dev" branch backend.
Environment variables are sourced from `deployment/vars` depending on your branch. (All feature branches share the same environment variables as `dev.sh`. Any feature branch specific configs should be handled in `deployment/devDeployConfig.js`.) Any environment variable prefixed with `TRAVIS_` is a secret environment variable that is stored in TravisCI. It will get loaded in during the build phase of a TravisCI/github deployment.
It would be possible to deploy ctxfloods without continuous integration by running `deployment/deploy.sh`. However, you would have to provide your own substitutes for the `TRAVIS_` environment variables.
Update settings in CloudFront if you want to use a custom DNS name.
## Development Tips
+ 🔑 Some pages require a login:
📧 In case of such a page, you can log in as the default super admin user:
* Email: [email protected]
* Password: texasfloods
This password is set as `PG_SUPER_ADMIN_PW` in `/deployment/vars/local` in ctxfloods-**backend**.
+ Every route that is prefixed by `/dashboard` is a route that requires authentication. To get to the login page, manually enter the URL address `localhost:3000/dashboard/map`. After authentication succeeds, you will be redirected to the authenticated `/dashboard/map` page. To log off (i.e. remove you jwt_user_token from local storage), click "Sign out" in the upper right hand corner of the header and manually enter `localhost:3000/map`.
+ If you added a new postgres migration file to the backend, regenerate the frontend's graphql schema file by running `yarn get-schema`
+ Environment variables prefixed by `TRAVIS_` are secret variables stored in TravisCI. They get loaded in during the build phase of a TravisCI/github deployment.