Skip to content
This repository was archived by the owner on Nov 23, 2022. It is now read-only.

Commit bb4cdda

Browse files
committed
chore(docs): add 2022-q1
1 parent bd46e15 commit bb4cdda

File tree

8 files changed

+88
-19
lines changed

8 files changed

+88
-19
lines changed

README.md

+15-4
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,17 @@
66
Technology stack as a library for developing semi-decentralized web applications
77
</p>
88

9-
[![npm-badge]][npm] [![Changelog][changelog-badge]][changelog] [![issues-badge]][issues] [![license-badge]][license]
10-
[![FOSSA Status][fossa-badge]][fossa] [![Discord][discord-badge]][discord] [![Known Vulnerabilities](https://snyk.io/test/github/dstack-js/dstack/badge.svg)](https://snyk.io/test/github/dstack-js/dstack) [![Open Collective backers and sponsors](https://img.shields.io/opencollective/all/dstack)](https://opencollective.com/dstack) ![Maintenance](https://img.shields.io/maintenance/yes/2022)
9+
[![npm-badge]][npm] ![](https://badgen.net/npm/types/@dstack-js/lib)
10+
11+
[![license-badge]][license] [![FOSSA Status][fossa-badge]][fossa]
12+
13+
[![Discord][discord-badge]][discord] [![Gitter](https://badges.gitter.im/dstack-chat/community.svg)](https://gitter.im/dstack-chat/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=body_badge)
14+
15+
[![Known Vulnerabilities](https://snyk.io/test/github/dstack-js/dstack/badge.svg)](https://snyk.io/test/github/dstack-js/dstack)
16+
17+
[![Open Collective backers and sponsors](https://img.shields.io/opencollective/all/dstack)](https://opencollective.com/dstack)
18+
19+
![Maintenance](https://img.shields.io/maintenance/yes/2022) [![CodeClimate](https://api.codeclimate.com/v1/badges/79ea2d56c8d646635e7e/maintainability)](https://codeclimate.com/github/dstack-js/dstack/maintainability) [![issues-badge]][issues]
1120

1221
Checkout [Peerchat](https://dstack.dev/blog/peerchat) demo
1322

@@ -41,6 +50,7 @@ DStack provides:
4150
- [Shard](./apps/docs/shard.md)
4251
- [PubSub](./apps/docs/pubsub.md)
4352
- [Relay](./packages/relay)
53+
- [Transport](./packages/transport)
4454

4555
### Tell others that you use DStack
4656

@@ -60,8 +70,9 @@ DStack workspace is managed by [nx.dev](https://nx.dev)
6070

6171
- [lib](./packages/lib) - Core library
6272
- [relay](./packages/relay) - Relay
73+
- [transport](./packages/transport) - `libp2p-webrtc-star` fork for relay
6374
- [ipfs](./packages/ipfs) - IPFS
64-
- [docs](./apps/docs) - Docs
75+
- [docs](./docs) - Docs
6576

6677
### Commands
6778

@@ -95,7 +106,7 @@ yarn release
95106

96107
## License
97108

98-
All packages licensed under GPL-3.0
109+
All packages are licensed under GPL-3.0, except [transport is licensed under MIT](./packages/transport/LICENSE).
99110

100111
See [LICENSE](../LICENSE)
101112

docs/blog/2022-Q1.md

+47
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
---
2+
slug: 2022-Q1
3+
title: What's new in DStack 2022-Q1
4+
authors:
5+
- 0x77dev
6+
tags: [dstack, whats-new, '2022-Q1', peer-isolation, cloud, relay, lib]
7+
---
8+
9+
## Cloud
10+
11+
We are announcing DStack Cloud 🛰
12+
13+
During next quarter we will release cloud, a hosting solution to provide you an ability to cache your Store/Shards on the edge, have isolated relay for your application and observe your semi-decentralized infrastructure powered by DStack
14+
15+
Also when cloud will be released, unknown namespaces in public relay will be limited by 10 peers by default
16+
17+
The pricing and plans will be announced when released, but don't worry, we will offer a free plan for hobby projects
18+
19+
## Beta release
20+
21+
We announcing a beta release by the end of 2022 Q2
22+
23+
It will include major improvements to our core library to provide more fluent developing experience and improve bundle size
24+
25+
Also probably it will include major testing in production projects
26+
27+
We are searching for projects who are interested to use DStack in production to collect feedback, bug reports and feature requests, [you can apply here](https://6l3fibt6mac.typeform.com/to/NZL0qDN2)
28+
29+
## Relay
30+
31+
We are announcing [99% uptime](https://uptime.is/99) milestone in Public Relay
32+
33+
[Public Relay](/docs/relay#public-relay) now has a new multi-regional and highly available deployment on the edge powered by [fly.io](https://fly.io)
34+
35+
Also you can check it's availability and incidents on [status page](https://status.dstack.dev) or [report a downtime](https://github.com/dstack-js/dstack/issues/new/choose)
36+
37+
## Peer isolation
38+
39+
Relay and Core library now supports peers isolation by namespacing them
40+
41+
It was achieved by forking [`libp2p-webrtc-star`](https://github.com/libp2p/js-libp2p-webrtc-star/tree/v0.17.x) into new module `@dstack-js/transport` to support custom communications between relay and libp2p to tell relay a namespace by which peers is isolated
42+
43+
## Core library
44+
45+
Now `@dstack-js/lib` includes IPFS and Relay GraphQL API communications out of the box, no need to manually request relay for bootstrap data
46+
47+
Also DStack now has a fork of [node-webrtc](https://github.com/corwin-of-amber/node-webrtc) to provide pre-built binaries for darwin arm64 (macOS on M1)

docs/package.json

+2-1
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,8 @@
1818
"clsx": "1.1.1",
1919
"prism-react-renderer": "1.3.1",
2020
"react": "17.0.2",
21-
"react-dom": "17.0.2"
21+
"react-dom": "17.0.2",
22+
"usehooks-ts": "^2.4.2"
2223
},
2324
"devDependencies": {
2425
"@docusaurus/module-type-aliases": "2.0.0-beta.17",

package.json

+2-2
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@
33
"@emotion/react": "11.8.2",
44
"@emotion/styled": "11.8.1",
55
"@mdx-js/react": "2.1.0",
6-
"@mui/icons-material": "5.5.1",
7-
"@mui/material": "5.5.2",
6+
"@mui/icons-material": "^5.5.1",
7+
"@mui/material": "^5.5.2",
88
"clsx": "1.1.1",
99
"core-js": "3.21.1",
1010
"react": "17.0.2",

packages/ipfs/README.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,22 @@
11
# @dstack-js/ipfs
22

3-
This package was created to provide zero configuration ipfs for [`@dstack-js/lib`](https://www.npmjs.com/package/@dstack-js/lib) package
3+
This package was created specifically to use in [`@dstack-js/lib`](https://www.npmjs.com/package/@dstack-js/lib) package
44

5-
Instead you can use [ipfs-core](https://www.npmjs.com/package/ipfs-core) directly with DHT enabled
5+
[See tutorial to get started working with DStack](https://dstack.dev/docs/intro)
66

77
## Example
88

99
```javascript
1010
import { create } from '@dstack-js/ipfs';
1111

12-
const ipfs = await create();
12+
const ipfs = await create({ namespace: 'namespace' });
1313
```
1414

1515
Node.js:
1616

1717
```javascript
1818
import { create } from '@dstack-js/ipfs';
19-
import wrtc from 'wrtc'; // or 'electron-webrtc'
19+
import wrtc from '@dstack-js/wrtc';
2020

21-
const ipfs = await create({}, wrtc);
21+
const ipfs = await create({ namespace: 'namespace', wrtc });
2222
```

packages/lib/README.md

+1-3
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
11
# @dstack-js/lib
22

3-
DStack is under heavy development, no documentation currently available
4-
5-
See more here: https://github.com/dstack-js/dstack
3+
[See tutorial to get started working with DStack](https://dstack.dev/docs/intro)

packages/transport/README.md

+2
Original file line numberDiff line numberDiff line change
@@ -5,3 +5,5 @@ Forked from [libp2p-webrtc-star](https://github.com/libp2p/js-libp2p-webrtc-star
55
This module is optimized to work with [DStack Relay](https://dstack.dev/docs/relay)
66

77
And this module was made specifically to use in [@dstack-js/ipfs](https://www.npmjs.com/package/@dstack-js/ipfs) package.
8+
9+
[See tutorial to get started working with DStack](https://dstack.dev/docs/intro)

yarn.lock

+14-4
Original file line numberDiff line numberDiff line change
@@ -4736,7 +4736,7 @@ __metadata:
47364736
languageName: node
47374737
linkType: hard
47384738

4739-
"@mui/icons-material@npm:5.5.1":
4739+
"@mui/icons-material@npm:^5.5.1":
47404740
version: 5.5.1
47414741
resolution: "@mui/icons-material@npm:5.5.1"
47424742
dependencies:
@@ -4752,7 +4752,7 @@ __metadata:
47524752
languageName: node
47534753
linkType: hard
47544754

4755-
"@mui/material@npm:5.5.2":
4755+
"@mui/material@npm:^5.5.2":
47564756
version: 5.5.2
47574757
resolution: "@mui/material@npm:5.5.2"
47584758
dependencies:
@@ -11703,6 +11703,7 @@ __metadata:
1170311703
react: 17.0.2
1170411704
react-dom: 17.0.2
1170511705
typescript: ^4.6.2
11706+
usehooks-ts: ^2.4.2
1170611707
languageName: unknown
1170711708
linkType: soft
1170811709

@@ -11916,8 +11917,8 @@ __metadata:
1191611917
"@emotion/react": 11.8.2
1191711918
"@emotion/styled": 11.8.1
1191811919
"@mdx-js/react": 2.1.0
11919-
"@mui/icons-material": 5.5.1
11920-
"@mui/material": 5.5.2
11920+
"@mui/icons-material": ^5.5.1
11921+
"@mui/material": ^5.5.2
1192111922
"@nrwl/cli": 13.9.4
1192211923
"@nrwl/cypress": 13.9.4
1192311924
"@nrwl/eslint-plugin-nx": 13.9.4
@@ -27309,6 +27310,15 @@ __metadata:
2730927310
languageName: node
2731027311
linkType: hard
2731127312

27313+
"usehooks-ts@npm:^2.4.2":
27314+
version: 2.4.2
27315+
resolution: "usehooks-ts@npm:2.4.2"
27316+
peerDependencies:
27317+
react: ">=16.8.0"
27318+
checksum: 6dd14bb5301f80061443c5ab00b07779e0186c8c3b022138fb23431e05cb5067a266f82b39585dce262d66e5fc4a174032d4e47c7f5428bfd90f601ec624800e
27319+
languageName: node
27320+
linkType: hard
27321+
2731227322
"utf8-byte-length@npm:^1.0.1":
2731327323
version: 1.0.4
2731427324
resolution: "utf8-byte-length@npm:1.0.4"

0 commit comments

Comments
 (0)