Skip to content

Commit 2dd8777

Browse files
committed
Add dome-ml-osai-ui website project readme info
1 parent 8658ea3 commit 2dd8777

1 file changed

Lines changed: 45 additions & 0 deletions

File tree

README.md

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -74,3 +74,48 @@ This repository's structure and documentation approach draw inspiration from, an
7474
## OSAI AI Ecosystem Content Exchange Acknowledgements – FAIRsharing
7575

7676
This repository's AI ecosystem components YAML file has been extended with content exchange through partnership with the [FAIRsharing AI Resource Collection](https://fairsharing.org/7193). FAIRsharing can be cited from its Nature Biotechnology publication [doi.org/10.1038/s41587-019-0080-8](https://www.nature.com/articles/s41587-019-0080-8): Sansone, SA., McQuilton, P., Rocca-Serra, P. et al. FAIRsharing as a community approach to standards, repositories and policies. Nat Biotechnol 37, 358–367 (2019).
77+
78+
---
79+
80+
## OSAI Ecosystem UI (Web Interface)
81+
82+
This repository includes the **dome-ml-osai-ui**, a web-based user interface designed to interact with the OSAI ecosystem. It is an Angular application located in the `dome-ml-osai-ui/` subdirectory.
83+
84+
### Prerequisites
85+
* **Node.js** and **npm** installed.
86+
* **Angular CLI** (optional, but recommended).
87+
88+
### Getting Started with the UI
89+
90+
1. **Navigate to the UI directory:**
91+
```bash
92+
cd dome-ml-osai-ui
93+
```
94+
95+
2. **Install Dependencies:**
96+
Use `npm ci` to install dependencies as specified in the lock file to avoid breaking changes.
97+
```bash
98+
npm ci
99+
```
100+
101+
3. **Run the Development Server:**
102+
```bash
103+
npm start
104+
# OR
105+
ng serve
106+
```
107+
Navigate to `http://localhost:4200/` in your browser. The application will automatically reload if you change any of the source files.
108+
109+
### Building for Production
110+
111+
To build the project for deployment:
112+
```bash
113+
ng build --prod
114+
```
115+
The build artifacts will be stored in the `dist/` directory within the `dome-ml-osai-ui` folder.
116+
117+
### Data Synchronization
118+
The UI includes a script to pull the latest YAML data from the main repository:
119+
```bash
120+
python3 scripts/update_yaml.py
121+
```

0 commit comments

Comments
 (0)