https://github.com/observablehq/framework-runtime
A Docker image optimized to build Framework images
https://github.com/observablehq/framework-runtime
Last synced: 2 months ago
JSON representation
A Docker image optimized to build Framework images
- Host: GitHub
- URL: https://github.com/observablehq/framework-runtime
- Owner: observablehq
- Created: 2024-03-29T23:12:03.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-09-25T21:01:18.000Z (9 months ago)
- Last Synced: 2025-03-28T11:51:08.745Z (3 months ago)
- Language: TypeScript
- Homepage:
- Size: 989 KB
- Stars: 18
- Watchers: 10
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# framework-runtime
This repository builds a Docker image suitable for building Observable Framework projects in.
It includes support for running Framework data loaders with the following languages and tools:
- Node 20
- Python 3.11
- R 4.4
- duckdb 1.0
- Rust 1.81
- Perl 5.36
## Usage
The image built from this repository is published on the GitHub container registry.
```
docker run -it ghcr.io/observablehq/framework-runtime
```
## Local development
To build and test the images locally, from this repository, run
```
yarn install
yarn build
```
This will install dependencies needed for the repository, and build the image.
To run the image, you can use the command
```
docker run -it observablehq/framework-runtime:latest bash
```
This will launch a shell in the runtime environment. From here you should be able to clone repositories, use `npm init @observablehq`, and otherwise interact with Framework projects. Not that after exiting the shell any files you worked with will be lost. Consider using [Docker Volumes](https://docs.docker.com/storage/volumes/) if you want a persistent environment.
There are automated tests that ensure that various commands and tools are available, and of the expected versions. To run those, use
```
yarn test
```