Jelajahi Sumber

Add README.md

Daniel Kunický 3 tahun lalu
induk
melakukan
c27b670232
1 mengubah file dengan 12 tambahan dan 0 penghapusan
  1. 12 0
      README.md

+ 12 - 0
README.md

@@ -0,0 +1,12 @@
+# chain4all-service
+## How to run:
+1. You need Node installed on your system
+2. Run `npm install` 
+3. Run `npm run dev`
+4. Enjoy!
+## Configuration:
+You can configure chain4all-service using following enviromental variables:<br />
+`CHAIN4ALL_SERVICE_PORT` - port which should this service use (default: 3000)<br />
+`IROHA_API_HOST` - host address of [iroha-rest-api](https://git.lesprojekt.cz/kunickyd/iroha-rest-api) (default: http://localhost)<br />
+`IROHA_API_PORT` - port of [iroha-rest-api](https://git.lesprojekt.cz/kunickyd/iroha-rest-api) (default: 5000)<br />
+`IROHA_DOMAIN` - name of Iroha domain, see [this](https://iroha.readthedocs.io/en/main/concepts_architecture/glossary.html?highlight=domain#domain) (default: test)<br />