diff options
| author | Frank <[email protected]> | 2025-05-23 15:57:33 -0400 |
|---|---|---|
| committer | Dax Raad <[email protected]> | 2025-05-26 12:40:17 -0400 |
| commit | d51b4263aba59f60277766fc024f2931fc8874ec (patch) | |
| tree | a9dfed63563a88bc26cb2d37d582e2c14a5d9331 /app/packages/web/README.md | |
| parent | 34a2dcb80a28e208c986d39ce1e145f245691f62 (diff) | |
| download | opencode-d51b4263aba59f60277766fc024f2931fc8874ec.tar.gz opencode-d51b4263aba59f60277766fc024f2931fc8874ec.zip | |
Share: sync
Diffstat (limited to 'app/packages/web/README.md')
| -rw-r--r-- | app/packages/web/README.md | 40 |
1 files changed, 21 insertions, 19 deletions
diff --git a/app/packages/web/README.md b/app/packages/web/README.md index a84af3943..6a1764536 100644 --- a/app/packages/web/README.md +++ b/app/packages/web/README.md @@ -1,32 +1,34 @@ -# SolidStart +## Usage -Everything you need to build a Solid project, powered by [`solid-start`](https://start.solidjs.com); +Those templates dependencies are maintained via [pnpm](https://pnpm.io) via `pnpm up -Lri`. -## Creating a project +This is the reason you see a `pnpm-lock.yaml`. That being said, any package manager will work. This file can be safely be removed once you clone a template. ```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 +$ npm install # or pnpm install or yarn install ``` -## Developing +### Learn more on the [Solid Website](https://solidjs.com) and come chat with us on our [Discord](https://discord.com/invite/solidjs) -Once you've created a project and installed dependencies with `npm install` (or `pnpm install` or `yarn`), start a development server: +## Available Scripts -```bash -npm run dev +In the project directory, you can run: -# or start the server and open the app in a new browser tab -npm run dev -- --open -``` +### `npm run dev` or `npm start` + +Runs the app in the development mode.<br> +Open [http://localhost:3000](http://localhost:3000) to view it in the browser. + +The page will reload if you make edits.<br> + +### `npm run build` -## Building +Builds the app for production to the `dist` folder.<br> +It correctly bundles Solid in production mode and optimizes the build for the best performance. -Solid apps are built with _presets_, which optimise your project for deployment to different environments. +The build is minified and the filenames include the hashes.<br> +Your app is ready to be deployed! -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`. +## Deployment -## This project was created with the [Solid CLI](https://solid-cli.netlify.app) +You can deploy the `dist` folder to any static host provider (netlify, surge, now, etc.) |