Skip to content

Commit 6aa9c2c

Browse files
committed
cleanup readme
1 parent e56fe2b commit 6aa9c2c

File tree

2 files changed

+10
-25
lines changed

2 files changed

+10
-25
lines changed

pg_golden_axe/readme.md

Lines changed: 0 additions & 17 deletions
This file was deleted.

readme.md

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,13 @@
88

99
## Local Setup
1010

11-
1. Dependencies
11+
### Dependencies
1212

1313
[Install rust](https://www.rust-lang.org/tools/install)
1414

15-
Mac
15+
Be sure to take a look at pgrx's [system requirements](https://github.com/pgcentralfoundation/pgrx#system-requirements).
16+
17+
#### Mac
1618
```
1719
brew install postgresql@18
1820
brew services start postgresql@18
@@ -22,7 +24,7 @@ brew install icu4c pkg-config openssl@3
2224
export PKG_CONFIG_PATH="/opt/homebrew/opt/icu4c/lib/pkgconfig"
2325
```
2426

25-
Linux
27+
#### Linux
2628
```
2729
curl -fsSL https://www.postgresql.org/media/keys/ACCC4CF8.asc \
2830
| sudo gpg --dearmor --yes --batch --no-tty \
@@ -34,23 +36,23 @@ sudo apt-get update -y
3436
sudo apt-get install -y build-essential pkg-config libssl-dev postgresql-server-dev-18 postgresql-18 postgresql-client-18
3537
```
3638

37-
3. Install Postgres Extension
39+
### Install Postgres Extension
3840

3941
```
4042
cargo install --locked cargo-pgrx --version="0.16.1"
4143
cargo pgrx init --pg18 pg_config
4244
cargo pgrx install -p pg_golden_axe
4345
```
4446

45-
4. Test
47+
### Test
4648

4749
```
4850
createuser --superuser --createdb --createrole golden_axe
4951
createdb golden_axe_test
5052
cargo test
5153
```
5254

53-
5. Run
55+
### Run
5456

5557
```
5658
createdb be
@@ -61,13 +63,13 @@ psql be -f src/sql/roles.sql
6163
createdb fe
6264
```
6365

64-
6. Start frontend `fe`
66+
#### Start frontend `fe`
6567

6668
```
6769
cargo run -p fe
6870
```
6971

70-
7. Start backend `be`
72+
#### Start backend `be`
7173

7274
The backend depends on the account_limits view and the config table provided by the frontend. The backend will not attempt to update the frontend's schema and therefore must initially be ran after `fe`.
7375

0 commit comments

Comments
 (0)