Formyfi

Formyfi is a robust Q&A application fully running on the Internet Computer blockchain.

Prerequisites

If you are using the Windows operating system, please ensure that you have WSL (Windows Subsystem for Linux) installed on your machine, as all the code below should be executed in the WSL terminal.

Before getting started with Formyfi, ensure you have the following tools installed:

DFX 0.15.2

To install DFX 0.15.2, run the following command:

DFX_VERSION=0.15.2 sh -ci "$(curl -fsSL https://sdk.dfinity.org/install.sh)"

NPM

Download and install NPM from https://nodejs.org/en/download.

Web2

There is certain functionality implemented in web2 for this project. If you are interested to see web2 part, run the following code:

git clone <path_to_this_repo> <your_local_dir> --recursive

Running Locally

1. Navigate to the project directory and start DFX using the following command:

   dfx start --clean --background

   Note: If starting DFX returns an error, open the dfx.json file, remove "local" from "networks," and run:

   dfx start --clean --background --host 127.0.0.1:4943

2. Install project dependencies by running:

   npm install

   Ensure to add "local" back to the "networks" section in dfx.json if you removed it while starting DFX.

3. Deploy the canisters locally with:

   dfx generate

   If this command returns an error, ignore it and run next command:

   dfx deploy

   After deployment, you will receive URIs for the canisters. Click on the URI for the assets canister to open the local DApp in your browser.

4. Need to start assets canisters for uploading and reading files like images, run:

   dfx canister call user_storage authorize '(principal "m7ob5-xdzun-z3vt2-6oujc-gfm2t-2lt5p-bw5kn-2tatc-fjkti-eko6j-jqe")'
   dfx canister call qa_storage authorize '(principal "m7ob5-xdzun-z3vt2-6oujc-gfm2t-2lt5p-bw5kn-2tatc-fjkti-eko6j-jqe")'
   dfx canister call response_storage authorize '(principal "m7ob5-xdzun-z3vt2-6oujc-gfm2t-2lt5p-bw5kn-2tatc-fjkti-eko6j-jqe")'

   Open the DApp through the link provided by the Vite dev server.

5. If you are developing the front-end of the DApp and want to avoid running dfx deploy every time you make changes, run:

   npm run dev

   Open the DApp through the link provided by the Vite dev server.

Stopping Canisters

1. Before stopping canisters, ensure that the "local" is removed from the "networks" section in your dfx.json file, if you removed it while starting DFX and added it back during deployment, then run following command:

   dfx stop

2. After stopping the canisters, if you removed "local" earlier, make sure to add it back to the "networks" section in your dfx.json file: