Skip to content

Commit

Permalink
feat(README): edit readme
Browse files Browse the repository at this point in the history
  • Loading branch information
aldbr committed May 16, 2024
1 parent fd35826 commit db37351
Showing 1 changed file with 19 additions and 14 deletions.
33 changes: 19 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,33 +1,37 @@
![Basic tests](https://github.com/DIRACGrid/diracx-web/actions/workflows/basic.yml/badge.svg?branch=main)
![Basic tests](https://github.com/DIRACGrid/diracx-web/actions/workflows/test.yml/badge.svg?branch=main)
![Basic tests](https://github.com/DIRACGrid/diracx-web/actions/workflows/containerised.yml/badge.svg?branch=main)
![Unit tests](https://github.com/DIRACGrid/diracx-web/actions/workflows/test.yml/badge.svg?branch=main)
![Integration tests](https://github.com/DIRACGrid/diracx-web/actions/workflows/integration-test.yml/badge.svg?branch=main)
![Deployment](https://github.com/DIRACGrid/diracx-web/actions/workflows/deployment.yml/badge.svg?branch=main)

# DiracX-Web Prototype
# DiracX-Web

## Getting started

This will allow you to run a demo setup.
_Requirements: docker, internet_

The code changes will be reflected in the demo.

Requirement: docker, internet
This will allow you to run a demo setup:

```bash
# Clone the diracx repository
git clone git@github.com:DIRACGrid/diracx.git
# Clone the diracx-chart repository
git clone git@github.com:DIRACGrid/diracx-charts.git

# Run the demo
diracx-charts/run_demo.sh
```

You can also start the demo setup in development mode - code changes will be reflected in the demo in real time:

```bash
# Clone the diracx-web repository
git clone git@github.com:DIRACGrid/diracx-web.git

# Clone the diracx-chart repository
git clone git@github.com:DIRACGrid/diracx-charts.git

# Run the demo
diracx-charts/run_demo.sh diracx/ diracx-web/
diracx-charts/run_demo.sh ./diracx-web
```

Open [http://localhost:8000](http://localhost:8000) with your browser to see the result.

## Contributing

- Want to report a bug?
Expand All @@ -46,13 +50,14 @@ Open [http://localhost:8000](http://localhost:8000) with your browser to see the

Unit tests can be started with:

```
```bash
npm test
```

End-to-end tests are launched through `cypress` such as:

```
```bash
# diracx-charts/run_demo.sh is running
npx cypress open --config baseUrl=$DIRACX_URL
```

Expand Down

0 comments on commit db37351

Please sign in to comment.