Extension devkit for Worlds

The starter kit allows you to develop extensions compatible with AKASHA Core.

Features

• Typescript
• Vite
• Shadcn
• AKASHA React Hooks
• AKASHA React Apollo Hooks
• AKASHA SDK
• Live Reload - reloads the extension, on file change

Installation

Using DevContainers (Recommended)

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 (Webstorm, VSCode, Cursor, etc.).

Steps

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

Manual installation

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

Prerequisites Make sure you have yarn version 4.3.1 or newer installed

Steps

1. Install dependencies using yarn install
2. Run yarn dev to start the dev server and follow the on-screen steps to mount the extension.

Next Steps

Please follow the Setup and Development Workflow to get the extension mounted into a world.

Troubleshooting

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

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

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

• Yes you can, however you need to remove all built files (node_modules, dist etc) and build the project again before continuing