Skip to content

Commit 77cbebb

Browse files
committed
Add deps step
1 parent ce4cfa7 commit 77cbebb

1 file changed

Lines changed: 32 additions & 17 deletions

File tree

README.md

Lines changed: 32 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -24,10 +24,25 @@ You will need:
2424
- [`docker compose`](https://github.com/docker/compose)
2525

2626
The following commands will get you up and running:
27+
2728
```sh
2829
# Use node version manager to install the pinned version of node
2930
nvm install
3031

32+
# Check you have the correct dependencies
33+
34+
```
35+
36+
apt-get install \
37+
protobuf-compiler \
38+
cmake \
39+
g++ \
40+
pkg-config \
41+
libssl-dev \
42+
libsasl2-dev
43+
44+
```
45+
3146
# Add the WASM target to the rust toolchain
3247
rustup target add wasm32-unknown-unknown
3348
@@ -56,27 +71,27 @@ To run the server from source instead, see [`services/server/README.md`](service
5671

5772
### Packages
5873

59-
| Package | Description |
60-
|---------|-------------|
61-
| `packages/js-core` | Core JavaScript library containing the main Polycentric protocol logic |
62-
| `packages/js-browser` | Browser SDK using SQLite WASM for local storage |
63-
| `packages/js-node` | Node.js SDK using sqlite3 for local storage |
64-
| `packages/js-storage-sqlite` | Shared SQLite (Drizzle ORM) storage layer for the JS SDKs |
65-
| `packages/react-native` | React Native SDK for mobile applications |
66-
| `packages/rs-common` | Shared Rust code used by rs-core |
67-
| `packages/rs-core` | Rust core library - the underlying protocol implementation |
68-
| `packages/rs-core-uniffi-web` | rs-core on WASM with `uniffi-bindgen-react-native` bindings |
74+
| Package | Description |
75+
| ----------------------------- | ---------------------------------------------------------------------- |
76+
| `packages/js-core` | Core JavaScript library containing the main Polycentric protocol logic |
77+
| `packages/js-browser` | Browser SDK using SQLite WASM for local storage |
78+
| `packages/js-node` | Node.js SDK using sqlite3 for local storage |
79+
| `packages/js-storage-sqlite` | Shared SQLite (Drizzle ORM) storage layer for the JS SDKs |
80+
| `packages/react-native` | React Native SDK for mobile applications |
81+
| `packages/rs-common` | Shared Rust code used by rs-core |
82+
| `packages/rs-core` | Rust core library - the underlying protocol implementation |
83+
| `packages/rs-core-uniffi-web` | rs-core on WASM with `uniffi-bindgen-react-native` bindings |
6984

7085
### Apps
7186

72-
| App | Description |
73-
|-----|-------------|
87+
| App | Description |
88+
| ------------------ | ------------------------------------------------------------------- |
7489
| `apps/polycentric` | The main Polycentric social network application (Expo/React Native) |
7590

7691
### Services
7792

78-
| Service | Description |
79-
|---------|-------------|
80-
| `services/server` | Polycentric server |
81-
| `legacy/services/polycentric-server` | Legacy server |
82-
| `legacy/services/verifiers-server` | Legacy Server for verifying claims and signatures in the protocol |
93+
| Service | Description |
94+
| ------------------------------------ | ----------------------------------------------------------------- |
95+
| `services/server` | Polycentric server |
96+
| `legacy/services/polycentric-server` | Legacy server |
97+
| `legacy/services/verifiers-server` | Legacy Server for verifying claims and signatures in the protocol |

0 commit comments

Comments
 (0)