aboutsummaryrefslogtreecommitdiffstats
path: root/rust/README.md
diff options
context:
space:
mode:
authorBryan Newbold <bnewbold@robocracy.org>2019-03-15 15:39:59 -0700
committerBryan Newbold <bnewbold@robocracy.org>2019-03-15 15:39:59 -0700
commit705ac0fba2dc879115509006ce4fdfae8c9fc5c0 (patch)
treef6b15989ba1b314baec8e0914fbd8749ac111938 /rust/README.md
parent7f708f1835be5011cb393d0f53252893369989d6 (diff)
downloadfatcat-705ac0fba2dc879115509006ce4fdfae8c9fc5c0.tar.gz
fatcat-705ac0fba2dc879115509006ce4fdfae8c9fc5c0.zip
update dev setup instructions
Diffstat (limited to 'rust/README.md')
-rw-r--r--rust/README.md32
1 files changed, 21 insertions, 11 deletions
diff --git a/rust/README.md b/rust/README.md
index 7393322d..e191d03e 100644
--- a/rust/README.md
+++ b/rust/README.md
@@ -21,26 +21,36 @@ do development work:
- rust stable, 2018 edition, 1.32+ (eg, via "rustup", includes cargo tool)
- diesel (`cargo install diesel_cli`)
- postgres (compatible with 9.6+; run 11.x in production)
-- postgres libs (debian: `sudo apt install libsqlite3-dev libpq-dev`)
-- libsodium library and development headers (debian: `libsodium-dev`)
+- postgres libs (debian/ubuntu: `libsqlite3-dev libpq-dev`)
+- libsodium library and development headers (debian/ubuntu: `libsodium-dev`)
-Copying commands out of `../.gitlab-ci.yml` file may be the fastest way to get
-started.
+We need to create a new `fatcat` postgres user and database to run tests and
+develop with. On debian/ubuntu, a UNIX account named `postgres` is
+automatically created with control over the database, so we'll run setup
+commands from that user. To create the database account:
-Create a new postgres superuser. A regular postgres user and an existing
-database should also work (with up/down migrations), but it's easier to just
-blow the entire database away.
+ sudo su - postgres
-Copy `env.example` to `.env`, update if needed, then re-create database from
-scratch:
+ # this command creates a PostgreSQL user, not a UNIX/system user
+ createuser -s fatcat -P
+
+ # switch back to your regular system user
+ exit
+
+Copy `./example.env` to `./.env` and update the `DATABASE_URL` and
+`TEST_DATABASE_URL` lines with the password you set above.
+
+As your regular user, use `diesel` to create and initialize the `fatcat`
+database (`diesel` and the fatcat tools will automatically use postgresql
+credentials from the `.env` file):
diesel database reset
-Build and run:
+Build and run the API server:
cargo run --bin fatcatd
-Tests:
+Run tests:
cargo test -- --test-threads 1