@eryxcoop/appyx-front
v0.0.1
Published
Reusable frontend machinery: Feature/Screen with MobX, forms, session-aware requester, and Application/Session bases
Keywords
Readme
@eryxcoop/appyx-front
Reusable frontend machinery: Feature/Screen with MobX, forms (data layer + MUI UI), session-aware requester, and base classes for Application/Session/Auth.
Complements @eryxcoop/appyx-comm
(HTTP layer) with the presentation/architecture layer.
Install
npm install @eryxcoop/appyx-frontRequired peer deps: react ^18, react-dom ^18, mobx ^6, mobx-react ^9,
@eryxcoop/appyx-comm ^1.0.7, firebase ^11.
To use the UI layer (/mui-fields), also install: @mui/material ^5,
@mui/icons-material ^5, @mui/x-date-pickers ^6, and optionally
@react-google-maps/api.
Usage
// Core
import {
Feature, useFeature,
Form, FormField, TextField, EmailField,
SessionAwareRequester,
Application, Session, ApplicationProvider, useApplication,
} from '@eryxcoop/appyx-front';
// MUI UI
import {
FormTextField, FormEmailField, FormFileField, FormAutocompleteField,
} from '@eryxcoop/appyx-front/mui-fields';Example
A runnable Vite + React + MUI skeleton lives in examples/welcome-app/.
It wires Application, Session, a Feature with a Form, and a mock
ApiClient to show the full integration path.
To run it from a fresh clone:
cd examples/welcome-app
npm install
npm run dev
# open http://localhost:5173/The package source itself doesn't need to be built (the example aliases
@eryxcoop/appyx-front to the source via Vite). See the
example's README for the full walkthrough,
the architecture diagram, and troubleshooting tips.
Tests
npm test