Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hmcts/darts-portal
https://github.com/hmcts/darts-portal
jenkins-sds
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/hmcts/darts-portal
- Owner: hmcts
- License: mit
- Created: 2023-03-21T11:29:46.000Z (almost 2 years ago)
- Default Branch: master
- Last Pushed: 2024-10-29T10:53:02.000Z (2 months ago)
- Last Synced: 2024-10-29T10:56:59.659Z (2 months ago)
- Topics: jenkins-sds
- Language: TypeScript
- Homepage:
- Size: 777 MB
- Stars: 2
- Watchers: 11
- Forks: 0
- Open Issues: 18
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# DARTS portal
This is primarily an Angular app that runs through a node.js server. There are four main reasons for the node.js express server
- to serve the angular app when deployed in Kubernetes
- to proxy API requests to internally-facing backend API services, such as the DARTS API
- to handle auth / user session
- to provide a stubbed API for development
## Getting Started
### Prerequisites
Running the application requires the following tools to be installed in your environment:
- [Node.js](https://nodejs.org/) v20.0.0 or later
- [yarn](https://yarnpkg.com/) v3
- [Docker](https://www.docker.com)(optional)
### Install Dependencies
Install dependencies by executing the following command:
```bash
yarn
```
### Local Development Strategies
There are four different ways to develop locally:
## 1. API Stub
To run darts-portal against node.js API stub:
```bash
yarn dev:darts-api-stub
```
## 2. Staging environment
To run darts-portal against staging API:
```bash
yarn dev:darts-api-stg
```
## 3. Demo environment
To run darts-portal locally against demo API:
```bash
yarn dev:darts-api-demo
```
## 4. Local darts-portal with local darts-api
To run darts-portal Angular & node.js frontend with [darts-api](https://github.com/hmcts/darts-api):
```bash
yarn dev
```
The applications's home page will be available at https://localhost:3000.
Note this is running both node.js and Angular and expects the ([darts-api](https://github.com/hmcts/darts-api)) to also be running locally to function correctly
## Build
Run `yarn:build` to build the project. The build artifacts will be stored in the `dist/` directory. This compiles both the node.js server-side code and angular code.
## Code style
We use [ESLint](https://github.com/typescript-eslint/typescript-eslint) and [Prettier](https://prettier.io/)
Running the linting:
```bash
yarn lint
```
You can fix prettier formatting issues using:
```bash
yarn prettier:fix
```
## Running unit/integration tests
Run `yarn test` or `yarn test:watch` to execute the unit tests via [Jest](https://jestjs.io/).
`--silent` flag reduces noise in console when running tests.
## Running end-to-end tests
Run `yarn test:functional` to execute the end-to-end tests using Cypress, this includes accessibility checks via axe-core (WCAG22AA standards).
Run `yarn cypress` to open the cypress console, very useful for debugging tests.
## Angular code scaffolding
Run `yarn ng generate component component-name` to generate a new component. You can also use `yarn ng generate directive|pipe|service|class|guard|interface|enum|module`.
Note the requirement for prefixing the `ng` commands with `yarn`