To get started, you might want to explore the project directory structure and the default configuration file. Working with this project in your development environment will not affect any production deployment or identity tokens.
To learn more before you start working with urunan, see the following documentation available online:
- Quick Start
- SDK Developer Tools
- Rust Canister Development Guide
- ic-cdk
- ic-cdk-macros
- Candid Introduction
| Aspect | Backend Canister | Frontend Canister |
|---|---|---|
| Language | Rust | Typescript, javascript |
| Framework | Rust IC CDK | Vite.js + React.js |
| UI Library | - | tailwind.css |
| Datastore | IC Stable Structure | browser localStorage |
| Core Library | IC CDK, candid, serde | react, react-router-dom, @dfinity/auth-client, react-hook-form, tailwindcss |
| Test Framework | Rust | vitest |
| Package Manager | Cargo | npm (Node v18) |
If you want to test your project locally, you can use the following commands:
# Starts the replica, running in the background
dfx start --background
# Install all necessary npm packages
npm i
# Deploys your canisters to the replica and generates your candid interface
dfx deployPlease be mind that cargo must be installed through the official installation on the web.
If you have made changes to your backend canister, you can generate a new candid interface with
npm run candidat any time. The script is executing scripts/did.sh which is a little bit hardcoded right now by setting the canister project name on CANISTER variable. It is a comma seperated value.
You also need to install candid extractor first before the npm run candid can be executed successfully.
Which will start a server at http://localhost:8080, proxying API requests to the replica at port 4943.
React is used as the frontend canister. to run it, use
npm run start