Giter Club home page Giter Club logo

tobira's Introduction

Tobira: an Opencast Video Portal

CI Status License Status: alpha

The project is in its very early stages, there is nothing to see here yet.

Structure

Tobira consists of two parts:

  • frontend contains the web interface written in TypeScript/React.
  • backend contains the video portal backend written in Rust which takes care of data persistence and communication to Opencast.

How to build Tobira

1. Development Tools

Make sure you have the following tools installed:

2. Database

Tobira needs a PostgreSQL database. The scripts directory contains a container compose file to easily spin one up.

cd scripts/
# using docker
docker-compose up -d
# using podman
podman-compose up -d

Find more information in the docker compose docs.

3. GraphQL Schema

Export the current API's GraphQL schema to be used by the frontend. You need to do this whenever the API changes.

cd backend/
cargo run --bin export-schema -- ../frontend/src/schema.graphql

4. Frontend

Use npm to build the TypeScript/React based frontend.

cd frontend/
npm ci
npx relay-compiler
npm run build:dev

5. Backend

Use cargo to build and run the Rust based backend.

cd backend/
# build only
cargo build
# build and start backend server
cargo run -- serve

Auto-Rebuilds

Make sure to manually build once before trying this!

You can use floof to make builds easier. This will watch all files, recompile/build changes and provide a development server that automatically reloads Tobira.

# run floof
floof
# run with configuration file
floof -c floofy.yaml

To locally modify the workflow:

  • Copy the configuration: cp floof.yaml floofy.yaml
  • Tell git to ignore your copy: echo /floofy.yaml >> .git/info/exclude

tobira's People

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.