This section will walk you through setting up the repository on your computer.
If you don’t already have a GitHub account, you’ll need to create a new one.
A "fork" is a copy of a repository in your personal GitHub account. "Cloning" is the process of getting the repository’s source code on your computer.
GitHub has a guide for forking a repo. To fork can-symbol, you can start by going to its fork page.
Next, you’ll want to clone the repo. GitHub’s cloning guide explains how to do this on Linux, Mac, or Windows.
GitHub’s guide will instruct you to clone it with a command like:
git clone https://github.com/YOUR-USERNAME/can-symbolMake sure you replace YOUR-USERNAME with your GitHub username.
After you’ve forked & cloned the repository, you’ll need to install the project’s dependencies.
First, make sure you’ve installed Node.js and npm.
If you just cloned the repo from the command line, you’ll want to switch to the folder with your clone:
cd can-symbolNext, install the project’s dependencies with npm:
npm installRun the following to start a dev server:
npm run developYou can manually run this repository’s tests in any browser by starting the dev server (see the section above) and visiting this page: http://localhost:8080/test/test.html
Firefox is used to run the repository’s automated tests from the command line. If you don’t already have it, download Firefox. Mozilla has guides for installing it on Linux, Mac, and Windows.
After Firefox is installed, you can run:
npm testRun the following command to create a build:
npm run buildThis will create a dist/ folder that contains the AMD, CommonJS, and global module versions of the project.
To generate the docs:
npm run documentThis will create a docs/ folder that contains a browsable site with all of your documentation.
With the dev server running, you can view the docs at http://localhost:8080/docs/