Traffic Track - Restaurant Seat Availability System

Overview

Traffic Track is a real-time restaurant seat monitoring system built with Next.js 13+. It allows users to check seat availability at various restaurants by viewing the live video stream of the restaurant, view menus, and provide feedback about their experience.

Features

• 🪑 Real-time seat availability monitoring
• 🍽️ Digital menu viewing system
• 📊 Visitor counting system
• 💬 Customer feedback system
• 🎨 Retro pixel art design
• 📱 Responsive layout

Tech Stack

• Framework: Next.js 13+ (App Router)
• Language: TypeScript
• Styling: Tailwind CSS
• Real-time Updates: Socket.IO
• Image Optimization: Next.js Image Component
• State Management: React Hooks

Prerequisites

• Node.js 18.17 or later
• npm or yarn
• RTSP server for streaming (for development)

Installation

1. Clone the repository:

   git clone https://github.com/yourusername/traffic-track.git
   cd traffic-track

2. Install dependencies:

   npm install
   # or
   yarn install

3. Create necessary configuration files:

   # Create a visitors.json file in the root directory
   echo '{"count": 0}' > visitors.json

4. Copy .env.example to .env and set the environment variables

    NEXT_PUBLIC_APP_URL=
    MONGODB_URI=
   

5. Start the development server:

   npm run dev:all
   # or
   yarn dev:all

Contributing

We welcome contributions to enhance Traffic Track. To contribute:

1. Fork the repository on GitHub.
2. Create a new branch for your feature or bugfix.
3. Make your changes, ensuring the code is well-commented and documented.
4. Test your changes to verify everything works as expected.
5. Submit a pull request, providing a clear description of the modifications made.

Contribution Guidelines

• Follow the existing coding style and conventions.
• Write concise, meaningful commit messages.
• Document any new methods, components, or features added.
• Ensure your code passes all tests before submitting.

Reporting Issues

If you encounter any issues or bugs with Traffic Track, please report them using the GitHub Issues tab. Provide as much detail as possible:

• A clear and descriptive title
• Steps to reproduce the issue
• Expected vs. actual behavior
• Screenshots or logs, if applicable

We appreciate your feedback and will strive to resolve issues promptly.

Brief view

License

This project is proprietary and confidential. All rights reserved.