Skip to content

Commit

Permalink
Document CLI and add 'yarn cli' command
Browse files Browse the repository at this point in the history
  • Loading branch information
pfrazee committed Feb 4, 2022
1 parent 0783f7f commit 3d873fe
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 2 deletions.
14 changes: 12 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,10 @@ The demo revolves around two main concepts:
## Running the Demo
_Requires Node>=15, and yarn_

There are three components to the demo:
There are four components to the demo:
- a "bluesky" server (federated data & identity management)
- the frontend (simple micro-bloggin application)
- the frontend (simple micro-blogging application)
- the command-line (simple micro-blogging CLI)
- a third-party server that a user can delegate permission to to post on it's behalf (think [Buffer](https://buffer.com/))

This project is setup in a yarn workspace. To install dependencies for all sub-projects, just run `yarn` from the project root. To build all sub-projects, run `yarn build` from the project root.
Expand All @@ -40,6 +41,15 @@ yarn dev

Go to `http://localhost:3005` to try the demo.

### Command-line

In another console tab, run the CLI

```sh
cd cli
# build, if needed, with `yarn build`
yarn cli
```

### Third-party server (optional)
To enable third-party posting, run the third-party server as well in another console
Expand Down
1 change: 1 addition & 0 deletions cli/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
"version": "0.0.1",
"type": "module",
"scripts": {
"cli": "node dist/bin.js",
"build": "(cd ../common && yarn build) && tsc --project tsconfig.json"
},
"dependencies": {
Expand Down

0 comments on commit 3d873fe

Please sign in to comment.