Skip to content

Commit

Permalink
Replace demo folder with StackBlitz (#704)
Browse files Browse the repository at this point in the history
  • Loading branch information
Murderlon authored Jan 20, 2025
1 parent 8217f5e commit 3b5718b
Show file tree
Hide file tree
Showing 7 changed files with 9 additions and 323 deletions.
2 changes: 1 addition & 1 deletion .changeset/config.json
Original file line number Diff line number Diff line change
Expand Up @@ -7,5 +7,5 @@
"access": "public",
"baseBranch": "main",
"updateInternalDependencies": "patch",
"ignore": ["demo", "test"]
"ignore": ["test"]
}
29 changes: 3 additions & 26 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,6 @@ easily be added to tus-node-server
- [Quick start](#quick-start)
- [Packages](#packages)
- [Extensions](#extensions)
- [Demos](#demos)
- [Types](#types)
- [Compatibility](#compatibility)
- [Contribute](#contribute)
Expand All @@ -49,6 +48,9 @@ integrate it into your existing one. There are also other mature servers, like

A standalone server which stores files on disk.

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

## Demos

Start the demo server using Local File Storage

```bash
npm run build && npm run demo
```

Start up the demo server using AWS S3. The environment variables `AWS_BUCKET`,
`AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY`, and `AWS_REGION` need to be present.

```bash
npm run build && npm run demo:s3
```

Start up the demo server using Google Cloud Storage. A `keyfile.json` needs to be present
in the root of the repository.

```bash
npm run build && npm run demo:gcs
```

Then navigate to the demo ([localhost:1080](http://localhost:1080)) which uses
[`tus-js-client`](https://github.com/tus/tus-js-client).

## Types

All packages are fully typed with TypeScript.
Expand Down
2 changes: 1 addition & 1 deletion biome.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
"enabled": true
},
"files": {
"ignore": ["./demo", "./**/dist/**/*"]
"ignore": ["./**/dist/**/*"]
},
"linter": {
"enabled": true,
Expand Down
22 changes: 0 additions & 22 deletions demo/package.json

This file was deleted.

139 changes: 0 additions & 139 deletions demo/server.js

This file was deleted.

Loading

0 comments on commit 3b5718b

Please sign in to comment.