Docs tweaks (#2160)

* Tweaks

* Add ecosystem. Add bunx. Flesh out install.

* Tweaks

* Add TS to installation

* Tweaks

* New readme

* Write new readme

* Tweak

* Center header

* Bun

* tweaks

* No dollar sign

* Fix links

* Update

* Tweak
This commit is contained in:
Colin McDonnell
2023-02-24 16:33:53 -08:00
committed by GitHub
parent 1d85b5efa8
commit 1836250542
18 changed files with 444 additions and 5437 deletions

37
docs/ecosystem/express.md Normal file
View File

@@ -0,0 +1,37 @@
Projects that use Express and other major Node.js HTTP libraries should work out of the box.
{% callout %}
If you run into bugs, [please file an issue](https://bun.sh/issues) *in Bun's repo*, not the library. It is Bun's responsibility to address Node.js compatibility issues.
{% /callout %}
```ts
import express from "express";
const app = express();
const port = 8080;
app.get("/", (req, res) => {
res.send("Hello World!");
});
app.listen(port, () => {
console.log(`Listening on port ${port}...`);
});
```
Bun implements the [`node:http`](https://nodejs.org/api/http.html) and [`node:https`](https://nodejs.org/api/https.html) modules that these libraries rely on. These modules can also be used directly, though [`Bun.serve`](/docs/api/http) is recommended for most use cases.
{% callout %}
**Note** — Refer to the [Runtime > Node.js APIs](/docs/runtime/nodejs#node_http) page for more detailed compatibility information.
{% /callout %}
```ts
import * as http from "node:http";
http
.createServer(function (req, res) {
res.write("Hello World!");
res.end();
})
.listen(8080);
```