Skip to content

Commit

Permalink
Update README with new run command and Running Tests section
Browse files Browse the repository at this point in the history
Signed-off-by: Bishoy Boktor <boktorbb@amazon.com>
  • Loading branch information
Bishoy Boktor committed Apr 8, 2021
1 parent 0d29050 commit c517fd1
Showing 1 changed file with 12 additions and 3 deletions.
15 changes: 12 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,6 @@ We officially began work on the new fork on January 21st, 2021. Since then, we'v

## What doesn’t works

* Jest Unit test cases
* Integration test cases
* Functional test cases
* 3rd party plugins (including OpenDistro)

Expand Down Expand Up @@ -49,9 +47,20 @@ Or

To run Dashboards with OpenSearch
* Run ```yarn osd bootstrap``` in the OpenSearch Dashboards directory
* While OpenSearch is running locally, run ```yarn start --oss```
* While OpenSearch is running locally, run ```yarn start```
* You can now navigate to ```http://localhost:5601``` where Dashboards runs by default

## Running tests

### Jest Unit Tests

Run the command ```yarn test:jest``` in the OpenSearch Dashboards project directory to run unit tests

### Jest Integration Tests

For the integration tests, you must pass the absolute path of your extracted OpenSearch build artifacts through the ```TEST_OPENSEARCH_FROM``` env variable so that Dashboards can run an OpenSearch cluster. You can run:
```TEST_OPENSEARCH_FROM=/path/to/extracted/build/artifact yarn test:jest_integration```

## How you can help

### Look for the label "help wanted"
Expand Down

0 comments on commit c517fd1

Please sign in to comment.