EEW Website

The environmentalenforcementwatch.org website for the Environmental Enforcement Watch project by EDGI

Staging site at staging.environmentalenforcementwatch.org

For site maintainers

Where to edit content

• Content is located in markdown files (.md) in the folder content > subfolder [name of the page]. If you are not a coder, this will usually be the place to go to make edits!
  • Images that go with a particular page should go into the same folder as the .md file
• Other places content might be:
  • In that same folder, a .json file might have some additional content that will show up on that page
  • src/pages and then the appropriately named .js file (this is the file that tells the information from the .json file and the .md file where and how to show up)
• Styling in general is in a .css file. The main one is in src/global.css.js. But it might also be in the .js file in src
• If this is all very obscure and overwhelming for you, that's ok! Just make sure to do your work in a branch and submit it via a pull request and then we can review it before it goes live.

Adding images to .md page content

• Images should be uploaded to the same folder as the Markdown file they are used in (for example, an image on the homepage should be put in content/home).
  • If you're not comfortable with coding on your computer, you can use Github's Upload Files functionality. Just make sure to put your image in the correct folder!
• From a Markdown (.md) content file, you can now use Markdown syntax to link your image based on its location relative to the content file ("relative filepath"). This will look like ![alt text for image](./my-image.png). The ./ part means that the image is in the same folder as the file you're referencing it from.
• Don't forget to fill in the alt text! The image will render without it, but it's important to have a text description of the image for screen readers and in case the image fails to load properly.

For developers

Toolset

• Written in Gatsby, a Node React framework
• Hosted on Namecheap
• Continuous deployment uses Github Actions

Deployment

Continuous deployment

This site deploys automatically to staging upon merge to main, and to production upon tagged release.

You can see automatic deployment status in the badge at the top of this readme. To debug, check the Actions tab of this repo.

Staging

Staging automatic deployment configuration can be found in .github/workflows/continuous-integration-workflow.yml.

Upon merge to main, the staging Github Action is triggered which builds the site to the gh-pages branch and ftp deploys it to staging.environmentalenforcementwatch.org

Production

Production automatic deployment configuration can be found in .github/workflows/release-to-production.yml.

Upon a tagged release (through the “Releases” section of the repo), production Github action is triggered which ftp deploys the gh-pages branch to environmentalenforcementwatch.org

Local development

0. (If you're just learning, it would be a good idea to get familiar with the command line. Here's a 1-page tutorial, and here's a video demo)
1. Make sure you have Node installed (Video demo)
2. Create a local clone of this repo (Video demo)
3. In a local clone of this repo, run npm install to install dependencies (Video demo)
4. You will need the Gatsby CLI tool: npm install -g gatsby-cli
5. Run locally with npm run start (defaults to http://localhost:8000/) (Video demo)

Gatsby quickstart docs

License & Copyright

Copyright (C) 2023 Environmental Data and Governance Initiative (EDGI)

EEW website is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License.

See the LICENSE file for details.