docs(setup + readme): improved database setup guide and added title t…

…o readme (#43)
juspay · Nov 13, 2023 · 0e311a7 · 0e311a7
1 parent 2d9a5ff
commit 0e311a7
Show file tree

Hide file tree

Showing 2 changed files with 29 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -1,3 +1,6 @@
+# Tartarus - Rust Locker
+
+
 ## Overview
 
 The Hyperswitch Card Vault (Tartarus) is a highly performant and a secure vault to save sensitive data such as payment card details, bank account details etc.

diff --git a/docs/guides/setup.md b/docs/guides/setup.md
@@ -86,6 +86,32 @@ The configuration can be provided in two ways
 
 - Local Setup:
 
+  User setup before running the diesel commands,
+
+  ```bash
+  export DB_USER="db_user"
+  export DB_PASS="db_pass"
+  export DB_NAME="locker"
+  ```
+
+  On Ubuntu-based systems (also applicable for Ubuntu on WSL2):
+
+  ```bash
+  sudo -u postgres psql -e -c \
+   "CREATE USER $DB_USER WITH PASSWORD '$DB_PASS' SUPERUSER CREATEDB CREATEROLE INHERIT LOGIN;"
+  sudo -u postgres psql -e -c \
+   "CREATE DATABASE $DB_NAME;"
+  ```
+
+  On MacOS:
+
+  ```bash
+  psql -e -U postgres -c \
+  "CREATE USER $DB_USER WITH PASSWORD '$DB_PASS' SUPERUSER CREATEDB CREATEROLE INHERIT LOGIN;"
+  psql -e -U postgres -c \
+  "CREATE DATABASE $DB_NAME"
+  ```
+
   For local setup, you can use the diesel-cli to run the diesel migrations.
   To install the diesel cli, simply run