Waterbus Server API

This is the server API for Waterbus. It is responsible for interacting with the database and ensuring data consistency.

Website • Wiki • License

Important

Currently, Waterbus is an early release that is subject to the following limitations: it may have limited support, changes may not be compatible with other pre-general availability versions, and availability may change without notice.

👋 Introduction

• 📺 Waterbus is open source video conferencing multiplatform app built on latest WebRTC SDK. This is server api for the application.
• 🎯 Waterbus aims for scalability and low latency as well as self-hosted and offers many useful features for everyday interviews or meetings.

📦 Requirements

Before getting started, ensure you have the following software installed:

• Node.js: (>= 18)
• NestJS CLI: (>= 9.1.7)
• Postgres
• Typesense: (26.0)

🚀 Quick start

• Clone the repository

git clone https://github.com/waterbustech/waterbus-server-api-server-api.git
cd waterbus-server-api/

• Create .env file

cp env-example .env

• Install dependencies

yarn

• Start server

yarn start

💙 Supports

Support it by joining stargazers for this repository. ⭐

Also, follow maintainers on GitHub for our next creations!

🤝 Contributing

Contributions are welcome! Please feel free to submit a pull request or open an issue if you encounter any problems or have suggestions for improvements.

🔗 Links

• 📢 waterbus.netlify.app: Home page to introduce products and features.
• 🌍 meet.waterbus.tech: Web version of waterbus with features for online meetings
• 📖 Documentation: for developers.
• 👷 Server Design: ERD, Architecture and SFU
• 🛠️ API Documentation: OpenAPI

License

Distributed under Apache 2.0.

📧 Contact Information

If you have any questions or suggestions related to this application, please contact me via email: [email protected].

Built with 💙 by the Waterbus team.