Add more info in the README
This commit is contained in:
parent
cadb33cc1a
commit
502c186f52
23
README.md
23
README.md
|
@ -1,5 +1,7 @@
|
|||
# Plume
|
||||
|
||||
Federated blogging engine, based on ActivityPub.
|
||||
|
||||
## Setup the database
|
||||
|
||||
You'll need Postgres.
|
||||
|
@ -16,3 +18,24 @@ GRANT ALL PRIVILEGES ON DATABASE plume to plume;
|
|||
|
||||
exit
|
||||
```
|
||||
|
||||
Then run the migrations
|
||||
|
||||
```
|
||||
diesel migrations run # Install diesel with `cargo install diesel_cli` if needed
|
||||
```
|
||||
|
||||
You should repeat this operation every time the database schema has been modified.
|
||||
A good practice is to run it after every `git pull`.
|
||||
|
||||
## Starting the app
|
||||
|
||||
Just use:
|
||||
|
||||
```
|
||||
cargo run
|
||||
```
|
||||
|
||||
You'll need Rust nightly.
|
||||
|
||||
Once the app started, try to visit [localhost:8000](http://localhost:8000).
|
||||
|
|
Loading…
Reference in New Issue