{"id":22472387,"url":"https://github.com/opensavannah/floodsight","last_synced_at":"2026-05-16T11:01:51.070Z","repository":{"id":41788401,"uuid":"192812892","full_name":"opensavannah/floodsight","owner":"opensavannah","description":"Community flood reporting map","archived":false,"fork":false,"pushed_at":"2022-12-22T08:56:38.000Z","size":69325,"stargazers_count":0,"open_issues_count":22,"forks_count":0,"subscribers_count":2,"default_branch":"dev","last_synced_at":"2025-02-01T20:11:27.175Z","etag":null,"topics":["branch-backend","bucket","citizen-science","crowdsource-monitoring","frontend","sea-level-rise","storybook"],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/opensavannah.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-06-19T22:35:11.000Z","updated_at":"2023-07-18T09:10:05.000Z","dependencies_parsed_at":"2023-01-30T06:30:55.983Z","dependency_job_id":null,"html_url":"https://github.com/opensavannah/floodsight","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/opensavannah%2Ffloodsight","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/opensavannah%2Ffloodsight/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/opensavannah%2Ffloodsight/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/opensavannah%2Ffloodsight/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/opensavannah","download_url":"https://codeload.github.com/opensavannah/floodsight/tar.gz/refs/heads/dev","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245879209,"owners_count":20687340,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["branch-backend","bucket","citizen-science","crowdsource-monitoring","frontend","sea-level-rise","storybook"],"created_at":"2024-12-06T12:14:45.401Z","updated_at":"2025-10-27T04:08:55.234Z","avatar_url":"https://github.com/opensavannah.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Floodsight.org\nChatham County Citizen Flood Monitoring \n\n- [Set Up Development Environment](#set-up-development-environment)\n- [Run Tests](#run-tests)\n- [Run Storybook](#run-storybook)\n- [Deployment Process](#deployment-process)\n- [Development Tips](#development-tips)\n\n## Set Up Development Environment\n💾 [Install yarn](https://yarnpkg.com/en/docs/install)\n\n👯 Clone the repo\n```\ngit clone https://github.com/opensavannah/floodsight\ncd ctxfloods\nyarn install\n```\n\n⌨️ Start the local server\n```\nyarn start-local\n```\n\n💾 Clone and install [Floodshight-backend](https://github.com/opensavannah/floodsight-backend)\n\n🥂 Cheers! The frontend should now be up and running! Have fun clicking around!\n\n## Run Tests\n```\nyarn test\n```\nIf any storybook snapshots need updating, run `yarn test -u`\n\n## Run Storybook\n```\nyarn storybook\n```\n\u003cimg src=\"/README/storybookrunning.png\" align=\"middle\" height=\"62\" \u003e\n\u003cimg src=\"/README/storybookscreeny.png\" align=\"middle\" height=\"299\" \u003e\n\n## Deployment Process\nBranch promotion works like this:\u003cbr\u003e\nfeature -\u003e dev -\u003e master\n\nCreate your feature branch as a branch off \"dev\". That feature branch will be merged into \"dev\", which will then be merged into \"master.\"\n\nCTXFloods 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:\n```\n\"195-camera\": {\n  deploy: true,\n  backend: \"195-camera\"\n}\n```\nIf `deploy: true` is set without a specified backend, your frontend will point to the \"dev\" branch backend.\n\nEnvironment 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.\n\nIt 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.\n\nUpdate settings in CloudFront if you want to use a custom DNS name.\n\n## Development Tips\n+ 🔑 Some pages require a login:\n\n   \u003cimg src=\"/README/login-to-frontend.png\" align=\"middle\" height=\"300\" \u003e\n\n   📧 In case of such a page, you can log in as the default super admin user:\n   * Email: superadmin@flo.ods\n   * Password: texasfloods\n\n   This password is set as `PG_SUPER_ADMIN_PW` in `/deployment/vars/local` in ctxfloods-**backend**.\n+ 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`.\n+ If you added a new postgres migration file to the backend, regenerate the frontend's graphql schema file by running `yarn get-schema`\n+ Environment variables prefixed by `TRAVIS_` are secret variables stored in TravisCI. They get loaded in during the build phase of a TravisCI/github deployment.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopensavannah%2Ffloodsight","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fopensavannah%2Ffloodsight","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopensavannah%2Ffloodsight/lists"}