We Count

The source files for the We Count website, built with Eleventy.

Getting Started

To contribute, please be sure to review our development processes as documented in the contributing guide.

To work on the project, you need to install NodeJS and NPM for your operating system.

Then, clone the project from GitHub. Create a fork with your GitHub account, then enter the following in your command line (make sure to replace your-username with your username):

git clone https://github.com/your-username/wecount.inclusivedesign.ca.git

From the root of the cloned project, enter the following in your command line to install dependencies:

npm ci

How to Run

To run the website in local development mode that supports a live reload at file changes, enter the following in your command line:

npm run start

How to Test

To lint JavaScript, CSS and Markdown files in the project (including JavaScript and CSS in Vue components), enter the following in the command line:

npm run lint

We use the following lint configurations:

• TODO: ESLint (JS)
• Stylelint (CSS/SCSS)
• MarkdownLint (Markdown)

How to Build

To build a static version of the website, enter the following in your command line:

npm run build

How to Deploy

This repository is connected to Netlify, and commits will be automatically deployed as follows:

• Pull request #175 (for example): https://deploy-preview-175--wecount.netlify.app
• Branch dev: https://dev--wecount.netlify.app
• Branch master: https://wecount.inclusivedesign.ca

License

This work is licensed under a Creative Commons Attribution 4.0 International License.