This project is the starter or the showcase project of the <HxMeet> component.
It is open-source, allowing the creation of custom, tailored conferencing solutions.
Note
This is a vuejs project based on hxmeet-core-starter and it contains a server function (build with nitro) to create the livekit tokens, because the API keys and secrets should not shared on the client side.
👉 Try it out at: https://hxmeet.io
- Low-latency WebRTC video & audio
- Screen sharing
- Chat
- Different layout options
- Participant list
- Media controls (mute, camera off)
- Support keyboard shortcuts
- Dark mode
- Mobile friendly
- Themable (set your own color schema)
- Embeddable in your app or website
- Customizable
- Hook into the component events
- Add extensions
- Add test participants
- Open-source (MIT license)
- Node.js (v22 recommended)
- npm
- LiveKit account (later you can switch to an self-hosted livekit solution)
The project contains a simple start page where you enter your participant name and start a conference.
- Checkout project and install dependencies:
npm install - Copy the
.env.examplefile to.env - Enter your LiveKit API data there:
# ----------------------------------------
# Client side variables
# ----------------------------------------
# Livekit-Cloud: Go to 'Settings/Project' and take the 'Project URL'
VITE_LIVEKIT_URL=<your-livekit-url>
# ----------------------------------------
# Server side variables
# ----------------------------------------
# Livekit-Cloud: Go to 'Settings/API-Keys' and create an 'API Key'
# The NITRO_LIVEKIT_SERVICE_URL is the same as the VITE_LIVEKIT_URL but starts with 'https://'
NITRO_LIVEKIT_SERVICE_URL=<your-livekit-url>
NITRO_LIVEKIT_API_KEY=<your-livekit-api-key>
NITRO_LIVEKIT_SECRET=<your-livekit-secret>- Start the test page:
npm run dev - Open http://localhost:5173 in your browser
To invite other participants, you can share the URL (the path starts with /room/) with them.
Licensed under the MIT License.
