8000 GitHub - bcgov/eagle-admin: EPIC Revision 2019 - Admin Frontend
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

bcgov/eagle-admin

Repository files navigation

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:

Pre-requisites

Before setting up the project, ensure you have Node.js 18 installed. We recommend using nvm (Node Version Manager) for easy Node.js version management.

To install nvm and Node.js 18 on Debian-based systems:

# Install nvm if you don't have it
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.7/install.sh | bash

# Load nvm (you may need to restart your terminal or run these commands)
export NVM_DIR="$HOME/.nvm"
[ -s "$NVM_DIR/nvm.sh" ] && \. "$NVM_DIR/nvm.sh"
[ -s "$NVM_DIR/bash_completion" ] && \. "$NVM_DIR/bash_completion"

# Install and use Node.js 18
nvm install 18
nvm use 18

# Verify Node.js version
node -v  # Should output v18.x.x

Once Node.js 18 is active, install project dependencies using Yarn:

yarn install

Build, Lint, Test, and Run

After installing Node.js 18 and project dependencies, you can use the following commands to work with the project:

Start the Development Server

yarn start

This will start the webpack development server on port 4200. Visit http://localhost:4200 to view the application.

Build the Project

yarn build

This will build the project for production. The build artifacts will be stored in the dist/ directory.

Lint the Code

yarn lint

This will lint your app code using ESLint and output any issues in a stylish format.

Run Unit Tests

yarn test

This will run the unit tests in watch mode using Karma and Jasmine.

To run tests once in a CI environment (headless):

yarn test-ci

CI/CD Pipeline

The EPIC project has moved away from PR based pipeline due to complexity and reliability concerns of the PR based pipeline implementation. The current CI/CD pipeline utilizes Github Actions to build Docker images and push them back into the BC Gov OpenShift Docker registry.

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

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

0