This repository has been archived by the owner on Feb 26, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 407
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs(developer): add developer notes and fix karma local run
Add very basic developer notes on how to test and submit changes. Fix the license info at the end of README.md. Fix the local karma config so it actually runs firefox. Closes #285
- Loading branch information
Showing
3 changed files
with
23 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
Submitting Changes | ||
------------------ | ||
|
||
Do NOT submit changes to the built files in the `dist` folder. These are generated before | ||
releases. | ||
|
||
|
||
To run tests | ||
------------ | ||
|
||
Make sure your environment is set up with: | ||
|
||
`npm install` | ||
|
||
In a separate process, run the WebSockets server: | ||
|
||
`node ./test/ws-server.ts` | ||
|
||
Run the tests using Karma: | ||
|
||
`npm test` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -308,4 +308,4 @@ zone.run(function() { | |
|
||
|
||
## License | ||
Apache 2.0 | ||
MIT |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters