Skip to content

Commit 5e1f0a4

Browse files
committed
Added more deployment options and scripts listing to readme
1 parent 929d433 commit 5e1f0a4

1 file changed

Lines changed: 37 additions & 7 deletions

File tree

.github/README.md

Lines changed: 37 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -29,21 +29,27 @@ You can then start the server with `node build`.
2929
<details>
3030
<summary>More Deployment Options</summary>
3131

32-
#### Option 4 - Source: Static
32+
#### Option 4 - GitHub Pages
33+
Fork the repo.<br>
34+
Head to the Actions tab, find the "Deploy to GitHub Pages" workflow, and trigger it.<br>
35+
Then go to Settings > Pages > Source and select the `gh-pages` branch.<br>
36+
Visit `https://<your-username>.github.io/networking-toolbox/` to see your deployed app.
37+
38+
#### Option 5 - Source: Static
3339
Follow the dev steps below.
3440
Then run `npm run build:static` to compile output.<br>
3541
And upload the contents of `./build` to any web server, CDN or static host.
3642

37-
#### Option 5 - Source: Docker
43+
#### Option 6 - Source: Docker
3844
Follow the dev steps below.
3945
Then run `docker build -t networking-toolbox .` to build the image.<br>
4046
You can then start the container with `docker run -p 8080:80 networking-toolbox`.
4147

42-
#### Option 6 - GitHub Pages
43-
Fork the repo.<br>
44-
Head to the Actions tab, find the "Deploy to GitHub Pages" workflow, and trigger it.<br>
45-
Then go to Settings > Pages > Source and select the `gh-pages` branch.<br>
46-
Visit `https://<your-username>.github.io/networking-toolbox/` to see your deployed app.
48+
#### Option 7 - Source: Other Platforms
49+
You can build the app from source for a variety of platforms. This is done via SvelteKit adapters.<br>
50+
First, follow the dev steps below.
51+
Then, simply set the `DEPLOY_ENV` environmental variable, to one of `vercel`, `node`, `docker`, `netlify`, `static` or just `auto`, and build the app<br>
52+
For example: `DEPLOY_ENV='node' npm run build`
4753
</details>
4854

4955
---
@@ -71,6 +77,30 @@ Before merging, code must pass all unit and end-to-end tests, as well as linting
7177
yarn test
7278
```
7379

80+
<details>
81+
<summary><h4>Project Commands</h4></summary>
82+
83+
##### Building
84+
- `npm run dev` - Starts the development server with hot reload/HMR
85+
- `npm run build` - Builds the app for production
86+
- Note: choose adapter for platform by setting the `DEPLOY_ENV` var (see above)
87+
- `npm run preview` - Test your build locally (build required first)
88+
- `npm start` - Starts the production app (build required first)
89+
90+
##### Testing
91+
- `npm test` — Run unit tests with Vitest
92+
- `npm run test:api` — Run API tests
93+
- `npm run test:e2e` — Run Playwright end-to-end tests
94+
- `npm run test:coverage` — Generate test coverage
95+
96+
##### Checking
97+
- `npm run check` — SvelteKit checks (types & diagnostics)
98+
- `npm run types` — TypeScript-specific strict checking
99+
- `npm run lint` — ESLint on all TS and Svelte files
100+
- `npm run format` — Format files with Prettier
101+
- `npm run build-check` — Quitley check build works
102+
</details>
103+
74104
---
75105

76106
### Contributing

0 commit comments

Comments
 (0)