Skip to main content

Extension Devkit for Worlds

The Devkit (available on Github) is a starter kit that allows you to develop extensions compatible with AKASHA Core

Features​

Installation​

To get started with Devkit, clone the repository from Github

This repository contains the configuration for running it in DevContainers, which is highly recommended.

Prerequisites

  • Docker
  • An IDE or text editor that has support for DevContainers (VSCode, Webstorm, Cursor, etc.)
info

This guide was tested extensively using VSCode, hence some command shortcuts may differ a bit for your preferred editor. Please consult the corresponding documentation for more information

Steps

  1. Open the project with your editor and make sure you have the devcontainer extension installed (VSCode will prompt you with the recommendation to install it)
  2. Open the project in devcontainer
    • VSCode will prompt you to do it if you have the extension installed.
  3. Follow the on-screen instructions (on the terminal) on how to get it mounted into a world
tip

In any case you missed the prompt, you can always run the project in DevContainer through the command palette.

For VSCode, press SHIFT + COMMAND + P to open the command palette, then search for and select Dev Containers: Reopen in Container. If you made any changes to the files (including container and docker configuration files) earlier, you may use Dev Containers: Rebuild and Reopen in Container

Manual installation​

If you do not want to use DevContainers, you can setup the project manually

Prerequisites

Steps

  1. Install dependencies using yarn install
  2. Run yarn dev to start the dev server
  3. Follow the on-screen instructions (on the terminal) on how to get it mounted into a world

Next Steps​

Now that we have set up and run the project (locally or on DevContainer), please visit Setup and Development Workflow for detailed guide on how to get the extension mounted into a world.

Troubleshooting​

  1. I get some errors when I try to start the project in DevContainers on VSCode, what should I do?

    • Ensure you have the project opened as a folder and not in a workspace on VSCode

  2. Can I run the project locally after running it in the DevContainers?

    • Yes you can, however you need to re-install the packages and build the project again before continuing

  3. I get an Address already in use error trying to run the project locally after I forcefuly exited the Devcontainer

    • This is most likely because the container instance on Docker wasn't gracefuly shut down from the DevContainer and hence was still using the specified port. Open your Docker application or use the CLI to shut down the extension-devkit container before re-attempting to run it locally

  4. I want to run the project again on DevContainers after making a few changes or running it locally, how do I proceed?

    • First, make sure you have stopped the script on the local terminal, then proceed to search and select the appropriate command from the command palette to Rebuild and Reopen in DevContainers
Last updated on