Add a configure section to the README

This commit is contained in:
Sebastian Martinez
2024-05-17 15:35:00 +02:00
parent 46e514dcd8
commit 15e258dad5
+21
View File
@@ -40,6 +40,24 @@ There are several ways to deploy the UI publicly. Here are two common options:
1. Fork this repository to create your own version
2. Configure your Vercel account to deploy the forked repository
## Configuration
There's two ways to configure the UI:
**Create a `local.json` config file**
1. Copy [default.json][def] to a new file in the same folder called
`local.json`.
2. Modify the properties in `local.json` to your preference.
**Environment variables**
1. Check [custom-environment-variables.json][env] for all available environment
variables.
2. Set the desired environment variables when building the UI.
> For advanced configuration options, have a look at the [`node-config`][nco]
> package.
## Contributing
@@ -63,8 +81,11 @@ The UI is distributed under the terms of GPLv3. See [LICENSE][lic] for details.
[app]: https://app.radicle.xyz
[con]: ./CONTRIBUTING.md
[def]: ./config/default.json
[env]: ./config/custom-environment-variables.json
[iss]: https://app.radicle.xyz/nodes/seed.radicle.garden/rad:z4V1sjrXqjvFdnCUbxPFqd5p4DtH5/issues
[lic]: ./LICENSE
[nco]: https://github.com/node-config/node-config/wiki/Configuration-Files
[nod]: https://nodejs.org
[npm]: https://www.npmjs.com
[pat]: https://app.radicle.xyz/nodes/seed.radicle.garden/rad:z4V1sjrXqjvFdnCUbxPFqd5p4DtH5/patches