summaryrefslogtreecommitdiffhomepage
path: root/app/packages/web/README.md
diff options
context:
space:
mode:
authorFrank <[email protected]>2025-05-23 14:17:45 -0400
committerDax Raad <[email protected]>2025-05-26 12:40:17 -0400
commit83974e0c95d65c72d12e7d58a287514c39f3768f (patch)
tree274625aa4693b0d71b50eae3cfedb5d6245f99f9 /app/packages/web/README.md
parent59d43fa5da0619655c7ba3360e969bcbda1716ea (diff)
downloadopencode-83974e0c95d65c72d12e7d58a287514c39f3768f.tar.gz
opencode-83974e0c95d65c72d12e7d58a287514c39f3768f.zip
Share: sync
Diffstat (limited to 'app/packages/web/README.md')
-rw-r--r--app/packages/web/README.md32
1 files changed, 32 insertions, 0 deletions
diff --git a/app/packages/web/README.md b/app/packages/web/README.md
new file mode 100644
index 000000000..a84af3943
--- /dev/null
+++ b/app/packages/web/README.md
@@ -0,0 +1,32 @@
+# SolidStart
+
+Everything you need to build a Solid project, powered by [`solid-start`](https://start.solidjs.com);
+
+## Creating a project
+
+```bash
+# create a new project in the current directory
+npm init solid@latest
+
+# create a new project in my-app
+npm init solid@latest my-app
+```
+
+## Developing
+
+Once you've created a project and installed dependencies with `npm install` (or `pnpm install` or `yarn`), start a development server:
+
+```bash
+npm run dev
+
+# or start the server and open the app in a new browser tab
+npm run dev -- --open
+```
+
+## Building
+
+Solid apps are built with _presets_, which optimise your project for deployment to different environments.
+
+By default, `npm run build` will generate a Node app that you can run with `npm start`. To use a different preset, add it to the `devDependencies` in `package.json` and specify in your `app.config.js`.
+
+## This project was created with the [Solid CLI](https://solid-cli.netlify.app)