The source code for WUBCO.
This repository contains the source code for the Web UI for BBA CRUD Operations website. It wraps the bba DID method handler to provide a human friendly access to the bba DID method.
The generated files are available here.
Clone repository:
git clone https://github.com/blobaa/bba-did-ui.git
Install dependencies:
npm install
Create a .env file containing the following variables:
| Variable | Description | Brief |
|---|---|---|
| RUN_ENV | The run environment | dev for development, prod for production. Deploying the website automatically sets this variable to prod. Defaults to dev |
| MAINNET_URL | The mainnet Ardor node url | Defaults to https://ardor.jelurida.com |
| TESTNET_URL | The testnet Ardor node url | Defaults to https://testardor.jelurida.com |
| MIN_TESTNET_BALANCE | The minimum testnet IGNIS balance a DID controller must own to process a create, update or deactivate operation. The balance is used to pay the fees | Defaults to 10 |
| MIN_MAINNET_BALANCE | The minimum mainnet IGNIS balance a DID controller must own to process a create, update or deactivate operation. The balance is used to pay the fees | Defaults to 2 |
Use the .env-sample file as template.
run server for development:
npm run dev
The website is now accessible at http://localhost:3000.
In dev environment mode (RUN_ENV=dev) no request is made to an Ardor node and a dummy DID is used wich is stored within the ./src/dev.ts file. This mode is primarly used for UI development. If you want to use the website locally to process bba's DID method operations, set the RUN_ENV variable to prod RUN_ENV=prod.
There are two options to deploy WUBCO.
Creating a static website which can be served by any static web server.
Lint project:
npm run lint
Build project:
npm run build
Create static website:
npm run export
WUBCO is now available within the ./out folder.
There is an easy way to serve WUBCO with GitHub Pages. Follow the steps below to set up GitHub Pages to serve WUBCO from within this repository (source repository).
- Create a separate repository (target repository) and configure GitHub Pages to serve files from the root folder of the master branch of the target repository.
- Create a
.env-productionfile within the source repository and configure your production environment settings. - Authorize SSH access to the target repository from the system containing your source repository.
You can now deploy WUBCO with the following commands:
cd scripts
./deploy-frontend.sh -u <github user> -r <repository name> -d <domain>
Replace <github user> with your GitHub user name and <repository name> with the target repository name. Replace <domain> if you serve WUBCO under a custom domain. Otherwise do not use this option.
PRs accepted.
If editing the Readme, please conform to the standard-readme specification.
MIT © Attila Aldemir