https://github.com/torontojs/tojs-styleguide

The TorontoJS style guide in it's 3rd evolution with assets, palette, logo and vectors, and a dynamic social media card generator!
https://github.com/torontojs/tojs-styleguide

Last synced: 9 days ago
JSON representation

The TorontoJS style guide in it's 3rd evolution with assets, palette, logo and vectors, and a dynamic social media card generator!

• Host: GitHub
• URL: https://github.com/torontojs/tojs-styleguide
• Owner: torontojs
• Created: 2015-06-11T15:54:50.000Z (over 9 years ago)
• Default Branch: main
• Last Pushed: 2024-01-13T20:50:55.000Z (10 months ago)
• Last Synced: 2024-11-01T03:12:20.672Z (17 days ago)
• Language: TypeScript
• Homepage: https://madcampos.dev/tojs-styleguide/
• Size: 6.76 MB
• Stars: 0
• Watchers: 8
• Forks: 4
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# 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](https://volta.sh/) globally

## Run locally

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

```shell

$ 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:

```shell

$ npm run lint

```

## Build project

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

```shell

$ npm run build

```

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

## Test project

```shell

$ npm run test

```