summaryrefslogtreecommitdiffhomepage
path: root/packages/console/app/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'packages/console/app/README.md')
-rw-r--r--packages/console/app/README.md32
1 files changed, 32 insertions, 0 deletions
diff --git a/packages/console/app/README.md b/packages/console/app/README.md
new file mode 100644
index 000000000..9337430cf
--- /dev/null
+++ b/packages/console/app/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://github.com/solidjs-community/solid-cli)