Code Monkey home page Code Monkey logo

radiodns-manager's Introduction

RadioDNS-plugit

This project gathers a web interface based on plugit to manage RadioDNS services (RadioVIS, RadioEPG and ServiceFollowing).

Check each folder for specifics README about each part.

How to run in local without installing dependencies

To start up a local demo instance

docker-compose -f docker-compose-standalone-demo.yml up --build -d

Then you may visit http://localhost:4000.

Your login credentials as admin are

admin
1234

Once you have configured the services you may test the generated metadata at http://localhost:5000/radiodns/spi/3.1/SI.xml.

To shut down the local instance

docker-compose -f docker-compose-standalone-demo.yml down

To remove the database and start afresh

docker volume rm radiodns-manager_db_data
docker volume rm radiodns-manager_mock_api_data
docker volume rm radiodns-manager_pgdata

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites

  • python 2.7 and 3.7
  • docker 18.06.1+
  • virtualenv 16.0.0+
  • docker-compose 1.23.2+

Installing

To install automatically the python environment on an unix system use the setup-envs.sh script (in the scripts folder).

On windows you'll have to setup a virtual env for the following projects (create and activate the venv + installing pip dependencies):

  • LightweightPlugitProxy (python3)
  • RadioDns-PlugIt (python2)
  • RadioVisServer (python2)
  • MockApi (python3)
  • tests (python3)

Running the dev stack

Launch the dev databases with:

docker-compose -f docker-compose-dev.yml up -d

Then head to each following folders in order and follow their README.md:

  • LightweightPlugitProxy
  • RadioDns
  • RadioVisServer
  • MockApi

The default configuration of the services should be able to make the stack run for local development.

To stop the dev databases run:

docker-compose -f docker-compose-dev.yml down

How to run tests

If you haven't already, run the setup-envs.sh (if you are on an unix based system, script located in the scripts folder). Then set your working directory to the tests folder and read its README for further instructions.

The following projects also have unit tests:

  • RadioDns-PlugIt
  • LightweightPlugitProxy

Please refer to their respective README for further instructions.

Deployment in production - EBU.io

Deployment instructions on a production server are detailed in the docs.

Deployment in production

Deployment instructions on a production server without EBU.io are detailed in the docs.

General architecture

Architecture is described in the docs

Contributing

  • Always fix version of dependencies.
  • Any new module that can be written in python 3 must be written in python 3. Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Contact

Contact the EBU (Ben Poor [email protected]) if you need more information about RadioDNS and its associated developments.

Contributors

Copyright & License

The code is under GPLv3 License. (see LICENSE.txt)

radiodns-manager's People

Contributors

barroco avatar gcmalloc avatar ioannisnoukakis avatar magicbadger avatar mhabegger avatar nickpiggott avatar the-glu avatar

Watchers

 avatar

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.