openlp/web-remote
1
0
Fork 0
mirror of https://gitlab.com/openlp/web-remote.git synced 2024-12-23 03:42:48 +00:00
Code Issues Projects Releases Wiki Activity
d9997b93d1
web-remote/docs/developer_guide.rst
Raoul Snyman 7d62bf122f
Documentation and versioning 
- Refactor and add documentation
- Pull the version number into the UI
- No need to do a yarn install before deployment in GitLab CI
- Make CI generate a version json file
2020-02-27 00:34:52 -07:00

608 B
Raw Blame History

Developer Guide

Prerequisites

In order to get started developing the web remote, you'll need to install the following on your computer:

  • NodeJS
  • NPM
  • Yarn

Get Started

Once you have the prerequisites installed, in the root directory, run the following command:

yarn install

To run the web remote, run the following command:

yarn run

To build the web remote manually for deployment:

yarn build --prod --aot

Deployment

For deployment, see the Deployment page.