From 808cad0729f514985a5012eb5eceed1ceda59d1f Mon Sep 17 00:00:00 2001 From: Sam Date: Sat, 23 Jul 2022 11:56:03 +0200 Subject: [PATCH] update documentation --- docs/_sources/installation.rst.txt | 23 +++++++++++++++++++---- docs/installation.html | 23 ++++++++++++++++++++--- docs/searchindex.js | 2 +- docsrc/source/installation.rst | 23 +++++++++++++++++++---- 4 files changed, 59 insertions(+), 12 deletions(-) diff --git a/docs/_sources/installation.rst.txt b/docs/_sources/installation.rst.txt index 7cc2ae1a..1e88243f 100644 --- a/docs/_sources/installation.rst.txt +++ b/docs/_sources/installation.rst.txt @@ -710,16 +710,22 @@ Installation For evaluation purposes, docker files are available, installing **FitTrackee** from **sources**. -- To install **FitTrackee** with database initialisation and run the application and dramatiq workers: +- To install **FitTrackee**: .. code-block:: bash $ git clone https://github.com/SamR1/FitTrackee.git $ cd FitTrackee $ cp .env.docker .env - $ make docker-build docker-run docker-init + $ make docker-build -Open http://localhost:5000 and register. +- To initialise database: + +.. code-block:: bash + + $ docker-init + +- Open http://localhost:5000 and register. Open http://localhost:8025 to access `MailHog interface `_ (email testing tool) @@ -772,4 +778,13 @@ Development Open http://localhost:3000 .. note:: - Some environment variables need to be updated like `UI_URL` \ No newline at end of file + Some environment variables need to be updated like `UI_URL` + +- to run lint or tests: + +.. code-block:: bash + + $ make lint-client # run lint on javascript files + $ make test-client # run unit tests on Client + $ make lint-python # run type check and lint on python files + $ make test-python # run unit tests on API \ No newline at end of file diff --git a/docs/installation.html b/docs/installation.html index cdf45628..6e955415 100644 --- a/docs/installation.html +++ b/docs/installation.html @@ -996,15 +996,23 @@ server {

For evaluation purposes, docker files are available, installing FitTrackee from sources.

$ git clone https://github.com/SamR1/FitTrackee.git
 $ cd FitTrackee
 $ cp .env.docker .env
-$ make docker-build docker-run docker-init
+$ make docker-build
 
-

Open http://localhost:5000 and register.

+ +
$ docker-init
+
+
+

Open http://localhost:8025 to access MailHog interface (email testing tool)