-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs(README): add development scripts to README
- Loading branch information
1 parent
cd4dbe0
commit 946b368
Showing
4 changed files
with
55 additions
and
29 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1,14 @@ | ||
# Documentation | ||
|
||
## 1. Development scripts | ||
|
||
```sh | ||
# NOTE: Run development server | ||
pnpm dev | ||
|
||
# NOTE: Build for Vercel deployment | ||
pnpm build | ||
|
||
# NOTE: Preview the production build | ||
pnpm preview | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,30 +1,14 @@ | ||
# SolidStart | ||
# SolidStart Example | ||
|
||
Everything you need to build a Solid project, powered by [`solid-start`](https://start.solidjs.com); | ||
## 1. Development scripts | ||
|
||
## Creating a project | ||
```sh | ||
# NOTE: Run development server | ||
pnpm dev | ||
|
||
```bash | ||
# create a new project in the current directory | ||
npm init solid@latest | ||
# NOTE: Build for Vercel deployment | ||
pnpm build | ||
|
||
# create a new project in my-app | ||
npm init solid@latest my-app | ||
# NOTE: Preview the production build | ||
pnpm start | ||
``` | ||
|
||
## 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 _adapters_, 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 adapter, add it to the `devDependencies` in `package.json` and specify in your `vite.config.js`. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,7 +1,20 @@ | ||
## Contributing | ||
# Solid APG | ||
|
||
TODO | ||
## 1. Development scripts | ||
|
||
## Scripts | ||
```sh | ||
# NOTE: Create a dist folder with the compiled code. | ||
pnpm build | ||
|
||
TODO | ||
# NOTE: Run unit tests | ||
pnpm test:unit | ||
|
||
# NOTE: Generate code coverage report | ||
pnpm test:coverage | ||
|
||
# NOTE: Generate test results report | ||
pnpm test:report | ||
|
||
# NOTE: Generate typedoc documentation | ||
pnpm typedoc | ||
``` |