Skip to content

Latest commit

 

History

History
45 lines (28 loc) · 966 Bytes

README.md

File metadata and controls

45 lines (28 loc) · 966 Bytes
Raw

Toronto JS Style Guide

This is the project for Toronto JS' Style Guide. It contains the documentation for how to use and create graphical assets for the community, following a set of guidelines.

Rquirements

  • Node.js v20.0.0 or higher
  • Install volta globally

Run locally

To run the project locally for development purposes, you will need to run the following commands:

$ npm i -D
$ npm start

They will install all dependencies and start the project in development mode.

Lint project

To push code to the repository you will need to pass linting on the whole project.

To lint the project run the following command:

$ npm run lint

Build project

When you are ready to build the project run the following command:

$ npm run build

It will generate a dist folder with the builded project ready to be deployed to a static site hosting.

Test project

$ npm run test