If you're looking for a starter development task to get your feet wet with our codebase, any of our Issues tagged help wanted might be a good fit.
Some of the other Issues are larger and require some deeper design or architectural work; if one of those catches your eye, you'll probably want to talk with us for some more context and background. Either comment on the Issue or — even better — catch up with us at one of Code for Sacramento's weekly Hack Nights.
Run docker compose and view the page in your browser at localhost:8011. It is required to rerun the command after making changes to see the effects.
docker compose up --build
npm install
npx @11ty/eleventy --serve --port=8011
Congratulations! Your local copy of Open Budget Sacramento's website should now be running at http://localhost:8011. That means you're ready to do the codez if you want to contribute to the codebase of Open Budget Sacramento. You will probably want to open a new terminal window, though, to regain access to the command line.
npm run build-css
from the _src/ folder in order to incorporate your changes into the CSSThis site is built with Eleventy, a JavaScript-based static site generator that parses Markdown, Pug, and other template languages and runs on Node.js. That means you can reproduce our site locally with minimal setup!
You'll need these installed globally:
Once you have the NPM package manager installed, you can install Eleventy and the other dependencies listed in package.json. Enter the following from the _src/ folder, where the Eleventy configuration file .eleventy.js lives.
npm install
This command usually runs without a glitch, but if you run into trouble, check your version of node. The latest version of node that we can confirm works with our set-up is v15.14.0.
To start Eleventy, simply enter the following. (You may choose any network port on your system that is available; 8011 is just a suggestion.)
npx @11ty/eleventy --serve --port=8011
This project is coded with, among other things:
_src/
. The root folder is only for compiled output for deployment.content
block. If you are updating data, be sure you understand how it will be consumed..pug
file, which Eleventy will turn into HTML. If you are making another type of change, you may need to read Pug documentation (which is excellent, by the way!)..scss
partial and import it into the main stylesheet. (Make sure to namespace it the same way the others are.)*-budget-flow.pug
pages and update the content blocks as necessary.data/flow
directory. Follow the naming convention seen there or your files won't load properly. You also will need to point your page at the appropriate files as seen in the get_datafiles
content block.*-budget-tree.pug
pages and update the content blocks as necessary.data/tree/
directory following the naming convention seen in the existing files.datafiles
content block with the appropriate metadata and file path for the data files you generated._src/js/compare/
and are are bundled with Webpack.yarn
to install all the necessary node dependencies and yarn run watch
to watch the source files for changes and rebuild the asset bundles accordingly.Make changes and review them on your local development site. If everything looks good, push your changes to your personal fork and merge the commit(s) into your main branch. Finally, issue a pull request and we'll take it from there!
1) Create a pull request from your forked repo to the main branch of the upstream project and 2) just tell an admin of the upstream repo that your work is ready for review. Your changes will then be reviewed, tested, and (if everything looks good) pushed into the master branch.
Changes pushed to the main branch of the (original) repo will use GitHub Actions to trigger a continuous integration process that (among other things):