Skip to content

Latest commit

 

History

History
55 lines (34 loc) · 4.38 KB

README.md

File metadata and controls

55 lines (34 loc) · 4.38 KB

cargo-elnaai

This project is a Rust-based application that is designed to run on the Internet Computer. It consists of two main parts: a backend and a frontend.

Figma Link

https://www.figma.com/file/jm56pFQBfzHbUxsNsOBJbq/de-ai-(og)?type=design&node-id=0%3A1&mode=design&t=NiA7RytxNeUDbeIx-1

Project Structure

The project is structured as follows:

  • src/test_backend/: This is where the backend code resides. It is written in Rust and exposes several methods such as __getit and __canister_method_print_all_dataset.
  • src/test_frontend/: This is where the frontend code resides. It is designed to interact with the backend and provide a user interface.

Running the Project Locally

To run the 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.

Frontend Development

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