Build and Run Yourself
Prerequisites
Start the local replica
Open a new terminal window in the project directory, and run the following command to start the local replica. The replica will not start unless dfx.json exists in the current directory.
dfx start --background
When you're done with development, or you're switching to a different dfx project, running
dfx stop
from the project directory will stop the local replica.
Run OISY locally
Make sure you switch back to the project root directory.
First, install the frontend dependencies by running
npm ci
To build and deploy the project locally, first create a .env.development
file by copying the .env.example file. Once you've correctly set the api keys for all the different services that OISY needs, then run:
npm run deploy
It should output something like the following
...
Deployed canisters.
URLs:
Frontend canister via browser
frontend: http://127.0.0.1:4943/?canisterId=br5f7-7uaaa-aaaaa-qaaca-cai
Backend canister via Candid interface:
backend: http://127.0.0.1:4943/?canisterId=bd3sg-teaaa-aaaaa-qaaba-cai&id=bkyz2-fmaaa-aaaaa-qaaaq-cai
internet_identity: http://127.0.0.1:4943/?canisterId=bd3sg-teaaa-aaaaa-qaaba-cai&id=be2us-64aaa-aaaaa-qaabq-cai
Click on the frontend URL to access the OISY Wallet that is running locally.
Local development
See HACKING
Backend
The backend is written in Rust and you can find it under the backend folder. It uses the tECDSA API provided by IC. To find out more about tECDSA, you can read the Eurocrypt 2022 paper.
If you want to locally deploy the backend only, you use the following command
dfx deploy backend
Frontend
The frontend is written entirely in Svelte. You can serve the frontend in development mode like you normally develop a svelte app using the command
npm run dev
Dependencies
Some Iconly icons are used in the project, not included. You must obtain a license separately.
The license for this project is bought and owned by the DFINITY Foundation, please see terms and conditions here.
Last updated