Skip to content

Commit efebfbe

Browse files
authored
Update README.md
Updated readme with how to run web-ui on command line.
1 parent c97520d commit efebfbe

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,16 @@ if you don't want to stare at an empty timeline.
3838
A public instance is available at https://rostra.me/ , but
3939
it's advised to run Rostra directly on your system.
4040

41+
#### Checkout Code, build and run
42+
43+
Pre-requisite: You should have rust installed on your system, so that you can build the code.
44+
45+
1. Checkout code using `git clone https://github.com/dpc/rostra`, then do `cd rostra/`
46+
2. Build the binaries using `cargo build`
47+
3. run the web-ui using `./target/build/rostra web-ui`. This will open the web-ui on localhost.
48+
49+
To verify that the above is working well, login to your above localhost web-ui using same 'account or private key' that you use to access rostra.me. Both should show same posts from your account, and from other accounts you follow.
50+
4151
#### Using Cargo
4252

4353
**NOTE**: [This flow currently doesn't work end to end](https://github.com/dpc/rostra/discussions/7).

0 commit comments

Comments
 (0)