diff options
author | 2023-08-16 21:30:37 -0700 | |
---|---|---|
committer | 2023-08-16 21:30:37 -0700 | |
commit | d4438e94964fb006b2939e269945f0e5825ced7d (patch) | |
tree | da2ca23210ee96b3d9152e3c2efd4e691687bd06 | |
parent | 56d591b903d448ca9a106ca2f94cb446e7e62373 (diff) | |
download | bun-d4438e94964fb006b2939e269945f0e5825ced7d.tar.gz bun-d4438e94964fb006b2939e269945f0e5825ced7d.tar.zst bun-d4438e94964fb006b2939e269945f0e5825ced7d.zip |
Add solidstart guide (#4182)
-rw-r--r-- | docs/guides/ecosystem/solidstart.md | 58 |
1 files changed, 58 insertions, 0 deletions
diff --git a/docs/guides/ecosystem/solidstart.md b/docs/guides/ecosystem/solidstart.md new file mode 100644 index 000000000..b6062c903 --- /dev/null +++ b/docs/guides/ecosystem/solidstart.md @@ -0,0 +1,58 @@ +--- +name: Build an app with SolidStart and Bun +--- + +{% callout %} +SolidStart 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 SolidStart app with `create-solid`. + +```sh +$ bunx create-solid my-app +create-solid version 0.2.31 + +Welcome to the SolidStart setup wizard! + +There are definitely bugs and some feature might not work yet. +If you encounter an issue, have a look at +https://github.com/solidjs/solid-start/issues and open a new one, +if it is not already tracked. + +✔ Which template do you want to use? › todomvc +✔ Server Side Rendering? … yes +✔ Use TypeScript? … yes +cloned solidjs/solid-start#main to /path/to/my-app/.solid-start +✔ Copied project files +``` + +--- + +As instructed by the `create-solid` CLI, lets install our dependencies. + +```sh +$ cd my-app +$ bun install +``` + +--- + +Then run the development server. + +```sh +$ bun run dev +# or, equivalently +$ bunx solid-start dev +``` + +--- + +Open [localhost:3000](http://localhost:3000). Any changes you make to `src/routes/index.tsx` will be hot-reloaded automatically. + +{% image src="https://github.com/oven-sh/bun/assets/3084745/1e8043c4-49d1-498c-9add-c1eaab6c7167" alt="SolidStart demo app" /%} + +--- + +Refer to the [SolidStart website](start.solidjs.com/getting-started/what-is-solidstart) for complete framework documentation. |