Skip to content

Commit bd802a1

Browse files
authored
Create README.md
1 parent ab7f590 commit bd802a1

File tree

1 file changed

+6
-1
lines changed

1 file changed

+6
-1
lines changed

seqr/README.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
This directory defines an updated set of APIs and database tables that are used by the React.js-based UI.
2+
Currently this new UI is maintained in parallel with the existing seqr UI, and metadata is stored in both the new
3+
`seqr/models.py` and original `xbrowse_server/base/models.py`. See the **Migrating Existing Data** section below for steps to sync metadata from the original tables defined in `xbrowse_server/base/models.py` to the new tables in `seqr/models.py`.
4+
5+
16
**Testing**
27

38
To run server-side django tests:
@@ -69,7 +74,7 @@ psql xwiki < <(gunzip -c xwiki_backup_*.txt.gz)
6974

7075
**Migrating Existing Data to the New Database Schema and UI**
7176

72-
Running the following 2 commands will copy metadata from the original database tables that are used by the current UI into the new tables that are used by the new API and React.js-based UI:
77+
Running the following 2 commands will copy metadata from the original tables defined in `xbrowse_server/base/models.py` to the new tables in `seqr/models.py`. This is necessary to enable the new APIs in `seqr/` along with the new React.js-based UI that's accessible through the `<seqr-url>/dashboard` page. While API refactoring is ongoing and both the original and new UIs are in use, we run these sync steps every 24 hours.
7378

7479
```
7580
python2.7 -m manage transfer_gene_lists

0 commit comments

Comments
 (0)