Skip to content
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.

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

docs(labware-library): remove description about webpack #15817

Merged
merged 3 commits into from
Jul 29, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 0 additions & 1 deletion labware-library/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,6 @@ dist:
# development assets server
.PHONY: dev
dev: export NODE_ENV := development
dev: export NODE_OPTIONS := --openssl-legacy-provider
dev:
vite serve --host=::

Expand Down
9 changes: 4 additions & 5 deletions labware-library/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ make -C labware-library all
make -C labware-library clean dist

# start a hot-reloading development server
# (optional) specify port with PORT; default is 8080
# (optional) specify port with PORT; default is 5173
make -C labware-library dev
make -C labware-library dev PORT=8081

Expand All @@ -53,11 +53,10 @@ make -C labware-library serve
make -C labware-library serve PORT=9091
```

### webpack setup
### vite setup

This project (along with our other front-end projects) uses [webpack][] to generate artifacts.
This project (along with our other front-end projects) uses [vite][] to generate artifacts.

- Extends our [base webpack config][base-config]
- Entry point is [`labware-library/src/index.tsx`][entry]
- [Handlebars][] HTML template is [`labware-library/src/index.hbs`][template]
- Post-build, the site is crawled and prerendered with [react-snap][]
Expand All @@ -68,10 +67,10 @@ This project (along with our other front-end projects) uses [webpack][] to gener
[handlebars]: https://handlebarsjs.com/
[css modules]: https://github.com/css-modules/css-modules
[react-snap]: https://github.com/stereobooster/react-snap
[base-config]: ../webpack-config
[entry]: ./src/index.js
[template]: ./src/index.hbs
[global-style]: ./src/global.module.css
[vite]: https://vitejs.dev/

### environment variables

Expand Down
Loading