This folder contains everything that makes up Flagbase UI. It contains reusable UI components and app-specific code.
- components: dumb UI components (purely functional)
- app: where app specific code sits
- containers: UI components connected to state / API
- pages: composition of containers / components that make up a page
- electron: electron related setup files
- webpack: webpack related configuration files
npm install
In order to run this project 2 scripts will need to be executed dev:react
and dev:electron
, run each one in a different terminal and always run dev:react
before dev:electron
, or dev
to run them in order automatically
npm run dev:react
npm run dev:electron
or
npm run dev
Run storybook locally using:
npm run storybook
You can view it here: http://localhost:6006/
To generate a project package run package
npm run package
We encourage community contributions via pull requests. Before opening up a PR, please read our contributor guidelines.
Check out these pages that'll help you get started, if you want to contribute to the UI:
- UI Dev Guides: Building & running locally / Architecture etc
- UI RFCs: Technical RFCs / Proposals etc