index.md

title	description	keywords	author	category	layout	tags
Developing Blocklets with Codespaces	Developing Blocklets with Codespaces	blocklet server, blocklet, codespaces	linchen		documentation	blocklet server blocklet codespaces

Codespaces is an online development environment, hosted by GitHub, that allows you to develop entirely in the cloud.

Config .devcontainer in your project

• Copy the .devcontainer directory in https://github.com/blocklet/blocklet-dev-container to the root directory of your project.
• Push your local code to Github

Open you project in Codespaces

Please refer to https://docs.github.com/en/free-pro-team@latest/github/developing-online-with-codespaces/creating-a-codespace

Setup you dev environment

Please ensure that blocklet dev can work correctly in your project

In your codespaces:

• Run blocklet dev to setup you dev environment
• After successfully starting the dev environment, use Command + MouseDown to access the link in the terminal

✔ Blocklet [email protected] was successfully started

ℹ You can access with the following URL

- http://127.0.0.1/admin/welcome/

ℹ Note that your blocklet is running in development in Blocklet Server,
ℹ To run it in production mode, you can use blocklet bundle and then blocklet deploy.

When you open your codespace again, your Blocklet Server daemon may have been closed. At this point, please run blocklet server start to start Blocklet Server daemon

FAQ

Unable to log in to Blocklet Server

Currently, the service in Codespaces does not support public access, so the mobile DID Wallet cannot communicate with the Blocklet Server in your codespace. A temporary solution is to use ngrok to establish a channel to bypass Codespaces.

1. Install ngrok

# In your codespace

curl https://bin.equinox.io/c/4VmDzA7iaHb/ngrok-stable-linux-amd64.zip -o ngrok.zip
unzip ./ngrok.zip

2. Config ngrok

   • Login ngrok: https://dashboard.ngrok.com/login
   • Setup ngrok authtoken in your codespace, please refer to https://dashboard.ngrok.com/get-started/setup

3. Use ngrok to establish Blocklet Server access channel

# In your codespace

./ngrok http 80

After the access channel is successfully established, you can access the Blocklet Server through the Forwarding address in the Terminal

ngrok by @inconshreveable

Session Status                online
Account                       linchen1987 (Plan: Free)
Version                       2.3.35
Region                        United States (us)
Web Interface                 http://127.0.0.1:4040
Forwarding                    http://xxxxxxxxxxxx.ngrok.io -> http://localhost:80
Forwarding                    https://xxxxxxxxxxxx.ngrok.io -> http://localhost:80

Connections                   ttl     opn     rt1     rt5     p50     p90
                              0       0       0.00    0.00    0.00    0.00