Skip to content

Commit bbc58db

Browse files
authored
docs: update readme to refer to next.js app and integrate explorer readme (#4156) (#4159)
1 parent 8a7eeb8 commit bbc58db

File tree

2 files changed

+16
-97
lines changed

2 files changed

+16
-97
lines changed

README.md

+16-32
Original file line numberDiff line numberDiff line change
@@ -1,57 +1,41 @@
11
# HCA Data Browser
22

3-
The HCA Data Browser is an [AngularJs](http://angular.io), built with the [Angular CLI tool](https://github.com/angular/angular-cli).
3+
The HCA Data Browser is built using [Next.js](https://nextjs.org/).
44

5-
6-
7-
8-
[git-secrets]: https://github.com/awslabs/git-secrets
9-
10-
115
## Development Environment Setup
126

137
## Prerequisites
148

15-
1. node 14.16.0
16-
1. npm 6.14.11
17-
1. [git-secrets] must be installed
9+
Node.js 20.10.0 is required to run the app.
1810

1911
### 1. Clone the Repo
2012

21-
git clone https://github.com/HumanCellAtlas/data-browser.git [folder_name]
22-
23-
13+
git clone https://github.com/DataBiosphere/data-browser.git [folder_name]
2414

2515
### 2. Install Client-Side Dependencies
2616

27-
28-
npm install -g angular-cli
29-
30-
Navigate to the `spa` directory and install client-side dependencies.
17+
Navigate to the `explorer` directory and install client-side dependencies.
3118

3219
npm install
3320

3421
### 3. Development Server
3522

36-
To start the Angular development server, run the following from the `spa` directory:
37-
38-
npm start
23+
To start the development server, run the following from the `explorer` directory:
3924

40-
You can hit the server at `http://localhost:4200`.
25+
npm run dev:hca-dcp
4126

27+
You can hit the server at `http://localhost:3000`.
4228

43-
### 4. Install git-secrets
29+
## End-to-end tests
4430

45-
If you have push access to the remote, you'll need to install [git-secrets],
46-
enable the commit hooks for it and configure patterns for AWS and Google:
31+
This project has end-to-end tests powered by Playwright, currently only for the `anvil-cmg` configuration and in progress for `anvil-catalog`. To run tests, run `npm run test:anvil-cmg` from the `explorer` folder. Tests will also run by default on pull request.
4732

48-
```
49-
git secrets --install
50-
git secrets --register-aws
51-
git secrets --add '[-]----BEGIN.PRIVATE.KEY-----'
52-
```
53-
## Deployment
54-
The deployment runbook can be accessed [here](https://allspark.dev.data.humancellatlas.org/dcp-ops/docs/wikis/Data-Browser-Runbook)
33+
When updating tabs and columns on the anvil-cmg configuration, please update `explorer/e2e/anvil/anvil-tabs.ts` to reflect the changes
5534

35+
## Refresh CellXGene projects in HCA Data Explorer
36+
To update HCA scripts in the HCA Data Explorer, navigate to the `explorer` directory and run:
37+
```bash
38+
npm run get-cellxgene-projects-hca
39+
```
40+
This will save any updates to `explorer/site-config/hca-dcp/dev/scripts/out/cellxgene-projects.json` based on HCA links provided by CELLxGENE.
5641

57-

explorer/README.md

-65
This file was deleted.

0 commit comments

Comments
 (0)