AKASHAorg / akasha-core

Monorepo for the AKASHA core framework

AKASHA Core

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

Monorepo for AKASHA Core

Table of contents

• AKASHA Core
  • Table of contents
  • Background
  • Install
  • Usage
    • Run
    • Test
    • Explore
      • SDK
      • UI workspace
      • Playground test-app
    • Getting started with local development
  • Adding a new package
  • Contributors ✨
  • License

Background

AKASHA Core is one of the results of an initiative to accelerate the adoption of blockchain-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 workspace file in the root of the project.

Test

From the root of the project:

$ yarn test:<package-group>

where <package-group> can be one of apps, design-system-core, design-system-components, hooks, widgets, app-loader

To test all:

$ yarn test:all

Explore

This repository is split into three major parts:

SDK

To build the SDK, from the root of the project:

$ yarn build:sdk

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

UI workspace

• Apps
• Design system core
• Design system components
• Hooks
• Widgets
• Testing Utils
• Typings

Playground test-app

This workspace contains examples of applications that showcase the usage of AKASHA Core.

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