Skip to content

docs(templates): add minimal build/run docs to template READMEs #212

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 13, 2023
Merged

docs(templates): add minimal build/run docs to template READMEs #212

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 18 additions & 1 deletion templates/http-js/content/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,20 @@
## HTTP-JS template

This is a simple template to get started with spin-js-sdk.
This is a simple template to get started with spin-js-sdk.

### Build

```console
npm install
spin build
```

### Run

```console
spin up
```

Or, use `spin watch` to run the app and rebuild on any changes to `package.json` or the files in `src`.

Use e.g. `curl -v http://127.0.0.1:3000/hello` to test the endpoint.
19 changes: 18 additions & 1 deletion templates/http-ts/content/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,20 @@
## HTTP-TS template

This is a simple template to get started with spin-js-sdk using typescript.
This is a simple template to get started with spin-js-sdk using typescript.

### Build

```console
npm install
spin build
```

### Run

```console
spin up
```

Or, use `spin watch` to run the app and rebuild on any changes to `package.json` or the files in `src`.

Use e.g. `curl -v http://127.0.0.1:3000/hello` to test the endpoint.