This project was first prototyped at the Open Oakland Day of Service 2019. Continued development occurs as part of the Open Oakland Brigade.
This landing page is intended to be a portal for the 2020 Census administered by Alameda County. It will be accessible at locations where a computer or tablet is provided to the public and is intended to introduce people to the Census and offer information about why the Census is important to complete, as well as resources and guides on how to complete the Census. It is intended to be welcoming to people for whom English is not their first language.
- Clone or fork the repo
cd dos-acccc
: change directories into the project foldernpm install
: install dependenciescp landing-page-copy-example.json data/landing-page-copy.json
: copy the example json file to thedata/
foldernpm run start
: start a dev server and open the local site in a browser
The main index.html
page links to resources in all languages supplied by the data/landing-page-copy.json
file. For Alameda County, we are linking to Google Drive folders. Static assets like fonts, images, and CSS stylesheets are located in the public
folder.
.
├── data
├── node_modules
├── public // static assets + CSS and JS
│ ├── fonts
│ ├── img
│ ├── styles // edit CSS styles here
│ └── index.js // edit JS here
├── views
│ ├── layouts
│ │ └── base.hbs // base template for all of the pages, doctype, <head>, and <body>
│ ├── index.hbs
├── ... // gitignore, package*.json, webpack config files
├── json-transformer.js // generation script for landing page content
├── landing-page-copy-example.csv // example of CSV that json-transformer.js can ingest
├── landing-page-copy-example.json // example of JSON output from json-transformer.js
├── index.html // AUTO-GENERATED, DO NOT EDIT: main entry page
└── main.js // AUTO-GENERATED, DO NOT EDIT: compiled js from public/index.js
The page is published as a static GitHub page at https://llkats.github.io/dos-acccc/. It will publish automatically on a merge to master.
TBD, but roughly:
- create a new branch against master
- make changes
- test your changes locally
- open a PR (write moar here)
- ping @llkats for a review
Copy is provided in a Google Sheets document (ask @llkats for the link if you need access). If you want to create your own spreadsheet, make sure to include the following columns:
languageName - language name in its native characters, eg., ελληνικός
enLanguage - language name in English
pagePosition - "top" or "bottom"
link - the link to which you want the button to navigate
- Export the latest document as a CSV and save it as
data/landing-page-copy.csv
. - Transform the CSV into a JSON file with the following json-transformer script.
npm run build-json
Otherwise, you can edit the landing-page-copy.json
file by hand to supply the content you need.
- this was a good article on Handlebars partials: https://cloudfour.com/thinks/the-hidden-power-of-handlebars-partials/
- Survive JS - Webpack, particularly the chapters on supporting multiple pages and composing configuration
- templates
introduce templatespass language in path to /more-info/:language page and render appropriate JSON file, falling back to English if no matchcreate "additional resources" template and generate based on languageprerender all templates with a build step and investigate caching
- accessibility audits
- accessibility will be of primary concern
- all efforts should be made to adhere to WCAG standards
- browser testing
- test in a wide range of browsers, especially Internet Explorer and Edge, and iOS tablet-size screens
- version control
maybe move to github
- hosting
somewhere other than glitch?