feat: some basic info on the readme (#741)

* feat: section to start app locally

* feat: prerequisites section

* fix: don't mention the build

* feat: mention pnpm stop-db

* fix: use spiritnet on env example

Author: rompemoldes

.env.example

@@ -1,9 +1,9 @@
 PORT=3000
 URL=http://127.0.0.1:3000
 DATABASE_URI=postgres://postgres:postgres@localhost:5432/postgres
-SUBSCAN_NETWORK=kilt-testnet
+SUBSCAN_NETWORK=spiritnet
 SECRET_SUBSCAN=
-BLOCKCHAIN_ENDPOINT=wss://peregrine.kilt.io
+BLOCKCHAIN_ENDPOINT=wss://kilt-rpc.dwellir.com
 DID=
 SECRET_PAYER_MNEMONIC=
 SECRET_AUTHENTICATION_MNEMONIC=

README.md

@@ -1,3 +1,44 @@
 # ctypehub
 
 The source code of https://ctypehub.galaniprojects.de
+
+### Prerequisites
+
+Make sure you installed these required software before running this project:
+
+- [Node.js](https://nodejs.org/en/download/prebuilt-installer)
+- [pnpm](https://pnpm.io/installation#using-corepack)
+- [Docker](https://docs.docker.com/engine/install/)
+
+
+## Start the app locally:
+
+After having [cloned the repository](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository) on your local machine and defining all environment variables according to the `.env.example`, to start the app locally follow this steps.
+
+1. Make sure you have all dependencies installed, running:
+
+   ```
+   pnpm install
+   ```
+
+2. Start the database the app will use, running:
+
+   ```
+   pnpm start-db
+   ```
+_The Docker daemon needs to be running for this to work_
+
+If there is already a postgres container running, with an incompatible database, you can stop it with `pnpm stop-db`.
+
+3. Enter the dev watch mode from astro, running:
+
+   ```
+   pnpm dev
+   ```
+
+ Now you can see the logs of the backend on the terminal and visit the frontend under the URL specified by the variable `URL` from the `.env`-file.
+ (By default http://localhost:3000)
+
+ The database should start to populate from the configured indexer.
+
+