NOC4 Mux Controller 2022 - API
An Express app that provides data to UI License
The NOC4 Mux Controller Backend is hereby released under the Creative Commons CC BY-NC-SA 4.0 license. Please ensure you are familiar with the license before contributing to this project. A couple of key takeaways:
If you choose to share or alter this project, you MUST give credit to the contributors of this project.
You may NOT use any of this project for commercial purposes.
If you create a derivitive of this project, that project MUST be released under the same license.
https://creativecommons.org/licenses/by-nc-sa/4.0/ Contributors
The following people have contributed to this project. If you have contributed, but your name is not listed here, or if you are on this list and would like to be removed, please email the@raajpatel.com.
Raaj Patel
Thank you to all contributors, past and present. Contributing
Prerequisites:
Most recent LTS of Node.js (v16), with the corresponding version of npm/yarn.
A basic understanding of Git (branches, merge requests).
If you wish to contribute, please do the following:
Clone down the repository to your local machine.
Run "yarn install"
Run "yarn run dev"
There are no DB seeds provided with this project. If you would like to contribute, please contact Raaj for the dev DB credentials. Contributing Guidelines and Style
In order to maintain consistent code, please adhere to the following guidelines:
The master branch is protected, therefore you should always be working in a branch. Please name the branch IT-feature_name where IT is your initials and feature_name is a brief description of the feature (RP-login_form or RP-mux_stream_controller). Please make sure to follow the capitalization standards.
When you have completed your updates, push them to your branch, and then open a merge request to development in github.
Please follow the styleguide for how to format your code.
We recommend you use WebStorm/VSCode with at least the ESLint plugin installed and configured to auto-fix on save. ESLint can take care of a lot of little mistakes automatically.