Lumipat sa pangunahing nilalaman

B1 Admin

Ang B1Admin ay ang dashboard ng pangangasiwa ng simbahan -- isang React single-page application na binuo gamit ang Vite at Material-UI. Ginagamit ito ng staff ng simbahan para pamahalaan ang mga tao, group, attendance, donasyon, content, at iba pa.

Bago Ka Magsimula

Setup​

1. I-clone ang repository​

git clone https://github.com/ChurchApps/B1Admin.git

2. I-install ang mga dependency​

cd B1Admin
npm install

3. I-configure ang mga environment variable​

cp dotenv.sample.txt .env

Buksan ang .env at i-configure ang mga API endpoint. Maaari mong ituro ang mga ito sa shared demo API (https://api.demo.churchapps.org) o sa iyong lokal na API instance. Maaaring may nakalista pa ring retired na staging URL ang sample file; palitan ang mga ito.

4. Simulan ang dev server​

npm start

Sisimulan nito ang Vite dev server. Magiging available ang app sa iyong browser na may hot module replacement na naka-enable.

Mga Pangunahing Environment Variable​

VariablePaglalarawan
REACT_APP_STAGEPangalan ng environment (hal., demo gaya ng nasa sample file, prod, o selfhost)
PORTPort ng dev server (default: 3101)
REACT_APP_*_APIMga URL ng API endpoint para sa bawat module
Impormasyon

Kinokopya ng postinstall script ang mga locale at CSS file mula sa @churchapps/apphelper. Kung mukhang walang style ang mga component, patakbuhin nang manu-mano ang npm run postinstall.

Mga Pangunahing Command​

CommandPaglalarawan
npm startSimulan ang Vite dev server
npm run buildProduction build gamit ang Vite
npm run testPatakbuhin ang end-to-end test gamit ang Playwright
npm run lintPatakbuhin ang ESLint na may auto-fix

Tech Stack​

  • React 19 na may TypeScript
  • Vite para sa build tooling at dev server
  • Material-UI 7 para sa mga UI component
  • React Query 5 para sa server state
  • @churchapps/apphelper* na mga package para sa mga shared component

Deployment​

Ang mga production build ay idine-deploy sa S3 + CloudFront:

  1. Ang npm run build ay gumagawa ng mga static asset
  2. Ang mga asset ay sine-sync sa isang S3 bucket
  3. Ang CloudFront invalidation ay ina-trigger para maihatid ang bagong bersyon
Tip

Para sa detalyadong instruksyon sa deployment, tingnan ang gabay na Web App Deployment.