Skip to content

Commit

Permalink
docs(README): add development scripts to README
Browse files Browse the repository at this point in the history
  • Loading branch information
susickypavel committed Apr 30, 2024
1 parent cd4dbe0 commit 946b368
Show file tree
Hide file tree
Showing 4 changed files with 55 additions and 29 deletions.
16 changes: 16 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,3 +34,19 @@ bun add solid-apg@latest
| Test report | Generated test results for `solid-apg` unit tests | [**GitHub** Pages](https://susickypavel.github.io/solid-apg/report) | - |
| Code coverage | Generated code coverage for `solid-apg` unit tests | [**GitHub** Pages](https://susickypavel.github.io/solid-apg/coverage) | - |
| Typedoc documentation | Generated `typedoc` documentation for `solid-apg` source code | [**GitHub** Pages](https://susickypavel.github.io/solid-apg/typedoc) | - |

## 3. Contributing

### 3.1 Prerequisites

- [Node.js >=18](https://nodejs.org)
- [pnpm >=8](https://pnpm.io)

### 3.2 Installation

```sh
git clone git@github.com:susickypavel/solid-apg.git
cd solid-apg

pnpm install
```
13 changes: 13 additions & 0 deletions apps/docs/README.md
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
```
34 changes: 9 additions & 25 deletions apps/solid-start-example/README.md
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`.
21 changes: 17 additions & 4 deletions packages/solid-apg/README.md
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
```

0 comments on commit 946b368

Please sign in to comment.