The Garage Management System is a robust solution tailored for automotive repair shops and garages, aiming to optimize their operations. It offers efficient management of customers, vehicles, services, inventory, and billing, streamlining garage management processes.
To get started developing in the browser, click this button:
If you rather want to use GitHub Codespaces, click this button instead:
NOTE: After dfx deploy
, when developing in GitHub Codespaces, run ./canister_urls.py
and click the links that are shown there.
If you prefer running VS Code locally and not in the browser, click "Codespaces: ..." or "Gitpod" in the bottom left corner and select "Open in VS Code" in the menu that appears. If prompted, proceed by installing the recommended plugins for VS Code.
To develop fully locally, first install Docker and VS Code and start them on your machine. Next, click the following button to open the dev container locally:
- Install
nvm
:
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.3/install.sh | bash
- Switch to node v20:
nvm install 20
nvm use 20
- Install build dependencies:
sudo apt-get install podman
xcode-select --install
brew install podman
- Install
dfx
DFX_VERSION=0.16.1 sh -ci "$(curl -fsSL https://sdk.dfinity.org/install.sh)"
- Add
dfx
to PATH:
echo 'export PATH="$PATH:$HOME/bin"' >> "$HOME/.bashrc"
- Create a project structure:
- create
src
dir - create
index.ts
in thesrc
dir - create
tsconfig.json
in the root directory with the next content
{
"compilerOptions": {
"allowSyntheticDefaultImports": true,
"strictPropertyInitialization": false,
"strict": true,
"target": "ES2020",
"moduleResolution": "node",
"allowJs": true,
"outDir": "HACK_BECAUSE_OF_ALLOW_JS"
}
}
- create
dfx.json
with the next content
{
"canisters": {
"day_care": {
"type": "custom",
"main": "src/index.ts",
"candid": "src/index.did",
"candid_gen": "http",
"build": "npx azle day_care",
"wasm": ".azle/day_care/day_care.wasm",
"gzip": true,
"metadata": [
{
"name": "candid:service",
"path": "src/index.did"
},
{
"name": "cdk:name",
"content": "azle"
}
]
}
}
}
where day_care
is the name of the canister.
- Create a
package.json
with the next content and runnpm i
:
{
"name": "day_care",
"version": "0.1.0",
"description": "Internet Computer message board application",
"dependencies": {
"@dfinity/agent": "^0.21.4",
"@dfinity/candid": "^0.21.4",
"azle": "^0.21.1",
"express": "^4.18.2",
"uuid": "^9.0.1"
},
"engines": {
"node": "^20"
},
"devDependencies": {
"@types/express": "^4.17.21"
}
}
- Run a local replica
dfx start --host 127.0.0.1:8000
If you make any changes to the StableBTreeMap
structure like change datatypes for keys or values, changing size of the key or value, you need to restart dfx
with the --clean
flag. StableBTreeMap
is immutable and any changes to it's configuration after it's been initialized are not supported.
dfx start --host 127.0.0.1:8000 --clean
- Deploy a canister
dfx deploy
Also, if you are building an HTTP-based canister and would like your canister to autoreload on file changes (DO NOT deploy to mainnet with autoreload enabled):
AZLE_AUTORELOAD=true dfx deploy
- Stop a local replica
dfx stop
When a canister is deployed, dfx deploy
produces a link to the Candid interface in the shell output.
Candid interface provides a simple UI where you can interact with functions in the canister.
On the other hand, you can interact with the canister using dfx
via CLI:
dfx canister id <CANISTER_NAME>
Example:dfx canister id day_care
Response:
bkyz2-fmaaa-aaaaa-qaaaq-cai
Now, the URL of your canister should like this:
http://bkyz2-fmaaa-aaaaa-qaaaq-cai.localhost:8000
With this URL, you can interact with the canister using an HTTP client of your choice. We are going to use postman
.
To interact with the day_care
canister using Postman, you need to perform HTTP requests to the canister's URL.
To interact with the day_care
canister, refer to the day_care canister Postman documentation.