Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
ctriant committed Jun 1, 2022
1 parent 54c6a6d commit 95188eb
Showing 1 changed file with 47 additions and 3 deletions.
50 changes: 47 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,53 @@
# Argo Status Pages

A ReactJS application that facilitates the presentation of the status of selected services.

### Installation
## Configuration

## Development mode
The argo-status-pages application provides a simple way to configure connection and appearence parameters through the `config.json` file. For example:

```json
{
"services": {
"Service_A": {
"fullname": "Service A",
"category": "Category A"
},
"Service_B": {
"fullname": "Service B",
"category": "Category A"
}
},
"service_categories": {
"Category A": ["Service_A", "Service_B"]
},
"ngi_categories": {
"Service_A": "Service_A",
"Service_B": "Service_B"
},
"api": {
"endpoint": "api.devel.example.com",
"reportName": "CORE"
},
"title": "Test Status Page",
"copyright": "Copyright 2022 - All rights reserved",
"theme": {
"header-gradient-color-start": "#05cae7",
"header-gradient-color-end": "#000",
"footer-gradient-color-start": "#05cae7",
"footer-gradient-color-end": "#000",
"footer-copyright-text-color": "#fff"
}
}
```

The `public` directory of the project may host specific assets such as the `favicon.ico`, the `logo.svg` or the `footer_logo.svg`.
In addition to the image assets, a `.env` file may exist on the `public` directory that will define the `REACT_APP_TITLE`
variable for the argo-status-pages title.

## Installation

### Development mode

1. `git clone https://github.com/ARGOeu/argo-status-pages.git`
2. `cd argo-status-pages`
Expand All @@ -16,7 +60,7 @@ Open http://localhost:3000 to view it in your browser.
The page will reload when you make changes.
You may also see any lint errors in the console.

## Production mode
### Production mode

1. `git clone https://github.com/ARGOeu/argo-status-pages.git`
2. `cd argo-status-pages`
Expand Down

0 comments on commit 95188eb

Please sign in to comment.