-
Notifications
You must be signed in to change notification settings - Fork 2.2k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
9 changed files
with
48 additions
and
0 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 |
---|---|---|
@@ -0,0 +1 @@ | ||
Bun is a fast all-in-one JavaScript runtime, package manager, bundler, and test runner. |
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 |
---|---|---|
@@ -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. |
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 |
---|---|---|
@@ -0,0 +1 @@ | ||
[the Bun Discord server](https://bun.sh/discord) |
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 |
---|---|---|
@@ -0,0 +1 @@ | ||
https://github.com/oven-sh/bun |
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 |
---|---|---|
@@ -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. |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
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 |
---|---|---|
@@ -0,0 +1 @@ | ||
[the Bun team](%%GITHUB-REPO%%) |
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 |
---|---|---|
@@ -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. |
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 |
---|---|---|
@@ -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. |