AKASHA Framework

App	Staging	Production
Ethereum World	https://next.akasha-world-framework.pages.dev/	https://akasha.ethereum.world/
Storybook		NA

Monorepo for AWF

Table of contents

• Background
• Install
• Usage
  • SDK
    • Package Components
    • Build
  • UI
  • Examples
  • Server Scripts
• Contributors
• License

Background

AWF is one of the results of initiative to accelerate the adoption of Ethereum-based apps and services by transforming how they attract, engage and delight users.

Install

This project uses node and yarn.

From the root of this project:

$ yarn bootstrap
$ yarn build:all

Usage

For a definitive guide on all available scripts, check out Scripts-Guide

Run

For development purposes, from the root of this project:

$ yarn start:feed-app

To watch for changes in dependent packages

$ AWF_PACKAGE=<package-name> yarn pack:watch

You can check which packages are available in the workspaces.json file in the root of the project.

This repository is split into four lerna workspaces:

SDK

Build the sdk package

From the root of the project:

$ yarn build:sdk

This will create under the akasha package repo a folder dist that contains the built files.

Running Tests

From the root of the project:

$ yarn build:test
$ yarn test:<package-group>

where <package-group> can be one of apps, widgets, plugins, design-system, hooks

UI workspace

• Design system
• React hooks
• Plugins
• Widgets
• Apps

Playground test-app

This workspace contains examples of applications that showcase the usage of AWF.

Getting started with local development

Follow the steps described here

Adding a new package

1. in the root package.json add the package to the workspace package list
2. in the root package.json create scripts to build it ex: "pack:ui-design": "nx run @akashaorg/design-system:build"
3. in the root package.json add it to build process in scripts, for example in the pack:ui script
4. add it to tsconfig.json
5. add it to workspace.json
6. add it to tsconfig.typedoc.json

Contributors ✨

Thanks goes to these wonderful people (emoji key):

Vali Cotea 💻 🚧 📖 👀 💡	Sever Abibula 💻 🚧 📖 👀 💡	Marius Darila 💻 🚧 📖 👀 💡 🚇	Mihai Alisie 🤔 💵 📝 📢	Martin Etzrodt 📓 📢 🔍	Mariana Gomes 🎨 📹	Josemaria Nriagu 💻 🚧 📖 👀
Andrei 💻 📖	Damir Sabolic 💻 📖 ⚠️	didd 💻 ⚠️	Basma ️️️️♿️ 🎨 📓	Quynh Yen Vo T. 💻

This project follows the all-contributors specification. Contributions of any kind welcome!

License

AGPL-3.0 © AKASHA Foundation