Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

doc: improve website README #1081

Merged
merged 2 commits into from
Feb 22, 2024
Merged

doc: improve website README #1081

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1d5929e
doc: improve website README
corneliusroemer Feb 22, 2024
3e81f42
Update website/README.md
corneliusroemer Feb 22, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 9 additions & 8 deletions website/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,9 @@ cp .env.example .env

### Local Development

* Install packages: `npm install`
* Generate config files for local testing (requires Helm installed): `../generate_local_test_config.sh`
* Run `npm run start` to start a local development server with hot reloading.
- Install packages: `npm install`
- Generate config files for local testing (requires Helm installed): `../generate_local_test_config.sh`
- Run `npm run start` to start a local development server with hot reloading.

### Unit Tests

Expand All @@ -30,7 +30,7 @@ Run `npm run e2e` to execute the end-to-end tests.
If you run Playwright for the first time, you might need to run `npx playwright install`
and `npx playwright install-deps` first. Playwright will tell you if that's the case.

(!) Note: The e2e tests require a running LAPIS instance with test data. This will be prepared automatically, when the LAPIS instance is empty and otherwise skipped. Some e2e tests assume, this prepared data was the first data to be released. If you run the e2e tests for the first time on a LAPIS instance with existing data that is _NOT_ the prepared data, tests will fail ,and you need to delete the data first.
(!) Note: The e2e tests require a running LAPIS instance with test data. This will be prepared automatically, when the LAPIS instance is empty and otherwise skipped. Some e2e tests assume, this prepared data was the first data to be released. If you run the e2e tests for the first time on a LAPIS instance with existing data that is _NOT_ the prepared data, tests will fail ,and you need to delete the data first.

### Running The Application

Expand All @@ -44,9 +44,10 @@ See `.env.docker` for the required variables.

Furthermore, the website requires config files that need to be present at runtime in the directory
specified in the `CONFIG_DIR` environment variable:
* `config.json`: Contains configuration on the underlying organism. It's similar to the database config file that LAPIS uses.
* `reference_genomes.json`: Defines names for segments of the genome and amino acids. It's equal to the file that LAPIS uses.
* `runtime_config.json`: Contains configuration that specific for a deployed instance of the website.

- `config.json`: Contains configuration on the underlying organism. It's similar to the database config file that LAPIS uses.
- `reference_genomes.json`: Defines names for segments of the genome and amino acids. It's equal to the file that LAPIS uses.
- `runtime_config.json`: Contains configuration that specific for a deployed instance of the website.

Check our tests and examples for working config files.

Expand All @@ -66,7 +67,7 @@ If the environment variable LOG_DIR is set, it will also store them in `LOG_DIR/
- Install node version from `.nvmrc` with `nvm install`

### General tips

- Available scripts can be browsed in [`package.json`](./package.json) or by running `npm run`
- For VS code, use the ESlint extension which must be configured with `"eslint.workingDirectories": ["./website"],` in the settings.json
- Tips & Tricks for using icons from MUI https://mui.com/material-ui/guides/minimizing-bundle-size/
Loading