Skip to content

Commit

Permalink
Update README.md (#2930)
Browse files Browse the repository at this point in the history
  • Loading branch information
akintner authored Nov 19, 2024
1 parent 9b207b2 commit ac52542
Showing 1 changed file with 5 additions and 6 deletions.
11 changes: 5 additions & 6 deletions containers/ecr-viewer/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,23 +45,22 @@ For local development, if `NEXT_PUBLIC_NON_INTEGRATED_VIEWER` is not set equal t

## Potential Issues

If you have problems connecting your database run this command to see what other postgres databases are running
`sudo lsof -i :5432`
If you have problems connecting to your database, use this command to see what other postgres databases might be running
`sudo lsof -i :5432`. If anything is using that port, kill it using: `kill {pid}`

then kill it
`kill {pid}`
If building the Docker Image doesn't work as expected, try to first run the eCR Viewer locally using the steps below.

## Development

### Run eCR Viewer Locally
To run the eCR Viewer locally:

1. Ensure that both Git, Docker, and Node 18.x or higher are installed.
1. Ensure that Git, Docker, and Node (version 18.x or higher) are installed.
2. Clone the PHDI repository with `git clone https://github.com/CDCgov/phdi`.
3. Navigate to `/phdi/containers/ecr-viewer/`.
4. Install all of the Node dependencies for the eCR Viewer with `npm install`.
5. Setup your `.env.local` by running `npm run setup-local-env`.
6. Create seed data with `npm run convert-seed-data` - this will take ~10 minutes.
6. Create seed data with `npm run convert-seed-data` - this will take ~10 minutes. Note that this process will fail immediately if the Docker daemon isn't running.
7. Run the eCR Viewer on `localhost:3000` with `npm run local-dev`.

### Windows Setup
Expand Down

0 comments on commit ac52542

Please sign in to comment.