diff --git a/README.md b/README.md index d15f619..f3bab41 100644 --- a/README.md +++ b/README.md @@ -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 +``` diff --git a/apps/docs/README.md b/apps/docs/README.md index 25f8d45..91e7871 100644 --- a/apps/docs/README.md +++ b/apps/docs/README.md @@ -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 +``` diff --git a/apps/solid-start-example/README.md b/apps/solid-start-example/README.md index 01282bf..8882e62 100644 --- a/apps/solid-start-example/README.md +++ b/apps/solid-start-example/README.md @@ -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`. diff --git a/packages/solid-apg/README.md b/packages/solid-apg/README.md index 344fb14..9995fef 100644 --- a/packages/solid-apg/README.md +++ b/packages/solid-apg/README.md @@ -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 +```