Browse Source

update README some more again

master
nitowa 1 year ago
parent
commit
ad503bcabd
1 changed files with 16 additions and 0 deletions
  1. 16
    0
      README.md

+ 16
- 0
README.md View File

@@ -69,6 +69,22 @@ listen = async () => {
69 69
 }
70 70
 ```
71 71
 
72
+# Building the project
73
+
74
+Prerequisites: 
75
+- NodeJS 17 (14 and up probably work, versions newer than 18 fail to build the Angular frontend)
76
+- npm
77
+
78
+Setup and build steps:
79
+- `npm i` in the project root
80
+- `cd src/frontend`
81
+- `npm i` again for the frontend build
82
+- `npm run start` in the project root. This will iteratively build the frontend, Deploy scripts, Deploy the frontend to the ripple blockchain and ultimately generate a gateway webpage under `gateway/index.html`.
83
+- Open `gateway/index.html` with a browser and you should see the shoutbox webpage after a short load.
84
+
85
+Troubleshooting:
86
+- If the project as been dormant for a while it is possible that the testnet wallets have been purged. In this case you have to repopulate the entries under [Configuration.ts](https://gitea.nitowa.xyz/nitowa/httxrp/src/branch/master/src/Configuration.ts) as well as the shoutboxAddress in [ShoutboxData.service.ts](https://gitea.nitowa.xyz/nitowa/httxrp/src/branch/master/src/frontend/src/app/services/ShoutboxData.service.ts) with fresh wallets. Funded testnet wallets can be generated via the [fauncet](https://xrpl.org/xrp-testnet-faucet.html). 
87
+
72 88
 # Credits
73 89
 
74 90
 - This project was originally inspired by indImm (https://ndm-inf.github.io/ndm/main), a ripple-based file storage using IPFS.

Loading…
Cancel
Save