diff --git a/README.md b/README.md index 1f1135d..09e453b 100644 --- a/README.md +++ b/README.md @@ -69,6 +69,22 @@ listen = async () => { } ``` +# Building the project + +Prerequisites: +- NodeJS 17 (14 and up probably work, versions newer than 18 fail to build the Angular frontend) +- npm + +Setup and build steps: +- `npm i` in the project root +- `cd src/frontend` +- `npm i` again for the frontend build +- `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`. +- Open `gateway/index.html` with a browser and you should see the shoutbox webpage after a short load. + +Troubleshooting: +- 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). + # Credits - This project was originally inspired by indImm (https://ndm-inf.github.io/ndm/main), a ripple-based file storage using IPFS.