NervMag
=======

A web video magnifier using webcam.

Install
^^^^^^^

Deploy on webserver
-------------------

You need to install yarn to continue.

Go to the project directory and use following commands.

.. code-block:: sh

   yarn install
   yarn build

Just serve the `dist` directory with your web server.

Deploy on native platform with electron
---------------------------------------

TODO

.. note::

   Some binaries will be available soon.

Development
^^^^^^^^^^^

- Fork the project or create a personal branch.
- Do your stuff.
- Create unit and e2e tests if possible.
- Launch test.

.. code-block:: sh

   yarn test:unit
   yarn test:e2e

- Ask for a merge request on `master` branch.
