scaffold

Signed-off-by: Alexander Diemand <[email protected]>
Blockchain-Data-Analytics · Jun 5, 2024 · bf166b3 · bf166b3
1 parent 80c160c
commit bf166b3
Show file tree

Hide file tree

Showing 13 changed files with 105 additions and 2 deletions.
diff --git a/CODEOWNERS b/CODEOWNERS
@@ -0,0 +1 @@
+*           @codiepp @monoid-is-a-monad
diff --git a/README.md b/README.md
@@ -1,2 +1,26 @@
-# Cardano_Queries
-querying the Cardano blockchain data in PostgreSQL
+# Cardano Queries
+
+## querying the Cardano blockchain data in PostgreSQL
+
+The data is derived using [Db-sync](https://github.com/IntersectMBO/cardano-db-sync) from Cardano's main chain.
+
+
+![BCA Queries Docker setup](docs/images/BCA%20Queries%20Docker%20images%20setup.png)
+
+
+We provide you with a complete setup containing all credentials to connect to our high-availability PostgreSQL servers.
+
+Prerequisites: you need to have [Docker](https://www.docker.com/products/docker-desktop/) installed.
+
+Depending on your location you may choose to connect to either:
+
+| location | sponsorship tier | link |
+|----|----|----|
+| Europe 🇪🇺 |  $29 per month  | [select EU servers](https://github.com/sponsors/Blockchain-Data-Analytics/sponsorships?pay_prorated=true&tier_id=406906) |
+| North America 🇺🇸  | $28 per month | [select US servers](https://github.com/sponsors/Blockchain-Data-Analytics/sponsorships?pay_prorated=true&tier_id=406907) |
+
+Payment of the selected sponsorship gives you the right to use the service for up to a month. Renewal of the sponsorship extends the service period. And, cancellation of your sponsorship will also terminate the service at the end of the paid period. Please understand that we cannot reimburse you.
+
+We cannot provide you with a strict SLA. But, we promise to keep the services alive and fix technical problems asap. We have decent monitoring in place and will be able to react to service disruption.
+
+See our [main page](https://github.com/Blockchain-Data-Analytics) for contact details.
diff --git a/docs/00_main.md b/docs/00_main.md
@@ -0,0 +1,29 @@
+# Cardano Queries
+
+## Setup Cardano Queries on your machine
+
+### Windows ![Windows](images/win.png)
+
+[Windows setup](01_setup_win.md)
+
+### macOS ![macOS](images/mac.png)
+
+[macOS setup](02_setup_mac.md)
+
+### Linux ![Linux](images/linux.png)
+
+[Linux setup](03_setup_linux.md)
+
+### on other operating systems
+
+e.g. FreeBSD
+
+[other setup](04_setup_other.md)
+
+## Running queries in _pgAdmin_
+
+[using pgAdmin](10_use_pgadmin.md)
+
+## Sending queries directly to PostgreSQL
+
+[PostgreSQL connection](20_direct_pg.md)
diff --git a/docs/01_setup_win.md b/docs/01_setup_win.md
@@ -0,0 +1,6 @@
+￪ [bach to main](00_main.md)
+
+
+# Windows setup
+
+_TODO_
diff --git a/docs/02_setup_mac.md b/docs/02_setup_mac.md
@@ -0,0 +1,6 @@
+￪ [bach to main](00_main.md)
+
+
+# Setup on macOS
+
+_TODO_
diff --git a/docs/03_setup_linux.md b/docs/03_setup_linux.md
@@ -0,0 +1,6 @@
+￪ [bach to main](00_main.md)
+
+
+# Linux setup
+
+_TODO_
diff --git a/docs/04_setup_other.md b/docs/04_setup_other.md
@@ -0,0 +1,6 @@
+￪ [bach to main](00_main.md)
+
+
+# Setup on other OS
+
+_TODO_
diff --git a/docs/10_use_pgadmin.md b/docs/10_use_pgadmin.md
@@ -0,0 +1,8 @@
+￪ [bach to main](00_main.md)
+
+
+# Using _pgAdmin_
+
+[pgAdmin](http://localhost:5480) is available locally at http://localhost:5480
+
+_TODO_
diff --git a/docs/20_direct_pg.md b/docs/20_direct_pg.md
@@ -0,0 +1,17 @@
+￪ [bach to main](00_main.md)
+
+
+# Direct PostgreSQL connection
+
+port: 5432
+host: localhost
+database: mainnet
+
+It is possible to directly connect to PostgreSQL:
+
+```sh
+psql -h localhost -p 5432 -U user12345 mainnet
+```
+(replace "user12345" with your assigned user name; this command will ask for the password)
+
+_TODO_
diff --git a/docs/images/BCA Queries Docker images setup.png b/docs/images/BCA Queries Docker images setup.png
diff --git a/docs/images/linux.png b/docs/images/linux.png
diff --git a/docs/images/mac.png b/docs/images/mac.png
diff --git a/docs/images/win.png b/docs/images/win.png