We Count

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

Getting Started

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

Then, clone the project from GitHub. Enter the following in your command line:

git clone https://github.com/inclusive-design/wecount.inclusivedesign.ca.git

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

npm ci

How to Run

To run the website in local development mode, enter the following in your command line:

npm run dev

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

How to Build

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

nuxt generate

The static website's files will be in the newly-created dist directory in the root of the project.

How to Deploy

This repository is connected to Netlify. Updating the master branch will trigger a new build and deployment of the project to this temporary URL.

License

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