Create a sample app

​

Prerequisites

• To build and manage a Cobo Portal App, you need a Cobo account and organization provisioned by Cobo Sales with access to the development environment. To request access, contact Cobo Sales. If you are joining an existing organization, ask its admin to invite you.
• Install FastAPI as the development environment.

​

Create an app project using Cobo CLI

1. Install Cobo CLI using the following command:
    # Install Cobo CLI using pip (Python 3.9 or newer is required).
    pip install cobo-cli
    # Alternatively, you can install Cobo CLI using Homebrew.
    brew install cobo-cli
    # Test if the installation is successful
    cobo version
   
   For more details about the system requirements for Cobo CLI, please refer to Install Cobo CLI.
2. Log in to Cobo Portal and connect Cobo CLI to your Cobo Portal account. You can choose one of the three authentication methods to authenticate. As an example, this step will show you how to authenticate with your Cobo Portal account:
   # Use your Cobo Portal account to authenticate.
   cobo auth user
   # Initiate the user login process.
   cobo login
   
   You’ll be prompted to open a browser to continue the authorization process. Complete the authorization process in your browser, granting the necessary permissions for Cobo CLI to access your crypto wallets. For more details about authentication methods, see Login and authentication.
3. Use the app init command to create a sample app based on a template. You can specify the details of the WaaS application you want to create through options, or choose these parameters step by step and create the project using the prompts of Cobo CLI. The following command creates a Cobo Portal App project, using Org Access Tokens for authentication, and creates it in the directory named hello_world:
   cobo app init --app-type portal --auth org --directory hello_world
   

​

Run and preview the app

1. Start the frontend server. Navigate to the frontend folder in the directory where you created the app project and run the following command:
   npm install
   npm start
   
   Now you can view the app’s frontend as the following screenshot shows:
2. Start the backend server. Navigate to the backend folder in the directory where you created the app project and run the following command:
   uvicorn main:app --reload
   
   Now you can view the app’s backend as the following screenshot shows: To display the wallets and transactions in your organization, you need to complete the following steps:
   • Find the .env.example file in the backend folder and rename it to .env. In the .env file, set COBO_API_KEY as your API key, COBO_API_SECRET as your API secret, and set COBO_ENV as dev or production based on the environment you use. For more information about API keys, refer to API key.
   • Register your API key on Cobo Portal. For more details, refer to Register an API key.
   After you complete the above steps, you can view the wallets and transactions as the following screenshot shows:

​

Publish the app