Skip to content

LimboChat/Limbo

Repository files navigation

Limbo v2 ⚡

Limbo is a chat app, written in Next.js and uses Socket.io for transmitting messages.

GitHub commit activity GitHub last commit

Features

  • Real-time messaging (with Socket.io)
  • User authentication and registration
  • Fast and responsive UI (with React)
  • Lightweight and scalable architecture

Technologies Used

  • Next.js: A React framework for server-side rendering and static site generation.
  • TailwindCSS: A utility-first CSS framework for quickly building custom designs.
  • Socket.io: A library that enables real-time, bidirectional and event-based communication between the browser and the server.
  • Prisma: A modern database toolkit for Node.js and TypeScript.

Deployment

Docker 🐳

Requirement: Docker, a supported database (PostgreSQL, MySQL, MariaDB, SQLite, Microsoft SQL Server, MongoDB or CockroachDB)

  1. Clone the repository:
    git clone https://github.com/chillingstar/limbo.git
  2. Change into the directory, and set the environment variables required for the app.
  3. Build the Docker image:
    docker build -t limbo .
  4. Run the Docker container:
    docker run -p 3000:3000 limbo
    or whatever port you want to assign to Limbo.

And voila! You have Limbo running on your Docker container.

Manual Deployment

Requirement: Bun, a supported database (PostgreSQL, MySQL, MariaDB, SQLite, Microsoft SQL Server, MongoDB or CockroachDB)

  1. Clone the repository:
    git clone https://github.com/chillingstar/limbo.git
  2. Change into the directory, and set the environment variables required for the app.
  3. Install the dependencies:
    bun install
  4. Build the app:
    bun run build
  5. Start the app:
    bun run start

And voila! You have Limbo running on your local machine.

Contributing

Contributions are welcome! If you find any bugs or have suggestions for improvements, please open an issue or submit a pull request.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Contributors

  • Luckless: Lead Developer, designing and developing the app.
  • Azqupai: Project Manager, managing the project and the team.
  • Yasser: Developer, helping on the development of the app.