This section guides you through the steps required to set up your computer for developing CATcher.
Prerequisites:
node -v
in your OS terminal to check the version of Node on your computer)Recommended:
Steps:
npm install
npm run ng:serve:web
.Given below are different commands you can use to run the app locally.
Command | Description |
---|---|
npm run ng:serve:web | Start the app from the browser in development mode. |
If you are using Visual Studio Code to debug CATcher with Chrome, Firefox or Edge.
Refer to the Debugging Angular
section of this guide for a step-by-step walkthrough of the debugger setup.
In summary, the following steps are needed:
Debugger for Chrome
extension for VS Code. You can also install debugger extensions for Firefox and Edge.launch.json
) as shown in the guide. Particularly, set the url
attribute to http://localhost:4200
(reason: CATcher app is served locally on port 4200, by default.)npm run ng:serve:web
.CATcher documentation is hosted in a separate repo CATcher-org/catcher-org.github.io. When you need to update documentation, you'll need to fork and clone that repo to your computer as well.
We use MarkBind for documentation. Follow this tutorial to learn how to use MarkBind for updating project documentation.
These tasks assume a basic understanding of Angular
and TypeScript
.
If you wish to know more about them, you can visit our tools page.