Skip to content

Add some local development instructions #78

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

Merged
zachmargolis merged 1 commit into from
Jan 23, 2023
Merged

Add some local development instructions #78

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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: 17 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,23 @@ npm install
npm run dev
```

View the application at http://localhost:3000/

### Viewing Reports with Local Data

Normally local development can view production data. However, when developing and interating
on a new report, you may want to test locally.

With the [development server running](#run-development-server)

1. Add query param `?env=local`
2. Drop report files into a `local` directory at the top of the repo
Copy link
Contributor

@aduth aduth Jan 23, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Where do report files come from?

Copy link
Contributor Author

@zachmargolis zachmargolis Jan 23, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

they come from various jobs in the IDP, like the DailyAuthsReport or DailyDropoffsReport but it depends on the page, unsure how to best document that?

Copy link
Contributor

@aduth aduth Jan 23, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I guess I'm most curious if there's some way I can generate those reports locally and copy them over from the IdP?

Copy link
Contributor Author

@zachmargolis zachmargolis Jan 23, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

local development usually doesn't have good enough data for these 😬 so I've run the queries against prod and generated the data

Copy link
Contributor

@aduth aduth Jan 23, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not a blocker if generating the data is not straightforward to document. The additions are already an improvement as-is 👍

File paths will need to match the production paths, so for example:
| environment | path |
|-------------|------|
| production | `/prod/daily-auths-report/2023/2023-01-15.daily-auths-report.json` |
| local | `/local/daily-auths-report/2023/2023-01-15.daily-auths-report.json` |

### Run Tests

```
Expand Down