nervmag

A web video magnifier using webcam.

Find a file

kujiu (@havelock.kujiu.org) f96798484e First commit		2018-12-06 19:59:16 +01:00
public	First commit	2018-12-06 19:59:16 +01:00
src	First commit	2018-12-06 19:59:16 +01:00
tests	First commit	2018-12-06 19:59:16 +01:00
.browserslistrc	Initial structure	2018-11-16 23:48:42 +01:00
.gitignore	Initial structure	2018-11-16 23:48:42 +01:00
.gitlab-ci.yml	Initial structure	2018-11-16 23:48:42 +01:00
babel.config.js	First commit	2018-12-06 19:59:16 +01:00
Dockerfile	Initial structure	2018-11-16 23:48:42 +01:00
jest.config.js	Initial structure	2018-11-16 23:48:42 +01:00
LICENSE	Add LICENSE	2018-11-08 21:24:38 +01:00
package.json	First commit	2018-12-06 19:59:16 +01:00
postcss.config.js	First commit	2018-12-06 19:59:16 +01:00
README.rst	Initial structure	2018-11-16 23:48:42 +01:00
tsconfig.json	First commit	2018-12-06 19:59:16 +01:00
tslint.json	First commit	2018-12-06 19:59:16 +01:00
vue.config.js	First commit	2018-12-06 19:59:16 +01:00
yarn.lock	First commit	2018-12-06 19:59:16 +01:00

README.rst

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.