grossdesignco/stateofcobalt

State of Cobalt is a research project & publication, advocating for human rights in the Cobalt Mining industry.

State of Cobalt

stateofcobalt.org/2021

This is a working draft of a research project, supporting a local internship program :)

Local Setup

First, run the development server:

npm i
npm run dev

Open http://localhost:3000 with your browser to see the result.

Publish to https://stateofcobalt.org

First, build locally:

npm run build

This will generate the /docs folder (which is one of the only subdirectories GitHub allows for it's pages. If/when we move to AWS this'll change to next.js's default /out).

Then, checkout to a fresh branch, commit your changes, and create a PR.

git checkout [user]/[branch-name]
git add .
git commit -m "[briefly state the changes]"
git push

Example:

git checkout matt/update-readme
git add .
git commit -m "add examples to readme file"
git push

Special Thanks

Credit for useful things:

1. https://systemuicons.com/
2. https://nextjs.org/
3. https://type-scale.com/

stateofcobalt's Issues

Generate unique heading references

We need something to make the report more navigable.

Eg. "Background" will need a unique hash, so that we don't wind up with 20 #background hashes that break the single-page navigation.

Options

1. Scope sections, eg. #consumer-tech-background
   • Need to avoid naming conflicts
2. Generate uids, eg. #axy4q-background
   • Need to ensure hashes don't change & break external links
3. Separate report sections into individual pages eg. /2021/consumer-tech#background
   • Still need to avoid naming conflicts within sections

Security plan

stateofcobalt.org is already getting significant traffic & a few threats blocked by cloudflare

TODO:

• Upgrade from Flexible to Full SSL
• review other security concerns
• Set up 2FA for collaborators

Print styles

Users should be able to print a clean pdf version of the report directly off the website