Skip to content

Latest commit

 

History

History
61 lines (47 loc) · 1.54 KB

README.md

File metadata and controls

61 lines (47 loc) · 1.54 KB
Raw

Jitsi Meet API library

You can use Jitsi Meet API to create Jitsi Meet video conferences with a custom GUI.

Installation

Building the sources

NOTE: you need Node.js >= 12 and npm >= 7

To build the library, just type:

npm install
npm run build

To lint:

npm run lint

and to run unit tests:

npm test

if you need to rebuild lib-jitsi-meet.min.js

npm run build

Both linting and units will also be done by a pre-commit hook.

How to run and test the library locally:

To test this library, you will need https://github.com/jitsi/jitsi-meet. There is a pretty good tutorial in jitsi docs https://jitsi.github.io/handbook/docs/dev-guide/dev-guide-web-jitsi-meet.

Here is a resume of how you can run your own environment:

  1. Create a folder called meet or whatever you want to call this project.

  2. Clone this repository.

  3. Run cd lib-jitsi-meet to move to the folder.

  4. Run the commands below to create a link to your local library and build it.

    npm install 
npm link
npm run build

  5. Run cd ..

  6. Go to https://github.com/jitsi/jitsi-meet and clone the repository.

  7. Run cd jitsi-meet

  8. Run npm link lib-jitsi-meet

    npm link lib-jitsi-meet 
npm install
make dev

If you want to make changes to only lib-jitsi-meet, you need to run npm run build and restart the make dev process. Otherwise, the changes you made to the library are not going to be shown in the app.