{"id":21619075,"url":"https://github.com/usds/ej-scorecard","last_synced_at":"2026-04-12T01:31:26.612Z","repository":{"id":65227255,"uuid":"579167924","full_name":"usds/ej-scorecard","owner":"usds","description":"Environmental Justice scorecard","archived":false,"fork":false,"pushed_at":"2024-02-08T23:44:22.000Z","size":5388,"stargazers_count":0,"open_issues_count":14,"forks_count":3,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-18T18:19:47.944Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/usds.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-12-16T20:48:41.000Z","updated_at":"2023-01-10T02:51:49.000Z","dependencies_parsed_at":"2023-02-18T12:16:28.199Z","dependency_job_id":"8063b40b-13a6-4f1b-a1f5-e090f7649ca2","html_url":"https://github.com/usds/ej-scorecard","commit_stats":{"total_commits":45,"total_committers":2,"mean_commits":22.5,"dds":"0.022222222222222254","last_synced_commit":"ab5c130d91f4a6fb3ddfd1eb5645ea1dcd583734"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/usds/ej-scorecard","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/usds%2Fej-scorecard","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/usds%2Fej-scorecard/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/usds%2Fej-scorecard/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/usds%2Fej-scorecard/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/usds","download_url":"https://codeload.github.com/usds/ej-scorecard/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/usds%2Fej-scorecard/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31701641,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-11T21:17:31.016Z","status":"ssl_error","status_checked_at":"2026-04-11T21:17:24.556Z","response_time":54,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":[],"created_at":"2024-11-24T23:07:49.909Z","updated_at":"2026-04-12T01:31:26.594Z","avatar_url":"https://github.com/usds.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003c!-- \u003cp align=\"center\"\u003e\n  \u003cimg src=\"https://user-images.githubusercontent.com/86254807/211453777-5c594217-ad97-4843-b3db-84431e5b6e3b.png\" alt=\"EJ logo\"\u003e\n\u003c/p\u003e --\u003e\n\n\u003cbr /\u003e\n\n\u003cdiv align=\"center\"\u003e\u003cstrong\u003eOpinionated TypeScript starter for Gatsby\u003c/strong\u003e\u003c/div\u003e\n\u003cdiv align=\"center\"\u003eA TypeScript starter for Gatsby that works with Trussworks components, USWDS SASS and i18n\u003c/div\u003e\n\n\u003cbr /\u003e\n\n## Features\n\n- ⚡️ Gatsby 5\n- ⚛️ React 18\n- ⛑ TypeScript\n- 🐐 Tests — Vitest and Testing Library out of the box\n- 📏 ESLint — To find and fix problems in your code\n- 💖 Prettier — Code Formatter for consistent style\n- 🐶 Husky — For running scripts before committing\n- 🚓 Commitlint — To make sure your commit messages follow the convention\n- 🖌 Renovate — To keep your dependencies up to date (being configured)\n- 🚫 lint-staged — Run ESLint and Prettier against staged Git files (needs attention)\n- 👷 PR Workflow — Run Type Check \u0026 Linters on Pull Requests\n- ⚙️ EditorConfig - Consistent coding styles across editors and IDEs\n- 🗂 Path Mapping — Import components or images using the `@` prefix\n\n## Quick Start\n\nThe best way to start is to clone this repo:\n\n```\ngit clone https://github.com/usds/gastby-uswds-ts-starter.git your-project-name\n```\n\n### Development\n\nTo start the project locally:\n\n1. Git clone the starter repo (above) in a terminal\n2. If you don't have node 18, install and verify that `node -v` return 18.x. You can use `nvm` or `asdf`\n3. run `nvm use 18`\n4. Ensure that `pnpm` and `gatsby-cli` are globally installed:\n\n```\n$ npm list -g --depth=0\n/Users/username/.nvm/versions/node/v18.12.1/lib\n├── corepack@0.14.2\n├── gatsby-cli@5.2.0\n├── npm@8.19.2\n└── pnpm@7.18.2\n```\n\n5. run `pnpm install`\n6. run `pnpm clean \u0026\u0026 pnpm start`\n\nOpen `http://localhost:8000` with your browser to see the result.\n\n## Documentation\n\n### Requirements\n\n- Node.js \u003e= 18\n- pnpm 7\n\n### Directory Structure\n\n- [`__helpers__`](./__helpers__/) — Helpers files for testing configuration.\u003cbr\u003e\n- [`__mocks__`](./__mocks__/) — Mocks for testing.\u003cbr\u003e\n- [`.github`](.github) — GitHub configuration including the CI workflow.\u003cbr\u003e\n- [`.husky`](.husky) — Husky configuration and hooks.\u003cbr\u003e\n- [`src`](./src) — Application source code, including pages, components, styles.\n\n### Scripts\n\n- `pnpm start` — Starts the application in development mode at `http://localhost:8000`.\n- `pnpm build` — Compile your application and make it ready for deployment.\n- `pnpm serve` — Serve the production build of your site\n- `pnpm clean` — Wipe out the cache (`.cache` folder).\n- `pnpm type-check` — Validate code using TypeScript compiler.\n- `pnpm lint` — Runs ESLint for all files in the `src` directory.\n- `pnpm format` — Runs Prettier for all files in the `src` directory.\n- `pnpm test` — Run tests with Vitest.\n- `pnpm test:watch` — Run tests on watch mode.\n\n### Path Mapping\n\nTypeScript are pre-configured with custom path mappings. To import components or files, use the `@` prefix.\n\n```tsx\nimport { Button } from '@/components/Button';\n\n// To import images or other files from the static folder\nimport avatar from '@/static/avatar.png';\n```\n\n## USDS Specific\n\n- works with [trusswork](https://trussworks.github.io/react-uswds/) components\n- can use [USWDS tokens](https://designsystem.digital.gov/design-tokens/) as mixins in sass modules (at component level)\n- works with i18n using [format.js (react-intl)](https://formatjs.io/docs/react-intl/api)\n- has a generator script to quickly create components\n\n### Before each commit run the following:\n\n- `pnmp run type-check`\n- `pnmp run lint`\n- `pnmp run format`\n- `pnmp run test`\n- `pnmp run intl:extract`\n\n### i18n\n\nThe steps involved with creating i18n content is as follows:\n\n1. Use `react-intl` as demonstrated in various pages and/or components.\n2. When new content is added, run `pnpm intl:extract`. This will update the json object in `lang/en-US-extract.json`.\n3. Run `pnpm intl:createEnJson`. This will modify the extracted JSON file into an AST that the library expects and remove console errors.\n4. Translate the `en-US.json` file to an `es-MX.json`. Each key from the `en-US.json` file should have a spanish value in `es-MX.json`.\n\n### Deployment\n\nCurrently this repo is using Github actions (see [.github/workflows](https://github.com/usds/gatsby-uswds-ts-starter/tree/main/.github/workflows) in the root directory) for deployment to AWS with the support of Geoplatform.\n\nThese actions will\n\n1. creates a staging link (see [deploy-staging.yml](https://github.com/usds/gatsby-uswds-ts-starter/blob/main/.github/workflows/deploy-staging.yml)) as a comment in every PR made against `main` that passes all checks (type-check, linting, testing, format, commit messages)\n2. update the production folder on AWS\n3. remove any artifacts of the PR when the PR is closed (see [close-pr.yml](https://github.com/usds/gatsby-uswds-ts-starter/blob/main/.github/workflows/close-pr.yml))\n\nIn order for these actions to work as is, the following [secrets need to be added](https://docs.github.com/en/codespaces/managing-codespaces-for-your-organization/managing-encrypted-secrets-for-your-repository-and-organization-for-github-codespaces) in your repo:\n\n1. AWS_ACCESS_KEY_ID\n2. AWS_SECRET_ACCESS_KEY\n3. STAGE_SITE_URL\n\nThe AWS_ACCESS_KEY_ID and the AWS_SECRET_ACCESS_KEY will allow for programmatic (via CLI) access to your AWS resources. See the programmatic access section on [here](https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.htm).\n\nThe STAGE_SITE_URL should point to the name of your S3 bucket or CDN.\n\n## License\n\nThis project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for more information.\n\n## Credits\n\n\u003cdiv\u003e\n  Original repo created by \u003ca href=\"https://twitter.com/jpedroschmitz\"\u003eJoão Pedro\u003c/a\u003e with the help of many \u003ca href=\"https://github.com/jpedroschmitz/gatsby-starter-ts/graphs/contributors\"\u003ewonderful contributors\u003c/a\u003e. Shout out from USDS!!\n\u003c/div\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fusds%2Fej-scorecard","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fusds%2Fej-scorecard","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fusds%2Fej-scorecard/lists"}