Documentation

Comprehensive guides and technical documentation for BarangayMS platform.

Documentation Sections

Getting Started

Initial Setup

Follow these steps to set up your barangay account:

Registration: Visit the registration page and select your subscription plan
Organization Setup: Enter your barangay information, contact details, and captain information
Payment: Complete payment through PayPal, GCash, or manual verification
Account Activation: Receive confirmation email and login credentials
Profile Configuration: Upload barangay logo and seal, configure organization settings

System Requirements

Modern web browser (Chrome, Firefox, Safari, Edge)
Stable internet connection
JavaScript enabled
Recommended screen resolution: 1024x768 or higher

User Management

User Roles

Role	Permissions	Description
Super Admin	Platform management	SaaS platform administrators
Admin	Full organization access	Barangay captains and senior officials
Clerk	Standard operations	Data entry and document generation

Adding Users

Only administrators can create new user accounts:


                            Navigate to User Management → Add User

                            Fill required fields (name, email, username, role)

                            Set secure password → Create User

Resident Database

Demographic Fields

The system tracks 14 comprehensive demographic fields:

Personal Information (name, birthdate, gender)
Address Details (house, street, purok)
Employment Status
Monthly Income Range
Educational Attainment
Family Size
Voter Registration Status

4Ps Beneficiary Status
PWD (Person with Disability)
Senior Citizen Status
Solo Parent Status
Indigent Classification
Financial Assistance Needs
Valid ID Documentation

Search and Filtering

Advanced search capabilities include:

Real-time search with 300ms debounce
Multi-field search (name, address, purok)
Demographic filtering (age groups, employment, income)
Printable filtered reports

Document Generation

Supported Documents

Certificates

Certificate of Indigency
Certificate of Residency
Good Moral Certificate
Solo Parent Certificate
No Blotter Certificate
Business Clearance
Calamity Victim Certificate

Document Authentication

All documents include professional security features:

Official barangay seals
Resident photos for identification
Professional layout design
Tamper-resistant formatting

Blotter System

Case Status Workflow

Pending Investigating Resolved or Dismissed

Evidence Management

Photo upload and gallery system
Professional image display
Secure file storage
Evidence documentation in reports

API Reference

Search Endpoints

GET /api/search-residents
Search residents with query parameter
?q=search_term&limit=10

GET /api/resident/<id>
Get detailed resident information
Returns JSON with full resident data

Response Format

{
  "residents": [
    {
      "id": 1,
      "full_name": "Juan Dela Cruz",
      "address": "123 Main St, Purok 1",
      "age": 35
    }
  ],
  "total": 1
}

Troubleshooting

Common Issues

Solution:

Check internet connection
Ensure resident has photo uploaded
Verify organization seal is uploaded
Contact support if issue persists