iomirea-client

This repository contains the source code for a console client that interacts with iomirea.

Features

• View Account Information (E-Mail, Username, User ID)
• Get a list of all channels the user is in
• View messages
• Send messages

Requirements

This has been tested on Windows (10) and Linux (Raspbian) with Node.js v10.15.3 installed. Travis CI compiles every commit and pull request on Node.js v9, v10 and v11 to check if it's working. Although it should work on old versions it is recommended to use LTS.

Installation and Setup

1. Download the repository

git clone https://github.com/y21/iomirea-client

The following step(s) will only work if you have Node.js installed

2. Navigate into the cloned repository and install all required dependencies

cd iomirea-client
npm install

3. Install typescript globally if it is not installed on your machine already

npm install typescript -g

4. Transpile the source code into executable JavaScript code

If this tells you that tsc is not a recognized internal or external command, make sure tsc is set in the PATH environment variable (should not happen on Linux)
Alternatively, run the transpile script yourself with the path to tsc

npm run transpile

3. Create a file named .config if it does not exist already and add the following contents (replace token with your actual access token):

ACCESS_TOKEN=token

4. Start the application

npm run iomirea

Adding Languages

You can easily add your own language by creating a JSON file in the ./languages directory. The filename (without extension) is what you have to place in your .config file as lang.
Feel free to use en.json as template.