Meet is a simple video and phone conferencing tool, powered by LiveKit.
Meet is built on top of Django Rest Framework and Vite.js.
Make sure you have a recent version of Docker and Docker Compose installed on your laptop:
$ docker -v
Docker version 20.10.2, build 2291f61
$ docker compose -v
docker compose version 1.27.4, build 40524192
⚠️ You may need to run the following commands with
sudo
but this can be avoided by assigning your user to thedocker
group.
Install LiveKit CLI, which provides utilities for interacting with the LiveKit ecosystem (including the server, egress, and more), please follow the instructions available in the official repository.
The easiest way to start working on the project is to use GNU Make:
$ make bootstrap FLUSH_ARGS='--no-input'
Then you can access to the project in development mode by going to http://localhost:3000. You will be prompted to log in, the default credentials are:
username: meet
password: meet
This command builds the app
container, installs dependencies, performs
database migrations and compile translations. It's a good idea to use this
command each time you are pulling code from the project repository to avoid
dependency-related or migration-related issues.
Your Docker services should now be up and running 🎉
[FIXME] Explain how to run the frontend project.
For the optimal DX, create a default project named meet
to use with livekit-cli
commands:
$ livekit-cli project add
URL: http://localhost:7880
API Key: devkey
API Secret: secret
Give it a name for later reference: meet
? Make this project default?? [y/N] y
Thus, you won't need to pass the project API Key and API Secret for each command.
You can create a basic demo site by running:
$ make demo
Finally, you can check all available Make rules using:
$ make help
You can access the Django admin site at http://localhost:8071/admin.
You first need to create a superuser account:
$ make superuser
This project is intended to be community-driven, so please, do not hesitate to get in touch if you have any question related to our implementation or design decisions.
This work is released under the MIT License (see LICENSE).