2022-02-02 08:19:59 -08:00
|
|
|
# Drift documentation
|
2019-08-01 11:56:23 -07:00
|
|
|
|
2022-02-02 08:19:59 -08:00
|
|
|
Welcome to the source of drift's documentation, live at drift.simonbinder.eu.
|
2021-03-12 12:14:45 -08:00
|
|
|
We use a static site generator based on `build_runner` to build the documentation.
|
2019-08-01 11:56:23 -07:00
|
|
|
|
|
|
|
|
## Running the website locally
|
2021-03-12 12:14:45 -08:00
|
|
|
|
|
|
|
|
For a fast edit-refresh cycle, run
|
|
|
|
|
|
2019-08-01 11:56:23 -07:00
|
|
|
```
|
2022-10-25 13:15:09 -07:00
|
|
|
dart run build_runner serve web:8080 --live-reload
|
2021-03-12 12:14:45 -08:00
|
|
|
```
|
|
|
|
|
|
|
|
|
|
## Building the website
|
|
|
|
|
|
2022-10-25 13:15:09 -07:00
|
|
|
To build the website into a directory `out`, use:
|
2021-03-12 12:14:45 -08:00
|
|
|
|
|
|
|
|
```
|
2023-09-17 09:10:49 -07:00
|
|
|
dart run drift_dev schema steps lib/snippets/migrations/exported_eschema/ lib/snippets/migrations/schema_versions.dart
|
|
|
|
|
dart run drift_dev schema generate --data-classes --companions lib/snippets/migrations/exported_eschema/ lib/snippets/migrations/tests/generated_migrations/
|
|
|
|
|
|
2021-03-12 12:14:45 -08:00
|
|
|
dart run build_runner build --release --output web:out
|
|
|
|
|
```
|
