Awesome
<img src="https://raw.githubusercontent.com/cashapp/misk/master/misk.png" width="300"/>Deprecation Warning
Misk-Web is deprecated, please do not create new tabs and plan to migrate off long term.
The Misk dashboard is migrating away from a React Typescript stack to using server-side-rendered kotlinx.html using Hotwire and Tailwind CSS.
Existing Readme Below
See the project website for documentation and APIs.
Misk-Web is a micro-frontends Typescript + React web framework from Cash App.
It also happens to work seamlessly with Misk!
Quick Links
NPM Packages
NPM Package | Docs | Description |
---|---|---|
Docs | React + Typescript components and utilities | |
Docs | A simpler way to wire up interactive form, network, and other components with Redux | |
Docs | Common interfaces, colors, constants | |
Docs | Shared developer build tools | |
Docs | Shared Prettier config | |
Docs | Test libraries (Jest) and configuration | |
Docs | Standard TSLint configuration and rules | |
[Deprecated] | Migrated to @misk/core |
How to work with this repo
misk-web manages its Node installation via Hermit. Follow the Quickstart guide, then activate the hermit environment:
cd path/to/misk-web
source bin/activate-hermit
Also consider enabling Hermit shell hooks.
This repo is a monorepo managed by Rush. Using Rush allows coordinated version releases and iterative builds, among other headache-saving features. Please take time to read their documentation for other commands not described below.
Set up rush:
npm i -g @microsoft/rush
Then build everything:
# Like `npm install`, but for all packages in the repo.
rush update
# Like `npm run build`, but for all of them.
rush build