Reelevator Documentation
Complete installation, setup, and usage guide for the Reelevator Elevator Management System
Get Support
Need help? Reach out to our support team through any of these channels:
Quick responses for urgent issues
We'll respond within 24 hours
Connect with other users and get help
Dedicated support for enterprise clients
Get the latest updates and news
Professional network and careers
Support Hours
Our support team is available Monday to Friday, 9 AM - 6 PM (EST). For urgent issues outside business hours, please use WhatsApp.
What is Reelevator?
Reelevator is a comprehensive, enterprise-grade elevator management system designed to revolutionize building maintenance operations. Built with cutting-edge technologies, it provides real-time monitoring, predictive maintenance, and advanced analytics powered by IoT sensors and digital twin technology.
Core Capabilities
Business Features
Frontend
- • Next.js 16.0.3
- • React 19.2.0
- • TypeScript 5
- • Tailwind CSS 4.1.17
- • Radix UI Components
Backend
- • PostgreSQL
- • Prisma ORM 7.0.0
- • NextAuth.js 4.24.13
- • TanStack Query 5.90.10
- • Zod Validation
Services
- • Cloudinary (Media)
- • Resend (Email)
- • Vercel Analytics
- • Recharts (Charts)
- • Sonner (Notifications)
Prerequisites
Before you begin, ensure you have the following installed on your system:
Comes bundled with Node.js automatically
Verify installation:
Expected output: 10.0.0 or higher
Optional but Recommended
- • VS Code or any modern code editor
- • Cloudinary Account for image uploads (free tier available)
- • Resend Account for email notifications (free tier available)
Installation Steps
Using Git (Recommended):
Alternative: Download ZIP
- 1. Download the project as a ZIP file
- 2. Extract it to your desired location
- 3. Open terminal/command prompt in that folder
This may take a few minutes
You'll see a progress bar as packages are downloaded. This is normal and expected.
Database Setup
- 1
Create a Neon Account
Visit neon.tech and sign up for a free account
- 2
Create a New Project
Click "New Project" and give it a name (e.g., "reelevator")
- 3
Copy Connection String
Find and copy the connection string. It looks like:
postgresql://user:password@ep-cool-name-123456.us-east-2.aws.neon.tech/reelevator?sslmode=require - 4
Save for Later
Keep this connection string handy - you'll need it in the environment configuration step
- 1. Install PostgreSQL on your computer from postgresql.org
- 2. Open pgAdmin or your preferred PostgreSQL client
- 3. Create a new database:CREATE DATABASE reelevator;
- 4. Your connection string will be:postgresql://postgres:yourpassword@localhost:5432/reelevator
Environment Configuration
In the root of your project folder, create a new file named .env
Run this command in your terminal:
Copy the output and paste it as your NEXTAUTH_SECRET value
Running the Application
This command will create 30+ tables including Users, Buildings, Elevators, Tickets, and more. You'll see confirmation messages as each table is created.
This will create sample buildings, elevators, users, and tickets to help you understand the system.
Expected Output:
Navigate to: http://localhost:3000
🎉 Success!
You should now see the Reelevator landing page with the hero section, features, and services.
Key Features
Comprehensive overview of Reelevator's powerful capabilities
Real-time monitoring of elevator performance through IoT sensor integration. Track live data including:
- Floor position and movement
- Speed and direction
- Load weight monitoring
- Vibration analysis
- Temperature readings
- Door status and errors
Create virtual replicas of physical elevators for advanced simulation, analysis, and predictive modeling. Each elevator can have a 3D model representation with real-time data synchronization.
AI-powered maintenance scheduling system that prevents breakdowns before they occur:
- Automated preventive maintenance plans
- Configurable frequency and scheduling
- Task completion tracking
- Support for PREVENTIVE, CORRECTIVE, EMERGENCY, and INSPECTION types
Sophisticated permission system with 7 distinct user roles:
SUPER_ADMIN
Full system access and control
ADMIN
Administrative access with restrictions
AGENCY
Agency-level management
CONTRACTOR
Team and job management
TECH
Field technician with mobile access
SUPPLIER
Inventory management
CUSTOMER
Building owner monitoring
- Spare parts tracking with SKU management
- Stock level monitoring and reorder alerts
- Purchase order system with status tracking
- Supplier management and part catalogs
System Architecture
Core Models
- • User, Account, Session
- • Building, Elevator
- • ElevatorComponent
- • DigitalTwin
IoT & Monitoring
- • IoTSensor
- • LiveTelemetry
- • TelemetryEvent
- • HealthReport
- • ComponentHealth
Maintenance
- • MaintenanceContract
- • MaintenanceLog
- • PMPlan, PMTask
- • ComponentReplacementHistory
Business
- • Ticket, JobAssignment
- • Invoice, SLARecord
- • Agency, Contractor
- • Supplier, SparePart
API Endpoints
RESTful API with versioned endpoints under /api/v1/
User Roles & Permissions
Detailed breakdown of role-based access control (RBAC) system
- • Manage all system resources
- • Create and delete agencies
- • Access audit logs
- • System-wide configuration
- • Manage buildings and elevators
- • Create maintenance contracts
- • Assign jobs to technicians
- • View analytics and reports
- • Manage client buildings
- • Coordinate contractors
- • White-label branding
- • Client reporting
- • Manage technician teams
- • Update job status
- • View assigned buildings
- • Track maintenance logs
- • View assigned jobs
- • Log maintenance activities
- • Scan QR codes
- • Record component replacements
- • Manage spare parts catalog
- • Update purchase order status
- • Track inventory levels
- • Coordinate deliveries
- • Monitor own buildings
- • Create support tickets
- • View maintenance history
- • Access performance reports
Production Deployment
- 1.Push your code to GitHub, GitLab, or Bitbucket
- 2.Visit vercel.com and import your repository
- 3.Configure environment variables in Vercel dashboard
- 4.Deploy! Vercel will automatically build and deploy your app
Troubleshooting
Solution:
Common causes:
- • Incorrect DATABASE_URL in .env file
- • PostgreSQL not running (if using local)
- • Wrong username or password
- • IP not whitelisted (for cloud databases)
Solution:
Double-check your connection string and ensure the database is accessible
Solution:
Solution:
Quick Reference Commands
✨ Congratulations!
You've successfully installed and configured Reelevator!
You're now ready to start managing elevators efficiently with cutting-edge technology.
Happy Elevating! 🚀