90 lines
3.0 KiB
Markdown
90 lines
3.0 KiB
Markdown
<div align="center">
|
|
|
|
# TIS RMS
|
|
|
|
### Records Management System
|
|
|
|
**A full-stack, offline-capable platform for managing student records, documents, and OCR-powered data extraction in Philippine educational institutions.**
|
|
|
|
<br/>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
---
|
|
|
|
## ✨ Features
|
|
|
|
- 📂 **Document Management** — Upload, preview, and organize student documents (PDFs & images)
|
|
- 🎓 **Student Records** — Track enrollment status, LRN, grade level, strand, and document completion
|
|
- 🔍 **OCR Extraction** — Extract data from scanned documents via bundled Tesseract OCR (fully offline)
|
|
- 📊 **Reports** — Generate DepEd School Form 10 (SF10) for JHS & SHS using bundled Excel templates
|
|
- 🔔 **Push Notifications** — Real-time alerts via Firebase Cloud Messaging
|
|
- 🔐 **Authentication** — JWT-based sessions with bcrypt password hashing
|
|
- 🛠️ **Windows Service** — Backend can run as a persistent Windows Service via NSSM
|
|
|
|
---
|
|
|
|
## 🏗️ Architecture
|
|
|
|
Two components communicating over a local network:
|
|
|
|
- **Frontend** — Flutter multi-platform client supporting **Windows** (desktop) and **Android** (mobile), built with Riverpod, Dio, Syncfusion PDF Viewer, and Socket.IO
|
|
- **Backend** — Node.js + Express REST API with a local SQLite database, Tesseract OCR, and Ghostscript bundled for offline document processing
|
|
|
|
---
|
|
|
|
## 🚀 Getting Started
|
|
|
|
**Prerequisites:** Node.js v18+, Flutter SDK (stable), Visual Studio 2022 with C++ workload.
|
|
|
|
> Tesseract OCR and Ghostscript are bundled — no extra installation needed.
|
|
|
|
### Backend
|
|
```bash
|
|
cd backend
|
|
npm install
|
|
copy .example.env .env # configure port, JWT secret, etc.
|
|
npm run dev # or: npm start
|
|
```
|
|
|
|
### Frontend
|
|
```bash
|
|
cd frontend
|
|
flutter pub get
|
|
|
|
# Windows
|
|
flutter run -d windows
|
|
flutter build windows
|
|
|
|
# Android
|
|
flutter run -d android
|
|
flutter build apk
|
|
```
|
|
|
|
To build a Windows installer, compile `frontend/TIS_RMS_Client.iss` with **Inno Setup**, or run:
|
|
```powershell
|
|
.\build_release.ps1
|
|
```
|
|
|
|
---
|
|
|
|
## License
|
|
|
|
TIS_RMS is licensed under the GNU Affero General Public License v3.0 (AGPL-3.0).
|
|
|
|
See the [LICENSE](LICENSE) file for the full license text.
|
|
|
|
Developed by **BSIT3DSB** — PLSP.
|
|
|
|
<div align="center">
|
|
<sub>Built with ❤️ using Flutter & Node.js · TIS Records Management System</sub>
|
|
</div>
|