Skip to content

Commit

Permalink
Update frontend README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Ardem authored Sep 26, 2024
1 parent e8e421a commit ecc07d3
Showing 1 changed file with 16 additions and 9 deletions.
25 changes: 16 additions & 9 deletions ui/README.md
Original file line number Diff line number Diff line change
@@ -1,25 +1,32 @@
# Ylem. Frontend UI
# YLEM FRONTEND UI

## Installation & running
![Static Badge](https://img.shields.io/badge/React-18.3.1-black)
<a href="https://github.com/ylem-co/ylem?tab=Apache-2.0-1-ov-file">![Static Badge](https://img.shields.io/badge/license-Apache%202.0-black)</a>
<a href="https://ylem.co" target="_blank">![Static Badge](https://img.shields.io/badge/website-ylem.co-black)</a>
<a href="https://docs.ylem.co" target="_blank">![Static Badge](https://img.shields.io/badge/documentation-docs.ylem.co-black)</a>
<a href="https://join.slack.com/t/ylem-co/shared_invite/zt-2nawzl6h0-qqJ0j7Vx_AEHfnB45xJg2Q" target="_blank">![Static Badge](https://img.shields.io/badge/community-join%20Slack-black)</a>

### Dev environment
Ylem UI platform, connected to APIs provided by other microservices.

# Usage

## Dev environment

``` bash
$ docker-compose -f docker-compose-dev.yml up
$ docker compose -f docker-compose-dev.yml up
```

Ylem UI is available on http://127.0.0.1:7330/

### Production environment
## Production environment

``` bash
$ docker-compose -f docker-compose-prod.yml up
$ docker compose -f docker-compose.yml up
```

Ylem UI is available on http://127.0.0.1:7331/

Ylem UI is available on http://127.0.0.1:7440/

## ESLint
# ESLint

``` bash
$ eslint '**/*.js'
Expand Down

0 comments on commit ecc07d3

Please sign in to comment.