B1 Admin
B1Admin is the church administration dashboard -- a React single-page application built with Vite and Material-UI. Church staff use it to manage people, groups, attendance, donations, content, and more.
Before You Begin
- Install Node.js 22+ and Git -- see Prerequisites
- Configure your API target (demo or local) -- see Environment Variables
Setup
1. Clone the repository
git clone https://github.com/ChurchApps/B1Admin.git
2. Install dependencies
cd B1Admin
npm install
3. Configure environment variables
cp dotenv.sample.txt .env
Open .env and configure the API endpoints. You can point them at either the shared demo API (https://api.demo.churchapps.org) or your local API instance. The sample file may still list retired staging URLs; replace them.
4. Start the dev server
npm start
This launches the Vite dev server. The app will be available in your browser with hot module replacement enabled.
Key Environment Variables
| Variable | Description |
|---|---|
REACT_APP_STAGE | Environment name (e.g., demo as in the sample file, prod, or selfhost) |
PORT | Dev server port (default: 3101) |
REACT_APP_*_API | API endpoint URLs for each module |
The postinstall script copies locale and CSS files from @churchapps/apphelper. If components look unstyled, run npm run postinstall manually.
Key Commands
| Command | Description |
|---|---|
npm start | Start Vite dev server |
npm run build | Production build via Vite |
npm run test | Run end-to-end tests with Playwright |
npm run lint | Run ESLint with auto-fix |
Tech Stack
- React 19 with TypeScript
- Vite for build tooling and dev server
- Material-UI 7 for UI components
- React Query 5 for server state
@churchapps/apphelper*packages for shared components
Deployment
Production builds are deployed to S3 + CloudFront:
npm run buildgenerates static assets- Assets are synced to an S3 bucket
- CloudFront invalidation is triggered to serve the new version
For detailed deployment instructions, see the Web App Deployment guide.