diff --git a/bun/README-short.txt b/bun/README-short.txt new file mode 100644 index 0000000000000..867e4b7d89e9d --- /dev/null +++ b/bun/README-short.txt @@ -0,0 +1 @@ +Bun is a fast all-in-one JavaScript runtime, package manager, bundler, and test runner. \ No newline at end of file diff --git a/bun/content.md b/bun/content.md new file mode 100644 index 0000000000000..52e715c730bad --- /dev/null +++ b/bun/content.md @@ -0,0 +1,35 @@ +# What is Bun? + +Bun is an all-in-one toolkit for JavaScript and TypeScript apps. It ships as a single executable called `bun`​. + +At its core is the Bun runtime, a fast JavaScript runtime designed as a drop-in replacement for Node.js. It's written in Zig and powered by JavaScriptCore under the hood, dramatically reducing startup times and memory usage. + +​​The `bun`​ command-line tool also implements a test runner, script runner, and Node.js-compatible package manager, all significantly faster than existing tools and usable in existing Node.js projects with little to no changes necessary. + +> [Documentation](https://bun.sh/docs) + +%%LOGO%% + +# How to use this image + +## `Dockerfile` + +```dockerfile +FROM %%IMAGE%%:-debian + +COPY src src +COPY package.json package.json +COPY bun.lockb bun.lockb + +RUN bun install + +CMD ["src/index.ts"] +``` + +## `docker run` + +```sh +docker run --ulimit memlock=-1:-1 bun +``` + +> It is recommended to set the `--ulimit` flag to the value above to avoid unnecessary resource contention. diff --git a/bun/get-help.md b/bun/get-help.md new file mode 100644 index 0000000000000..98323e7ae7a4e --- /dev/null +++ b/bun/get-help.md @@ -0,0 +1 @@ +[the Bun Discord server](https://bun.sh/discord) diff --git a/bun/github-repo b/bun/github-repo new file mode 100644 index 0000000000000..3b434e0ab0daa --- /dev/null +++ b/bun/github-repo @@ -0,0 +1 @@ +https://github.com/oven-sh/bun diff --git a/bun/license.md b/bun/license.md new file mode 100644 index 0000000000000..1157456e9f1ae --- /dev/null +++ b/bun/license.md @@ -0,0 +1,3 @@ +Bun itself is MIT-licensed. + +Bun statically links with other software, which have [various](https://bun.sh/docs/project/licensing) licenses. diff --git a/bun/logo.png b/bun/logo.png new file mode 100644 index 0000000000000..f3929b40888c1 Binary files /dev/null and b/bun/logo.png differ diff --git a/bun/maintainer.md b/bun/maintainer.md new file mode 100644 index 0000000000000..d183bf15ccf12 --- /dev/null +++ b/bun/maintainer.md @@ -0,0 +1 @@ +[the Bun team](%%GITHUB-REPO%%) diff --git a/bun/variant-debian-slim.md b/bun/variant-debian-slim.md new file mode 100644 index 0000000000000..d162e3c2b55a5 --- /dev/null +++ b/bun/variant-debian-slim.md @@ -0,0 +1,3 @@ +## `%%IMAGE%%:-debian-slim` + +This image is based on the official [`debian:bullseye-slim`](https://hub.docker.com/_/debian) Docker image with `bun` built-in. diff --git a/bun/variant-debian.md b/bun/variant-debian.md new file mode 100644 index 0000000000000..8fdcb3b3c611b --- /dev/null +++ b/bun/variant-debian.md @@ -0,0 +1,3 @@ +## `%%IMAGE%%:-debian` + +This image is based on the official [`debian:bullseye`](https://hub.docker.com/_/debian) Docker image with `bun` built-in.