2019-07-14 19:42:40 +02:00
<!DOCTYPE html>
< html xmlns = "http://www.w3.org/1999/xhtml" >
< head >
< meta charset = "utf-8" / >
2019-09-01 12:14:46 +02:00
< title > Installation — FitTrackee 0.3.0-beta
2019-08-25 22:21:09 +02:00
documentation< / title >
2019-07-14 19:42:40 +02:00
< link rel = "stylesheet" href = "_static/bootstrap-sphinx.css" type = "text/css" / >
< link rel = "stylesheet" href = "_static/pygments.css" type = "text/css" / >
2019-07-21 10:24:45 +02:00
< link rel = "stylesheet" type = "text/css" href = "_static/custom.css" / >
2019-07-14 19:42:40 +02:00
< script type = "text/javascript" id = "documentation_options" data-url_root = "./" src = "_static/documentation_options.js" > < / script >
< script type = "text/javascript" src = "_static/jquery.js" > < / script >
< script type = "text/javascript" src = "_static/underscore.js" > < / script >
< script type = "text/javascript" src = "_static/doctools.js" > < / script >
< script type = "text/javascript" src = "_static/language_data.js" > < / script >
< link rel = "index" title = "Index" href = "genindex.html" / >
< link rel = "search" title = "Search" href = "search.html" / >
< link rel = "next" title = "Features" href = "features.html" / >
< link rel = "prev" title = "FitTrackee" href = "index.html" / >
< meta charset = 'utf-8' >
< meta http-equiv = 'X-UA-Compatible' content = 'IE=edge,chrome=1' >
< meta name = 'viewport' content = 'width=device-width, initial-scale=1.0, maximum-scale=1' >
< meta name = "apple-mobile-web-app-capable" content = "yes" >
< script type = "text/javascript" src = "_static/js/jquery-1.11.0.min.js " > < / script >
< script type = "text/javascript" src = "_static/js/jquery-fix.js " > < / script >
< script type = "text/javascript" src = "_static/bootstrap-3.3.7/js/bootstrap.min.js " > < / script >
< script type = "text/javascript" src = "_static/bootstrap-sphinx.js " > < / script >
< / head > < body >
< div id = "navbar" class = "navbar navbar-default navbar-fixed-top" >
< div class = "container" >
< div class = "navbar-header" >
<!-- .btn - navbar is used as the toggle for collapsed navbar content -->
< button type = "button" class = "navbar-toggle" data-toggle = "collapse" data-target = ".nav-collapse" >
< span class = "icon-bar" > < / span >
< span class = "icon-bar" > < / span >
< span class = "icon-bar" > < / span >
< / button >
< a class = "navbar-brand" href = "index.html" >
FitTrackee< / a >
2019-09-01 12:14:46 +02:00
< span class = "navbar-text navbar-version pull-left" > < b > 0.3.0< / b > < / span >
2019-07-14 19:42:40 +02:00
< / div >
< div class = "collapse navbar-collapse nav-collapse" >
< ul class = "nav navbar-nav" >
2019-07-19 12:26:19 +02:00
< li > < a href = "https://github.com/SamR1/FitTrackee" > GitHub< / a > < / li >
2019-07-14 19:42:40 +02:00
< li class = "dropdown globaltoc-container" >
< a role = "button"
id="dLabelGlobalToc"
data-toggle="dropdown"
data-target="#"
2019-07-14 20:44:10 +02:00
href="index.html">Docs < b class = "caret" > < / b > < / a >
2019-07-14 19:42:40 +02:00
< ul class = "dropdown-menu globaltoc"
role="menu"
aria-labelledby="dLabelGlobalToc">< ul class = "current" >
< li class = "toctree-l1 current" > < a class = "current reference internal" href = "#" > Installation< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "features.html" > Features< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "api/index.html" > API documentation< / a > < / li >
2019-07-14 20:44:10 +02:00
< li class = "toctree-l1" > < a class = "reference internal" href = "troubleshooting/index.html" > Troubleshooting< / a > < / li >
2019-07-14 19:42:40 +02:00
< li class = "toctree-l1" > < a class = "reference internal" href = "changelog.html" > Change log< / a > < / li >
< / ul >
< / ul >
< / li >
< li class = "dropdown" >
< a role = "button"
id="dLabelLocalToc"
data-toggle="dropdown"
data-target="#"
href="#">Page < b class = "caret" > < / b > < / a >
< ul class = "dropdown-menu localtoc"
role="menu"
aria-labelledby="dLabelLocalToc">< ul >
< li > < a class = "reference internal" href = "#" > Installation< / a > < ul >
< li > < a class = "reference internal" href = "#prerequisites" > Prerequisites< / a > < / li >
< li > < a class = "reference internal" href = "#id1" > Installation< / a > < ul >
< li > < a class = "reference internal" href = "#dev-environment" > Dev environment< / a > < / li >
< li > < a class = "reference internal" href = "#prod-environment" > Prod environment< / a > < / li >
< / ul >
< / li >
2019-07-21 09:29:34 +02:00
< li > < a class = "reference internal" href = "#upgrade" > Upgrade< / a > < ul >
< li > < a class = "reference internal" href = "#id2" > Dev environment< / a > < / li >
< li > < a class = "reference internal" href = "#id3" > Prod environment< / a > < / li >
< / ul >
< / li >
2019-08-31 14:55:50 +02:00
< li > < a class = "reference internal" href = "#environment-variables" > Environment variables< / a > < / li >
2019-07-14 19:42:40 +02:00
< / ul >
< / li >
< / ul >
< / ul >
< / li >
< li >
< a href = "index.html" title = "Previous Chapter: FitTrackee" > < span class = "glyphicon glyphicon-chevron-left visible-sm" > < / span > < span class = "hidden-sm hidden-tablet" > « FitTrackee< / span >
< / a >
< / li >
< li >
< a href = "features.html" title = "Next Chapter: Features" > < span class = "glyphicon glyphicon-chevron-right visible-sm" > < / span > < span class = "hidden-sm hidden-tablet" > Features » < / span >
< / a >
< / li >
< li class = "hidden-sm" >
< div id = "sourcelink" >
< a href = "_sources/installation.rst.txt"
rel="nofollow">Source< / a >
< / div > < / li >
< / ul >
< form class = "navbar-form navbar-right" action = "search.html" method = "get" >
< div class = "form-group" >
< input type = "text" name = "q" class = "form-control" placeholder = "Search" / >
< / div >
< input type = "hidden" name = "check_keywords" value = "yes" / >
< input type = "hidden" name = "area" value = "default" / >
< / form >
< / div >
< / div >
< / div >
< div class = "container" >
< div class = "row" >
< div class = "body col-md-12 content" role = "main" >
< div class = "section" id = "installation" >
< h1 > Installation< a class = "headerlink" href = "#installation" title = "Permalink to this headline" > ¶< / a > < / h1 >
< p > This application is written in Python (API) and Javascript (client):< / p >
< ul class = "simple" >
< li > < dl class = "simple" >
< dt > API:< / dt > < dd > < ul >
< li > < p > Flask< / p > < / li >
< li > < p > < a class = "reference external" href = "https://github.com/tkrajina/gpxpy" > gpxpy< / a > to parse gpx files< / p > < / li >
< li > < p > < a class = "reference external" href = "https://github.com/komoot/staticmap" > staticmap< / a > to generate a static map image from gpx coordinates< / p > < / li >
< li > < p > < a class = "reference external" href = "https://github.com/ZeevG/python-forecast.io" > python-forecast.io< / a > to fetch weather data from < a class = "reference external" href = "https://darksky.net" > Dark Sky< / a > (former forecast.io)< / p > < / li >
< / ul >
< / dd >
< / dl >
< / li >
< li > < dl class = "simple" >
< dt > Client:< / dt > < dd > < ul >
< li > < p > React/Redux< / p > < / li >
< li > < p > < a class = "reference external" href = "https://leafletjs.com/" > Leaflet< / a > to display map< / p > < / li >
< li > < p > < a class = "reference external" href = "https://github.com/recharts/recharts" > Recharts< / a > to display charts with elevation and speed< / p > < / li >
< / ul >
< / dd >
< / dl >
< / li >
< / ul >
2019-07-21 09:29:34 +02:00
< p > Sports and weather icons are made by < a class = "reference external" href = "https://www.freepik.com/" > Freepik< / a > from < a class = "reference external" href = "https://www.flaticon.com/" > www.flaticon.com< / a > .< / p >
2019-07-14 19:42:40 +02:00
< div class = "section" id = "prerequisites" >
< h2 > Prerequisites< a class = "headerlink" href = "#prerequisites" title = "Permalink to this headline" > ¶< / a > < / h2 >
< ul class = "simple" >
< li > < p > PostgreSQL database (10+)< / p > < / li >
< li > < p > Python 3.7+< / p > < / li >
2019-08-31 19:11:46 +02:00
< li > < p > < a class = "reference external" href = "https://poetry.eustace.io" > Poetry< / a > < / p > < / li >
2019-07-14 19:42:40 +02:00
< li > < p > < a class = "reference external" href = "https://yarnpkg.com" > Yarn< / a > and
< a class = "reference external" href = "https://github.com/zeit/serve" > serve< / a > < / p > < / li >
< li > < p > API key from < a class = "reference external" href = "http://thunderforest.com" > ThunderForest< / a > < / p > < / li >
< li > < p > API key from < a class = "reference external" href = "https://darksky.net/dev" > Dark Sky< / a > [not mandatory]< / p > < / li >
< / ul >
< / div >
< div class = "section" id = "id1" >
< h2 > Installation< a class = "headerlink" href = "#id1" title = "Permalink to this headline" > ¶< / a > < / h2 >
< div class = "line-block" >
< div class = "line" > The following steps describe an installation on Linux systems (tested
on Debian and Arch).< / div >
< div class = "line" > On other OS, some issues can be encountered and adaptations may be
necessary.< / div >
< / div >
2019-08-31 19:11:46 +02:00
< div class = "admonition warning" >
< p class = "admonition-title" > Warning< / p >
< p > Since FitTrackee 0.2.1, Python packages installation needs Poetry. To install it on ArchLinux:< / p >
< div class = "highlight-bash notranslate" > < div class = "highlight" > < pre > < span > < / span > $ yaourt poetry
$ poetry --version
Poetry < span class = "m" > 0< / span > .12.17
< span class = "c1" > # optional< / span >
$ poetry config settings.virtualenvs.in-project < span class = "nb" > true< / span >
< / pre > < / div >
< / div >
< p > For other OS, see < a class = "reference external" href = "https://poetry.eustace.io/docs/#installation" > Poetry Documentation< / a > < / p >
< / div >
2019-07-14 19:42:40 +02:00
< div class = "section" id = "dev-environment" >
< h3 > Dev environment< a class = "headerlink" href = "#dev-environment" title = "Permalink to this headline" > ¶< / a > < / h3 >
< ul class = "simple" >
< li > < p > Clone this repo:< / p > < / li >
< / ul >
< div class = "highlight-bash notranslate" > < div class = "highlight" > < pre > < span > < / span > $ git clone https://github.com/SamR1/FitTrackee.git
$ < span class = "nb" > cd< / span > FitTrackee
< / pre > < / div >
< / div >
< ul class = "simple" >
< li > < p > Update < strong > Makefile.config< / strong > file if needed and copy/paste the
< strong > ThunderForest< / strong > and < strong > Dark Sky< / strong > API keys value in
2019-08-31 14:55:50 +02:00
< strong > Makefile.custom.config< / strong > file (see < a class = "reference external" href = "installation.html#environment-variables" > Environment variables< / a > ).< / p > < / li >
2019-07-14 19:42:40 +02:00
< li > < p > Install Python virtualenv, React and all related packages and
initialize the database:< / p > < / li >
< / ul >
< div class = "highlight-bash notranslate" > < div class = "highlight" > < pre > < span > < / span > $ make install-dev
$ make install-db
< / pre > < / div >
< / div >
< ul class = "simple" >
< li > < p > Start the server and the client:< / p > < / li >
< / ul >
< div class = "highlight-bash notranslate" > < div class = "highlight" > < pre > < span > < / span > $ make serve
< / pre > < / div >
< / div >
< p > Open < a class = "reference external" href = "http://localhost:3000" > http://localhost:3000< / a > and login (the email is < code class = "docutils literal notranslate" > < span class = "pre" > admin@ example.com< / span > < / code >
and the password < code class = "docutils literal notranslate" > < span class = "pre" > mpwoadmin< / span > < / code > ) or register< / p >
< / div >
< div class = "section" id = "prod-environment" >
< h3 > Prod environment< a class = "headerlink" href = "#prod-environment" title = "Permalink to this headline" > ¶< / a > < / h3 >
2019-07-24 16:18:38 +02:00
< div class = "admonition warning" >
< p class = "admonition-title" > Warning< / p >
< p > Note that FitTrackee is not production-ready yet< / p >
< / div >
2019-07-14 19:42:40 +02:00
< ul class = "simple" >
2019-09-01 11:40:39 +02:00
< li > < p > Download the last release (for now, it is the beta release v0.2.1):< / p > < / li >
2019-07-14 19:42:40 +02:00
< / ul >
2019-09-01 11:40:39 +02:00
< div class = "highlight-bash notranslate" > < div class = "highlight" > < pre > < span > < / span > $ wget https://github.com/SamR1/FitTrackee/archive/v0.2.1-beta.tar.gz
$ tar -xzf v0.2.1-beta.tar.gz
$ mv FitTrackee-0.2.1-beta FitTrackee
2019-07-14 19:42:40 +02:00
$ < span class = "nb" > cd< / span > FitTrackee
< / pre > < / div >
< / div >
< ul class = "simple" >
< li > < p > Update < strong > Makefile.config< / strong > file if needed and copy/paste the
< strong > ThunderForest< / strong > and < strong > Dark Sky< / strong > API keys value in
2019-08-31 14:55:50 +02:00
< strong > Makefile.custom.config< / strong > file (see < a class = "reference external" href = "installation.html#environment-variables" > Environment variables< / a > ).< / p > < / li >
2019-07-14 19:42:40 +02:00
< li > < p > Install Python virtualenv, React and all related packages and
initialize the database:< / p > < / li >
< / ul >
< div class = "highlight-bash notranslate" > < div class = "highlight" > < pre > < span > < / span > $ make install
$ make install-db
< / pre > < / div >
< / div >
< ul class = "simple" >
< li > < p > Build the client:< / p > < / li >
< / ul >
< div class = "highlight-bash notranslate" > < div class = "highlight" > < pre > < span > < / span > $ make build-client
< / pre > < / div >
< / div >
< ul class = "simple" >
< li > < p > Start the server and the client:< / p > < / li >
< / ul >
< div class = "highlight-bash notranslate" > < div class = "highlight" > < pre > < span > < / span > $ make run
< / pre > < / div >
< / div >
< p > Open < a class = "reference external" href = "http://localhost:3000" > http://localhost:3000< / a > , log in as admin (the email is
< code class = "docutils literal notranslate" > < span class = "pre" > admin@ example.com< / span > < / code > and the password < code class = "docutils literal notranslate" > < span class = "pre" > mpwoadmin< / span > < / code > ) and change the
password< / p >
< / div >
< / div >
< div class = "section" id = "upgrade" >
< h2 > Upgrade< a class = "headerlink" href = "#upgrade" title = "Permalink to this headline" > ¶< / a > < / h2 >
2019-07-21 09:29:34 +02:00
< div class = "admonition warning" >
< p class = "admonition-title" > Warning< / p >
< div class = "line-block" >
< div class = "line" > Before upgrading, make a backup of all data:< / div >
< div class = "line" > - database (with < a class = "reference external" href = "https://www.postgresql.org/docs/11/app-pgdump.html" > pg_dump< / a > for instance)< / div >
< div class = "line" > - upload directory: < strong > FitTrackee/fittrackee_api/fittrackee_api/uploads/< / strong > < / div >
< / div >
< / div >
< div class = "section" id = "id2" >
< h3 > Dev environment< a class = "headerlink" href = "#id2" title = "Permalink to this headline" > ¶< / a > < / h3 >
< ul class = "simple" >
< li > < p > Stop the application and pull the repository:< / p > < / li >
< / ul >
< div class = "highlight-bash notranslate" > < div class = "highlight" > < pre > < span > < / span > $ git pull
< / pre > < / div >
< / div >
< ul class = "simple" >
< li > < p > Update < strong > Makefile.config< / strong > and < strong > Makefile.custom.config< / strong > file if needed< / p > < / li >
2019-08-31 19:11:46 +02:00
< li > < p > Upgrade packages and database:< / p > < / li >
2019-07-21 09:29:34 +02:00
< / ul >
< div class = "highlight-bash notranslate" > < div class = "highlight" > < pre > < span > < / span > $ make install-dev
2019-08-31 19:11:46 +02:00
$ make upgrade-db
2019-07-21 09:29:34 +02:00
< / pre > < / div >
< / div >
< ul class = "simple" >
< li > < p > Restart the server and the client:< / p > < / li >
< / ul >
< div class = "highlight-bash notranslate" > < div class = "highlight" > < pre > < span > < / span > $ make serve
< / pre > < / div >
< / div >
< / div >
< div class = "section" id = "id3" >
< h3 > Prod environment< a class = "headerlink" href = "#id3" title = "Permalink to this headline" > ¶< / a > < / h3 >
2019-07-14 19:42:40 +02:00
< p > < code class = "docutils literal notranslate" > < span class = "pre" > TODO< / span > < / code > < / p >
< / div >
2019-07-21 09:29:34 +02:00
< / div >
2019-08-31 14:55:50 +02:00
< div class = "section" id = "environment-variables" >
< h2 > Environment variables< a class = "headerlink" href = "#environment-variables" title = "Permalink to this headline" > ¶< / a > < / h2 >
< p > The following environment variables must be defined in < strong > Makefile.custom.config< / strong > :< / p >
< table class = "table-bordered table-striped docutils align-default" >
< colgroup >
< col style = "width: 33%" / >
< col style = "width: 35%" / >
< col style = "width: 32%" / >
< / colgroup >
< thead >
< tr class = "row-odd" > < th class = "head" > < p > variable< / p > < / th >
< th class = "head" > < p > description< / p > < / th >
< th class = "head" > < p > app default value< / p > < / th >
< / tr >
< / thead >
< tbody >
< tr class = "row-even" > < td > < p > < code class = "docutils literal notranslate" > < span class = "pre" > REACT_APP_GPX_LIMIT_IMPORT< / span > < / code > < / p > < / td >
< td > < p > max. number of gpx file in zip archive< / p > < / td >
< td > < p > 10< / p > < / td >
< / tr >
< tr class = "row-odd" > < td > < p > < code class = "docutils literal notranslate" > < span class = "pre" > REACT_APP_MAX_SINGLE_FILE_SIZE< / span > < / code > < / p > < / td >
< td > < p > max. size of a gpx or picture file< / p > < / td >
< td > < p > 1MB< / p > < / td >
< / tr >
< tr class = "row-even" > < td > < p > < code class = "docutils literal notranslate" > < span class = "pre" > REACT_APP_MAX_ZIP_FILE_SIZE< / span > < / code > < / p > < / td >
< td > < p > max. size of a zip archive< / p > < / td >
< td > < p > 10MB< / p > < / td >
< / tr >
< tr class = "row-odd" > < td > < p > < code class = "docutils literal notranslate" > < span class = "pre" > REACT_APP_ALLOW_REGISTRATION< / span > < / code > < / p > < / td >
< td > < p > allows users to register< / p > < / td >
< td > < p > true< / p > < / td >
< / tr >
< tr class = "row-even" > < td > < p > < code class = "docutils literal notranslate" > < span class = "pre" > REACT_APP_THUNDERFOREST_API_KEY< / span > < / code > < / p > < / td >
< td > < p > ThunderForest API key< / p > < / td >
< td > < p > no defaut value, must be initialized< / p > < / td >
< / tr >
< tr class = "row-odd" > < td > < p > < code class = "docutils literal notranslate" > < span class = "pre" > WEATHER_API< / span > < / code > < / p > < / td >
< td > < p > DarkSky API key< / p > < / td >
< td > < p > no defaut value, not mandatory< / p > < / td >
< / tr >
< / tbody >
< / table >
< / div >
2019-07-14 19:42:40 +02:00
< / div >
< / div >
< / div >
< / div >
< footer class = "footer" >
< div class = "container" >
< p class = "pull-right" >
< a href = "#" > Back to top< / a >
< / p >
< p >
2019-07-21 10:53:35 +02:00
© Copyright 2018 - 2019, SamR1.< br / >
2019-12-28 21:10:51 +01:00
Created using < a href = "http://sphinx-doc.org/" > Sphinx< / a > 2.3.1.< br / >
2019-07-14 19:42:40 +02:00
< / p >
< / div >
< / footer >
< / body >
< / html >
