eagle-public

Prerequisites

Node and NPM

Package	Version
Angular CLI	6.2.x
Yarn	>= 1.10.1
TSLint	>=5.11.0
TypeScript	>=2.3.4

We use a version manager so as to allow concurrent versions of node and other software. asdf is recommended.
Installation of asdf and required node packages is covered here

Fork, Build and Run

1. After installing Node and Yarn, you can fork or straight download a copy of this application to start your own app.

2. First download all the dependencies with yarn install.

3. Run npm start to start the webpack server to run the application on port 4300.

   Go to http://localhost:4300 to verify that the application is running.

   💡 To change the default port, open .angular-cli.json, change the value on defaults.serve.port.

4. Run npm run build to build the project. The build artifacts will be stored in the dist/ directory. Use the -prod flag for a production build, like so: ng serve --prod to run in production mode.

5. Run npm run lint to lint your app code using TSLint.

Angular Code scaffolding

A brief guide to Angular CLI's code scaffolding can be found in eagle-dev-guides

Testing

An overview of the EPIC test stack can be found in our documentation guides: EPIC Test Stack.

Instructions on how running tests unit tests and end-to-end tests can be found in our test documentation.

How to Contribute

Feel free to create pull requests from the default "develop" branch, click here to create one automatically: https://github.com/bcgov/eagle-public/pull/new/develop