Skip to content

README.md

Latest commit

 

History

History
113 lines (85 loc) · 3.57 KB

README.md

File metadata and controls

113 lines (85 loc) · 3.57 KB
Raw

FRA Atlas - Forest Rights Digital Atlas

ALL SERVICES ARE WORKING AND UPLOADED TO GITHUB!

This is a comprehensive digital platform for Forest Rights Act (FRA) management with blockchain verification, multilingual support (22+ tribal languages), and real-time document processing.

✅ WORKING SERVICES STATUS

Service Status Port Technology
🔗 Blockchain Service ✅ FULLY FUNCTIONAL 8001 Node.js + Express
🐍 Backend API ✅ FULLY FUNCTIONAL 3001 FastAPI + Python
⚛️ Frontend App ✅ FULLY FUNCTIONAL 3000 React.js

🚀 Quick Start

Windows

start-fra-atlas.bat

Linux/Mac

./start-fra-atlas.sh

Manual Start

# Terminal 1: Blockchain Service
cd blockchain-main && npm start

# Terminal 2: Backend Service  
cd backend-python && python server.py

# Terminal 3: Frontend
cd frontend-main && npm start

🌐 Access Points

🔍 Verified Features

Blockchain Service ✅

  • Document verification and hashing
  • Block mining and validation
  • REST API endpoints
  • Hash generation services

Backend Python Service ✅

  • FastAPI server with auto-documentation
  • Forest rights data management
  • File upload and processing
  • Authentication system
  • Works with/without MongoDB

Frontend React App ✅

  • Modern responsive UI
  • Real-time multilingual translation (22+ tribal languages)
  • LibreTranslate API integration
  • Authentication and dashboard
  • Analytics and document management

📊 Architecture

┌─────────────────┐    ┌─────────────────┐    ┌─────────────────┐
│   Frontend      │    │   Backend       │    │   Blockchain    │
│   React:3000    │───▶│   FastAPI:3001  │───▶│   Node.js:8001  │
│                 │    │                 │    │                 │
│ • UI/UX         │    │ • REST API      │    │ • Verification  │
│ • Translation   │    │ • Data Process  │    │ • Hash Services │
│ • Auth          │    │ • File Handling │    │ • Block Mining  │
└─────────────────┘    └─────────────────┘    └─────────────────┘

🔧 Technologies

  • Frontend: React 18, Tailwind CSS, LibreTranslate API
  • Backend: FastAPI, Python, Motor (MongoDB), JWT Auth
  • Blockchain: Node.js, Express, Crypto, SHA-256
  • Database: MongoDB (optional - runs in offline mode)
  • Deployment: Docker ready, environment variables

📝 Documentation

For complete documentation including:

  • API references
  • Feature details
  • Testing guides
  • Troubleshooting
  • Development guidelines

👉 See DOCUMENTATION.md - Complete comprehensive documentation

🎯 Tested & Verified

✅ All services start successfully
✅ Frontend compiles and loads
✅ Backend API responds to requests
✅ Blockchain service processes blocks
✅ Cross-service communication works
✅ Real-time translation functional
✅ Authentication system operational

🤝 Contributing

This is a production-ready Forest Rights Atlas with all core services working. The codebase is clean, documented, and ready for deployment.