vaka-js

Open-source Cardano Web 3 dApps library

Stars
0
Committers
1

VakaJs

JavaScript (Typescript) & packages to help build applications that can interact with the Cardano Blockchain.

Our Mindset

Do not reinvent the wheel - If there are open source packages available that have good community support, we prefer using that and simply build layers how we see fit for our own projects.

Demo

React Component Library


How to start

This project is a monorepo managed by Yarn Workspaces.

Installation

  • Make sure you got (the latest version) of yarn npm i -g yarn.
  • Run yarn to install all dependencies and packages.

Run

React development w/ Storybook

In the root of the project, run yarn dev OR navigate to the packages/react directory and run yarn dev.

This will start a local Storybook environment where you can develop and test new components and provide them with documentation.

Technology

Core

  • Typescript
  • Development Configs
  • Services & Providers
  • React (optional) / Next.js (optional)

Tools

  • Yarn Workspaces - Link and manage workspaces and dependencies together.
  • ReactJS - A JavaScript library for building interfaces.
  • Jest - A Testing Framework with a focus on simplicity.
  • Material UI - A React Component Library based on Google's Material Design (v2)
  • Testing Library - Simple and complete testing utilities that encourage good testing practices.
  • Storybook - A JS-powered, component based styling framework - develop and view components.
  • Chromatic - Ship UIs faster with automated workflows for Storybook - deploy, review and place comments.

Packages

  • Common - Constants, Typescript Types & Utils
  • Config - Babel, ESLint, Commitlint, Prettier, Jest, Stylelint and more...
  • React - Hooks, Components, Contexts & Providers & HOCs.
  • Web3Auth - For authenticating users with Web3 wallets or email addresses (depends on API Endpoint & Database).

Docs

So much more documentation...

Related Projects