mirror of
https://gitlab.com/openlp/web-remote.git
synced 2024-12-23 11:52:49 +00:00
Raoul Snyman
7d62bf122f
- 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
44 lines
608 B
ReStructuredText
44 lines
608 B
ReStructuredText
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:
|
|
|
|
.. code::
|
|
|
|
yarn install
|
|
|
|
|
|
To run the web remote, run the following command:
|
|
|
|
.. code::
|
|
|
|
yarn run
|
|
|
|
|
|
To build the web remote manually for deployment:
|
|
|
|
.. code::
|
|
|
|
yarn build --prod --aot
|
|
|
|
|
|
Deployment
|
|
----------
|
|
|
|
For deployment, see the `Deployment`_ page.
|
|
|
|
|
|
.. _Deployment: docs/deployment.rst
|