Skip to content

Update README with deploy steps #314

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
merged 2 commits into from
Feb 2, 2021
Merged

Update README with deploy steps #314

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3c558c6
docs: update README with deploy steps
landonreed Jan 22, 2021
d258240
docs(README): update deploy instructions
landonreed Jan 28, 2021
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
15 changes: 15 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,21 @@ Install the dependencies and start a local instance using the following script:
yarn start
```

## Deploying the UI

1. Build the js/css bundle by running `yarn build`. The build will appear in the `dist/` directory).
2. Modify the `index.html` to point to `dist/index.js` (instead of `example.js`).
3. Upload the following files to wherever you're deploying the UI:
- `index.html` (modified to point to `dist/index.js`)
- `example.css`
- `dist/`
- `index.js`
- `index.js.map`
- `index.css`
- `index.css.map`

Note: only contents produced during build in the `dist/` directory are likely to change over time (the `index.html` and `example.css` files contain minimal code), so subsequent deployments will typically only need to replace the `dist/` contents.

## Library Documentation

More coming soon...
Expand Down