Skip to content

Latest commit

 

History

History
64 lines (42 loc) · 1.51 KB

README.md

File metadata and controls

64 lines (42 loc) · 1.51 KB
Raw

OrcaUI (dev) 🚧

This project is the UI representation of our OrcaBus project.

Currently, this project is still in development.

Development

API Types Generator

We utilize OpenAPI Typescript to generate TypeScript types from the OpenAPI schema. To generate new types or update existing ones, run the following command:

make generate-openapi-types

Running Frontend locally

Prerequisite

  • Node.js with Yarn
  • Docker (for API run locally)
  • Active AWS SSO login session (e.g. aws sso login --profile dev && export AWS_PROFILE=dev)
$ node --version
v20.15.0

#  run 'corepack enable' to activate corepack
$ corepack -v
0.20.0

Install the dependencies (precommit will be installed)

$ make install

$ pre-commit --version
pre-commit 3.7.0

Start Front-end Development Server

make start

Run Orcabus API Locally

For Run Orcabus API Locally, please refer Running API Locally

The APIs will run on localhost with the following port assignments:

Microservice Local Endpoint
Metadata Manager http://localhost:8100
Workflow Manager http://localhost:8200
Sequence Run Manager http://localhost:8300
File Manager http://localhost:8400

Deployment

Please the the README.md in the ./deploy directory.