-
Notifications
You must be signed in to change notification settings - Fork 8
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: Update introductory text and README.
- Loading branch information
Showing
2 changed files
with
14 additions
and
52 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,53 +1,11 @@ | ||
# Mosaic Framework Examples | ||
# Mosaic + Framework Examples | ||
|
||
This is an [Observable Framework](https://observablehq.com/framework) project. To start the local preview server, run: | ||
This site shares examples of integrating [Mosaic](https://uwdata.github.io/mosaic) and DuckDB into [Observable Framework](https://observablehq.com/framework). | ||
|
||
``` | ||
npm run dev | ||
``` | ||
**[View the deployed examples](https://uwdata.github.io/mosaic-framework-example)** | ||
|
||
Then visit <http://localhost:3000> to preview your project. | ||
The examples demonstrate: | ||
|
||
For more, see <https://observablehq.com/framework/getting-started>. | ||
|
||
## Project structure | ||
|
||
A typical Framework project looks like this: | ||
|
||
```ini | ||
. | ||
├─ docs | ||
│ ├─ components | ||
│ │ └─ timeline.js # an importable module | ||
│ ├─ data | ||
│ │ ├─ launches.csv.js # a data loader | ||
│ │ └─ events.json # a static data file | ||
│ ├─ example-dashboard.md # a page | ||
│ ├─ example-report.md # another page | ||
│ └─ index.md # the home page | ||
├─ .gitignore | ||
├─ observablehq.config.ts # the project config file | ||
├─ package.json | ||
└─ README.md | ||
``` | ||
|
||
**`docs`** - This is the “source root” — where your source files live. Pages go here. Each page is a Markdown file. Observable Framework uses [file-based routing](https://observablehq.com/framework/routing), which means that the name of the file controls where the page is served. You can create as many pages as you like. Use folders to organize your pages. | ||
|
||
**`docs/index.md`** - This is the home page for your site. You can have as many additional pages as you’d like, but you should always have a home page, too. | ||
|
||
**`docs/data`** - You can put [data loaders](https://observablehq.com/framework/loaders) or static data files anywhere in your source root, but we recommend putting them here. | ||
|
||
**`docs/components`** - You can put shared [JavaScript modules](https://observablehq.com/framework/javascript/imports) anywhere in your source root, but we recommend putting them here. This helps you pull code out of Markdown files and into JavaScript modules, making it easier to reuse code across pages, write tests and run linters, and even share code with vanilla web applications. | ||
|
||
**`observablehq.config.ts`** - This is the [project configuration](https://observablehq.com/framework/config) file, such as the pages and sections in the sidebar navigation, and the project’s title. | ||
|
||
## Command reference | ||
|
||
| Command | Description | | ||
| ----------------- | -------------------------------------------------------- | | ||
| `npm install` | Install or reinstall dependencies | | ||
| `npm run dev` | Start local preview server | | ||
| `npm run build` | Build your static site, generating `./dist` | | ||
| `npm run deploy` | Deploy your project to Observable | | ||
| `npm run clean` | Clear the local data loader cache | | ||
| `npm run observable` | Run commands like `observable help` | | ||
- Visualization and real-time interaction with massive data sets | ||
- Using Mosaic and DuckDB-WASM within Framework pages | ||
- Using DuckDB within a data loader and configuring GitHub Actions |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters