univoice-vmc

Generating Documentation for univoice-vmc

To generate documentation for the univoice-vmc project, including all subfolders, you can use a documentation generator tool like jsdoc for JavaScript or rustdoc for Rust. Below are the steps to generate documentation for each subfolder in your project.

Using jsdoc for JavaScript

1. Install jsdoc:

npm install -g jsdoc

2. Generate Documentation:

jsdoc -c jsdoc.json

Ensure you have a jsdoc.json configuration file in your project root. Here is an example configuration:

{
  "source": {
   "include": ["src"],
   "includePattern": ".+\\.js(doc|x)?$",
   "excludePattern": "(^|\\/|\\\\)_"
  },
  "opts": {
   "destination": "./docs"
  }
}

Using rustdoc for Rust

1. Generate Documentation:

cargo doc --no-deps

2. Open Documentation:

open target/doc/univoice_vmc/index.html

Combining Documentation

If your project contains both JavaScript and Rust code, you can combine the generated documentation into a single directory. For example, you can generate JavaScript documentation into a docs/js folder and Rust documentation into a docs/rust folder.

Automating Documentation Generation

You can automate the documentation generation process by adding scripts to your package.json:

"scripts": {
  "docs:js": "jsdoc -c jsdoc.json",
  "docs:rust": "cargo doc --no-deps",
  "docs": "npm run docs:js && npm run docs:rust"
}

Run the following command to generate all documentation:

npm run docs

This will generate and combine the documentation for all subfolders in your univoice-vmc project.

Welcome to your new univoice-vmc project and to the Internet Computer development community. By default, creating a new project adds this README and some template files to your project directory. You can edit these template files to customize your project and to include your own code to speed up the development cycle.

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 univoice-vmc, see the following documentation available online:

• Quick Start
• SDK Developer Tools
• Rust Canister Development Guide
• ic-cdk
• ic-cdk-macros
• Candid Introduction

If you want to start working on your project right away, you might want to try the following commands:

cd univoice-vmc/
dfx help
dfx canister --help

Running the project locally

If you want to test your project locally, you can use the following commands:

# Starts the replica, running in the background
dfx start --background

# Deploys your canisters to the replica and generates your candid interface
dfx deploy

Once the job completes, your application will be available at http://localhost:4943?canisterId={asset_canister_id}.

If you have made changes to your backend canister, you can generate a new candid interface with

npm run generate

at any time. This is recommended before starting the frontend development server, and will be run automatically any time you run dfx deploy.

If you are making frontend changes, you can start a development server with

npm start

Which will start a server at http://localhost:8080, proxying API requests to the replica at port 4943.

Note on frontend environment variables

If you are hosting frontend code somewhere without using DFX, you may need to make one of the following adjustments to ensure your project does not fetch the root key in production:

• setDFX_NETWORK to ic if you are using Webpack
• use your own preferred method to replace process.env.DFX_NETWORK in the autogenerated declarations
  • Setting canisters -> {asset_canister_id} -> declarations -> env_override to a string in dfx.json will replace process.env.DFX_NETWORK with the string in the autogenerated declarations
• Write your own createActor constructor