Skip to content

Commit 3b5718b

Browse files
authored
Replace demo folder with StackBlitz (tus#704)
1 parent 8217f5e commit 3b5718b

File tree

7 files changed

+9
-323
lines changed

7 files changed

+9
-323
lines changed

.changeset/config.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,5 +7,5 @@
77
"access": "public",
88
"baseBranch": "main",
99
"updateInternalDependencies": "patch",
10-
"ignore": ["demo", "test"]
10+
"ignore": ["test"]
1111
}

README.md

Lines changed: 3 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,6 @@ easily be added to tus-node-server
2727
- [Quick start](#quick-start)
2828
- [Packages](#packages)
2929
- [Extensions](#extensions)
30-
- [Demos](#demos)
3130
- [Types](#types)
3231
- [Compatibility](#compatibility)
3332
- [Contribute](#contribute)
@@ -49,6 +48,9 @@ integrate it into your existing one. There are also other mature servers, like
4948

5049
A standalone server which stores files on disk.
5150

51+
> [!TIP]
52+
> Try it yourself in [StackBlitz](https://stackblitz.com/edit/stackblitz-starters-zg6mgnuf?file=index.js)
53+
5254
```js
5355
const {Server} = require('@tus/server')
5456
const {FileStore} = require('@tus/file-store')
@@ -116,31 +118,6 @@ extensions.
116118
| [Termination][] |||||
117119
| [Concatenation][] |||||
118120

119-
## Demos
120-
121-
Start the demo server using Local File Storage
122-
123-
```bash
124-
npm run build && npm run demo
125-
```
126-
127-
Start up the demo server using AWS S3. The environment variables `AWS_BUCKET`,
128-
`AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY`, and `AWS_REGION` need to be present.
129-
130-
```bash
131-
npm run build && npm run demo:s3
132-
```
133-
134-
Start up the demo server using Google Cloud Storage. A `keyfile.json` needs to be present
135-
in the root of the repository.
136-
137-
```bash
138-
npm run build && npm run demo:gcs
139-
```
140-
141-
Then navigate to the demo ([localhost:1080](http://localhost:1080)) which uses
142-
[`tus-js-client`](https://github.com/tus/tus-js-client).
143-
144121
## Types
145122

146123
All packages are fully typed with TypeScript.

biome.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
"enabled": true
55
},
66
"files": {
7-
"ignore": ["./demo", "./**/dist/**/*"]
7+
"ignore": ["./**/dist/**/*"]
88
},
99
"linter": {
1010
"enabled": true,

demo/package.json

Lines changed: 0 additions & 22 deletions
This file was deleted.

demo/server.js

Lines changed: 0 additions & 139 deletions
This file was deleted.

0 commit comments

Comments
 (0)