web

web copied to clipboard

@cryb/web - Web client

Docs

• Info
  • Status
• Codebase
  • Folder Structure
  • First time setup
    • Installation
  • Running the app locally
    • Background services
    • Starting @cryb/web
• Questions / Issues

Info

@cryb/web is the primary web client for interacting with Cryb instances (running in @cryb/api).

@cryb/web is used by clients to create rooms, view VM streams, control the VM and chat with other room members.

You can watch a demo of @cryb/web here.

Status

@cryb/web has been actively developed internally since August 2019, and is now open source as of October 2019.

Codebase

The codebase for @cryb/web is written in HTML and JS, utilising Vue and Nuxt.js, plus @cryb/borealis for the CSS styles.

Folder Structure

cryb/web/
├── components # The core components
├── layouts # Layouts
├── middleware # Middleware for authentication, etc
├── pages # Our main pages
├── static # Static assets such as icons and stylesheets
└── store # Our Vuex store configuration

First time setup

First, clone the @cryb/web repository locally:

git clone https://github.com/crybapp/web.git

Installation

The following services need to be installed for @cryb/web to function:

• @cryb/api

We recommend that you run the following services alongside @cryb/web, but it's not required.

• @cryb/aperture or Janus WebRTC Server

You also need to install the required dependencies by running yarn.

Ensure that .env.example is either copied and renamed to .env, or is simply renamed to .env.

In this file, you'll need some values. Documentation is available in the .env.example file.

Running the app locally

Background Services

Make sure that you have installed @cryb/api.

If you're developing a feature that requires the VM infrastructure, then make sure either @cryb/aperture or Janus WebRTC server is running.

Starting @cryb/web

To run @cryb/web in development mode, run yarn dev.

It is recommended that in production you run yarn build, then yarn start.

Questions / Issues

If you have any issues with @cryb/web, please either open a GitHub issue, contact a maintainer or join the Cryb Discord Server and ask in #tech-support.

License