Check out the contribution guide on CanJS.com for information on:
- Code of Conduct
- Getting Help
- Project Organization
- Reporting Bugs
- Suggesting Features
- Finding Ways to Contribute
The rest of this guide has information that’s specific to this repository.
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-compile, 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-compile
Make 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-compile
Next, install the project’s dependencies with npm:
npm install
Run the following to start a dev server:
npm run develop
You 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 test
Run the following command to create a build:
npm run build
This will create a dist/
folder that contains the AMD, CommonJS, and global module versions of the project.