aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/guides/ecosystem/remix.md58
1 files changed, 58 insertions, 0 deletions
diff --git a/docs/guides/ecosystem/remix.md b/docs/guides/ecosystem/remix.md
new file mode 100644
index 000000000..510ce6a39
--- /dev/null
+++ b/docs/guides/ecosystem/remix.md
@@ -0,0 +1,58 @@
+---
+name: Build an app with Next.js and Bun
+---
+
+{% callout %}
+Remix currently relies on Node.js APIs that Bun does not yet implement. The guide below uses Bun to initialize a project and install dependencies, but it uses Node.js to run the dev server.
+{% /callout %}
+
+---
+
+Initialize a Remix app with `create-remix`.
+
+```sh
+$ bunx create-remix
+
+ remix v1.19.3 💿 Let's build a better website...
+
+ dir Where should we create your new project?
+ ./my-app
+
+ â—¼ Using basic template See https://remix.run/docs/pages/templates for more
+ ✔ Template copied
+
+ git Initialize a new git repository?
+ Yes
+
+ deps Install dependencies with bun?
+ Yes
+
+ ✔ Dependencies installed
+
+ ✔ Git initialized
+
+ done That's it!
+
+ Enter your project directory using cd ./my-app
+ Check out README.md for development and deploy instructions.
+```
+
+---
+
+To start the dev server, run `bun run dev` from the project root.
+
+```sh
+$ cd my-app
+$ bun run dev
+ $ remix dev
+
+ 💿 remix dev
+
+ info building...
+ info built (263ms)
+ Remix App Server started at http://localhost:3000 (http://172.20.0.143:3000)
+```
+
+---
+
+Open [http://localhost:3000](http://localhost:3000) with your browser to see the result. Any changes you make to `app/routes/_index.tsx` will be hot-reloaded in the browser.