nitowa/turgle
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

update README some more again

Browse Source
This commit is contained in:
nitowa
2022-11-23 11:02:40 +01:00
parent c2c763962f
commit ad503bcabd
1 changed files with 16 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+16
View File
@@ -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 # Credits
- This project was originally inspired by indImm (https://ndm-inf.github.io/ndm/main), a ripple-based file storage using IPFS. - This project was originally inspired by indImm (https://ndm-inf.github.io/ndm/main), a ripple-based file storage using IPFS.