Home

Welcome to the Media Interface wiki!

Development

Below is valuable information for setting up your development environment.

Getting Started

First, you will need to clone the repository on your computer. Open up your command prompt, and change to the directory where you want to store the files. Then run the following command:

git clone https://github.com/RT-coding-team/mediainterface.git mediainterface

Now, change into the mediainterface directory. You will need NodeJS installed on your machine. Once installed, we no to install some global libraries:

npm install -g ionic

Once that completes, we should change to the appropriate branch to work on. main branch is the code that is pushed out to production. The develop branch is code that we are currently working on. To switch to the develop branch, run the following commands in the mediainterface directory:

git fetch
git checkout develop

Now let us install the required libraries for the project. In the mediainterface directory run the following command:

npm install

You should now download the sample content from here. Once you download the package, unzip and move the contents into the src/assets/content/ directory.

Now you need to set up the configuration files. First, let's make the required files:

cp src/environments/environment.example.ts src/environments/environment.prod.ts
cp src/environments/environment.example.ts src/environments/environment.ts

Open each file, and make any necessary changes.

Now you should be able to start the app locally. Simply run the following command:

ionic serve

Content Structure

The content for the interface uses a specific structure. Here is how the content should be stored:

|-- content
    |-- languages.json (array all the supported languages)
    |-- en (two letter code for the specific language)
        |
        |-- interface.json (all of the interface tanslations)
        |-- main.json (the main file that contains series details)
        |-- {series-slug}.json (each series has a JSON file using it's slug as the name. It stores episode details)

Happy Coding 🤓