RSI Companion

A browser extension for RSI website.

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

Chrome or FireFox needs to be set-up.

Installing

Chrome:

- Download latest source code zip file.
- Extract it into a folder
- Go to chrome://extensions/
- Turn on "Developer mode"
- Click on "Load unpacked"
- Select the directory where you extracted the zip file content
- You're done

Note: Chrome will prompt you at every browser start if you really want to keep the manually installed extension. This is normal. It is a security feature of Chrome so nobody can install extensions behind your back.

FireFox:

- Download latest source code zip file.
- Extract it into a folder
- Open Firefox and open Add-ons Manager CTRL + SHIFT + A
- From the gear icon, select "Install Add-on From File..."
- Select the directory where you extracted the zip file content
- You're done

In both browsers, the application is set to start few seconds after being set-up.

Built With

• jQuery 3.4.1 - JavaScript library
• Bootstrap v4 - Front-end component library
• Bootstrap-select - jQuery plugin for cooler select elements
• Font Awesome - A font and icon toolkit

Contributing

Please read CONTRIBUTING.md for details on how you can contribute to this project.

Authors

• Kamille92 - Initial work - waibcam

See also the list of contributors who participated in this project.

License

This project is licensed under the GNU General Public License v3.0 - see the COPYING file for details