Skip to content

Commit

Permalink
New image: bun
Browse files Browse the repository at this point in the history
  • Loading branch information
Electroid committed Mar 17, 2023
1 parent 26e0400 commit 916d51b
Show file tree
Hide file tree
Showing 9 changed files with 48 additions and 0 deletions.
1 change: 1 addition & 0 deletions bun/README-short.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Bun is a fast all-in-one JavaScript runtime, package manager, bundler, and test runner.
35 changes: 35 additions & 0 deletions bun/content.md
Original file line number Diff line number Diff line change
@@ -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%%:<version>-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.
1 change: 1 addition & 0 deletions bun/get-help.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
[the Bun Discord server](https://bun.sh/discord)
1 change: 1 addition & 0 deletions bun/github-repo
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
https://github.com/oven-sh/bun
3 changes: 3 additions & 0 deletions bun/license.md
Original file line number Diff line number Diff line change
@@ -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.
Binary file added bun/logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions bun/maintainer.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
[the Bun team](%%GITHUB-REPO%%)
3 changes: 3 additions & 0 deletions bun/variant-debian-slim.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
## `%%IMAGE%%:<version>-debian-slim`

This image is based on the official [`debian:bullseye-slim`](https://hub.docker.com/_/debian) Docker image with `bun` built-in.
3 changes: 3 additions & 0 deletions bun/variant-debian.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
## `%%IMAGE%%:<version>-debian`

This image is based on the official [`debian:bullseye`](https://hub.docker.com/_/debian) Docker image with `bun` built-in.

0 comments on commit 916d51b

Please sign in to comment.