redash-stmo/README.rst

60 строки
1.4 KiB
ReStructuredText

Redash-STMO
===========
`Redash <https://redash.io>`_ extensions for
`sql.telemetry.mozilla.org <https://sql.telemetry.mozilla.org/>`_.
Or as it should have been called: *St. Moredash* ;)
.. image:: https://circleci.com/gh/mozilla/redash-stmo.svg?style=svg
:target: https://circleci.com/gh/mozilla/redash-stmo
.. image:: https://codecov.io/gh/mozilla/redash-stmo/branch/master/graph/badge.svg
:target: https://codecov.io/gh/mozilla/redash-stmo
.. image:: https://img.shields.io/badge/calver-YY.M.PATCH-22bfda.svg
:target: https://calver.org/
:alt: CalVer - Timely Software Versioning
Installation
------------
Please install the package using your favorite package installer::
pip install redash-stmo
Development
-----------
Running the full site please run the follow steps.
To Create the database (only once) run::
make database
To start the containers (Backend, Celery, Redis, Postgres) run::
make up
To also run the webpack devserver please run in parallel::
make devserver
To enter the container and run a bash shell run::
make bash
and then run this inside the container::
npm install
To run the tests (from the host machine) run::
make test
Issues & questions
------------------
See the `issue tracker on GitHub <https://github.com/mozilla/redash-stmo/issues>`_
to open tickets if you have issues or questions about Redash-STMO.