Skip to content

Commit 8037c99

Browse files
authored
Merge pull request #21 from spinframework/docs/README-build-run-updates
docs(README): add build/run instructions
2 parents 45e2f3b + 06faedb commit 8037c99

File tree

1 file changed

+25
-0
lines changed

1 file changed

+25
-0
lines changed

README.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,27 @@
11
# spin-docs
2+
23
Spin documentation
4+
5+
## Build and run this website
6+
7+
Prerequisites to run the website locally:
8+
9+
- [npm and node](https://docs.npmjs.com/cli/v8/configuring-npm/install)
10+
- [Spin](https://spinframework.dev/quickstart)
11+
12+
Build and run the website locally:
13+
14+
1. Run the following commands:
15+
16+
```bash
17+
cd spin-up-hub
18+
npm ci
19+
cd ../
20+
npm ci
21+
spin build
22+
spin watch # Uses spin watch to run the website and reload when content changes.
23+
```
24+
25+
2. View the website at `http://localhost:3000`.
26+
27+
If you would like to edit the contents of the [spinframework.dev](https://spinframework.dev/) website and contribute your changes, please visit the [Contributing to Docs](https://spinframework.dev/contributing-docs) page.

0 commit comments

Comments
 (0)