59 lines
1.4 KiB
Markdown
59 lines
1.4 KiB
Markdown
# Africa Alert - Smart School PWA
|
|
|
|
Modern React PWA school management system with Node.js backend, containerized for easy Docker deployment.
|
|
|
|
## Features
|
|
|
|
- 📱 **Progressive Web App** - Installable on any device, works offline
|
|
- 🐳 **One-Click Docker Setup** - Single `docker-compose up` to get started
|
|
- 👨🎓 **Student Management** - Enrollment, profiles, attendance
|
|
- 👩🏫 **Teacher Management** - Staff profiles, assignments
|
|
- 📚 **Class Management** - Subjects, schedules, grading
|
|
- 💰 **Fee Management** - Invoices, payments, reporting
|
|
- 📊 **Dashboard** - Real-time analytics and insights
|
|
|
|
## Quick Start
|
|
|
|
```bash
|
|
# Clone and start
|
|
cd africa-alert-pwa
|
|
docker-compose up -d
|
|
|
|
# Access the app at http://localhost:3000
|
|
```
|
|
|
|
## Tech Stack
|
|
|
|
- **Frontend**: React 18 + Vite + TypeScript
|
|
- **Backend**: Node.js + Express
|
|
- **Database**: SQLite (file-based, easy backups)
|
|
- **Container**: Docker + Docker Compose
|
|
|
|
## Project Structure
|
|
|
|
```
|
|
africa-alert-pwa/
|
|
├── client/ # React frontend
|
|
├── server/ # Node.js backend
|
|
├── docker-compose.yml
|
|
├── Dockerfile.client
|
|
└── Dockerfile.server
|
|
```
|
|
|
|
## Development
|
|
|
|
```bash
|
|
# Frontend (client folder)
|
|
cd client && npm install && npm run dev
|
|
|
|
# Backend (server folder)
|
|
cd server && npm install && npm run dev
|
|
|
|
# Docker
|
|
docker-compose up --build
|
|
```
|
|
|
|
## Default Login
|
|
|
|
- **Admin**: admin@school.com / admin123
|