vacansee Documentation

vacansee is a modern web application designed to help students find available rooms across campus in real-time. No more wandering the halls or checking multiple locations – get instant information about room availability right when you need it.

Built with performance and usability in mind, vacansee provides a fast, intuitive interface that works seamlessly on all devices.

The primary goal is to make finding an available room quick and effortless. Whether you need a quiet place to study, a room for a group meeting, or just want to see the campus schedule at a glance, vacansee provides the necessary tools to help you succeed.

Getting started with vacansee is simple. First, sign in using your Google or GitHub account for secure access. Once logged in, you'll find several pages to help you find available rooms:

• Available Now: View which rooms are free right now at a glance
• Available Soon: See upcoming room availability with quick filters (30m, 1h, 2h ahead)
• Check Availability: Enter a specific time to verify room availability for any moment you need
• Graph: Visualize room schedules throughout the day with interactive, color-coded timelines
• Custom Graph: Create personalized schedule views with custom filters, then export them as images
• Room Details: Browse all available spaces with complete information including capacity and location

• Real-time Availability - Check which rooms are available right now
• Future Projections - See what rooms will be available soon (30m, 1h, 2h ahead)
• Custom Time Checks - Verify availability for specific time slots
• Interactive Graphs - Visualize room schedules with color-coded availability
• Custom Graph Builder - Create personalized schedule views with filters
• Room Information - Browse complete room details including capacity
• Smart Search - Fuzzy search to find rooms quickly
• Export Capability - Save custom graphs as images
• Responsive Design - Works perfectly on desktop, tablet, and mobile
• Secure Authentication - Protected access via Google/GitHub OAuth
• Performance Optimized - Fast loading with intelligent caching

To set up the project locally for development:

1. Clone the repository from GitHub
2. Install dependencies: npm install
3. Copy .env.example to .env.local and configure
4. Generate Prisma client: npx prisma generate
5. Push schema to database: npx prisma db push
6. Run development server: npm run dev

For detailed setup instructions, see CONTRIBUTING.md on GitHub.

Schedule data is automatically updated every 4 hours via GitHub Actions workflows. This ensures the application always displays current room availability based on the latest timetable information.

The automated workflow collects timetable data, processes it, updates the database, generates optimized schedule files, and commits changes to the repository.