Each project can be easily built using docker:
Now, launch the containers using the docker-compose configuration described in the previous section, which also sets up the necessary API mappings for the web frontends to find the API endpoints.
For building the project JDK 16+ is required.
For importing, building and running the project in your Kotlin/Java IDE, refer to your IDE documentation.
For a plain Gradle build, independent of your IDE, simply execute:
For building the project NodeJs v14+ and Yarn 1.22+ is required.
In the nuxt configuration in nuxt.config.js
, you may want to adjust the API proxy mappings, which by default point to either our rolling public deployment or localhost:
Uncomment or adjust to your needs:
Build and run the project using:
The service is started on port 3000 by default.
For production build and other build options, follow the instructions in the README.md
of the project.
For building the project NodeJs v14+ and Yarn 1.22+ is required.
In the nuxt configuration in nuxt.config.js
, you may want to adjust the API proxy mappings, which by default point to either our rolling public deployment or localhost:
Uncomment or adjust to your needs:
Build and run the project using:
The service is started on port 8000 by default.
For production build and other build options, follow the instructions in the README.md
of the project.
For building the project NodeJs v14+ and Yarn 1.22+ is required.
In the nuxt configuration in nuxt.config.js
, you may want to adjust the API proxy mappings, which by default point to either our rolling public deployment or localhost:
Uncomment or adjust to your needs:
Build and run the project using:
The service is started on port 4000 by default.
For production build and other build options, follow the instructions in the README.md
of the project.
If you are working on one of the web frontends (e.g. web-wallet, issuer-portal, verifier-portal), you may want to run the wallet backend container standalone, to connect your local web frontend build with it.
Edit the configuration files in waltid-walletkit/config
, according to your needs and run the container like so:
Note: Running the web frontend containers standalone, makes little sense, as they depend on an API gateway to connect to the backend APIs. This API gateway is set up by the docker-compose configuration, mentioned above.
The easiest and fastest way to get the wallet backend, frontend, and issuer and verifier portals started, is by using our docker-compose configuration, located in the waltid-walletkit project, in the subfolder:
./docker/
.
Simply start the services using:
This configuration will publish the following endpoints by default:
Web wallet on [HOSTNAME]:8080
API: /api/
Verifier portal on [HOSTNAME]:8081
API: /verifier-api/
Issuer portal on [HOSTNAME]:8082
API: /issuer-api/
Note: __ [HOSTNAME] is your local computer name. If you use localhost instead, some features, particularly with regards to credential exchange, will not work correctly.
In case the HOSTNAME is not picked up automatically, you might need to set it in an env-file and refer to it by: docker-compose --env-file env-file-with-hostname up.
Visit the ./docker
folder for adjusting the system config in the following files:
docker-compose.yaml - Docker config for launching containers, volumes & networking
ingress.conf - Routing config
config/wallet-config.json - wallet backend configuration
config/verifier-config.json - verifier backend configuration
config/issuer-config.json - issuer backend configuration