bcgov / eagle-admin

Admin site project for management of EPIC

Related projects

Eagle is a revision name of the EAO EPIC application suite.

These projects comprise EAO EPIC:

• https://github.com/bcgov/eagle-api
• https://github.com/bcgov/eagle-public
• https://github.com/bcgov/eagle-admin
• https://github.com/bcgov/eagle-mobile-inspections
• https://github.com/bcgov/eagle-reports
• https://github.com/bcgov/eagle-helper-pods
• https://github.com/bcgov/eagle-dev-guides

Pre-requisites

Note: The following commands work in MacOS bash (not zsh which now default in Catalina). The scripts are currently not fully working in Windows and Linux, so you may need to look at the source of the scripts and manually apply the commands in a right order.

Run the following two scripts to create your environment

#!/bin/bash
.\install_prerequisites.sh

#!/bin/bash
.\setup_project.sh

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. Run npm start to start the webpack server to run the application on port 4200.

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

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

3. Run npm run build to just 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.

4. Run npm run lint to just lint your app code using TSLint.

Pull Request Pipeline

The EPIC project is built with a Pull Request based pipeline, a full set of builds and deployments will be created in Openshift. A status badge will be updated with a live link to the deployment when the Pull Request has been built and deployed.

To link PR deployments for features or related code across eagle repositories (admin, public, and api) the branch names for each pull request MUST be the same in each of the repositories.

PR Cleanup

Before closing/merging a pull request the deployment should be cleaned up using the clean-up stage in Jenkins. Alternately a manual cleanup script can be used and is described in the eagle-helper-pods setup and teardown readme

A full description and guide to the EPIC pipeline and branching strategy is available in the eagle-dev-guides repository.

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.

Build and Deployment

For dev, test, and production builds on OpenShift/Jenkins see openshift/README.md for detailed instructions on how to setup in an OpenShift environment using nginx.

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-admin/pull/new/develop