README.md

Community Privacy

Website for Community Privacy. Site uses al-folio template.

Run locally

$ bundle exec jekyll serve

Setup

1. Clone repo

$ git clone [email protected]:community-privacy/community-privacy.github.io.git

2. Local setup (As of 12/13/24, there is an error with the docker image on the forked repo.)

$ bundle install
# assuming pip is your Python package manager
$ pip install jupyter
$ bundle exec jekyll serve

3. Open your browser and go to http://localhost:4000.

For additional installation and deployment details please refer to INSTALL.md.

Code quality checks

Currently, we run some checks to ensure that the code quality and generated site are good. The checks are done using GitHub Actions and the following tools:

• Prettier - check if the formatting of the code follows the style guide
• lychee - check for broken links
• Axe (need to run manually) - do some accessibility testing

To set these up:

Prettier:

$ npm install --save-dev --save-exact prettier # Install prettier
$ npx prettier . --write # Run prettier

lychee: (This took too long to install for me lol so I skipped it personally... -RW)

$ brew install lychee # Install lychee
$ lychee . # Run lychee

Axe:

$ npm install axe-core --save-dev

Dev notes

For searching "SEARCH TERM": (remove quotes)

$ grep -r --exclude-dir=vendor --exclude-dir=_site --exclude-dir=assets --exclude-dir=node_modules --exclude-dir=lighthouse_results "SEARCH TERM"

Pushing Changes

Before pushing changes:

# Lint and prettify code
$ npx prettier --write .