Self hosted FLOSS fitness/workout, nutrition and weight tracker
Cleanup README
Roland Geider23a1e7be373a
diff --git a/README.md b/README.mdindex ebbdec0ea..6e37d0f20 100644--- a/README.md+++ b/README.md@@ -50,8 +50,6 @@ it is only intended as an easy to setup demo### Development version-#### Docker-We provide a docker compose file that sets everything up for development andpersists the database on a volume. From the root folder just call@@ -59,71 +57,16 @@ persists the database on a volume. From the root folder just calldocker-compose -f extras/docker/compose/docker-compose.yml up````+Log in as: **admin**, password **adminadmin**+For more info, check the [README in wger/extras/docker/compose](./extras/docker/compose/README.md).-#### Local installation (git)--**Note:** You can safely install from master, it is almost always in a usable-and stable state.---Install the necessary packages--```shell script-sudo apt-get install python3-dev nodejs npm git-sudo npm install -g yarn sass-```--Make a virtualenv where we will install the python packages--```shell script-python3 -m venv venv-wger-source venv-wger/bin/activate-```--Start the application. This will download the required JS and CSS libraries-and create a SQlite database and populate it with data on the first run. If-you want to use another database, edit the settings.py file before calling-bootstrap. You will need to create the database and user yourself.--```shell script-git clone https://github.com/wger-project/wger.git-cd wger-pip install -r requirements.txt-python3 setup.py develop-wger create-settings-wger bootstrap-wger load-online-fixtures-python3 manage.py runserver-```--Log in as: **admin**, password **adminadmin**--After the first run you just start django's development server::--```shell script-python manage.py runserver-```+#### Local installation--### Command line options--You can get a list of all available commands by calling ``wger`` without any-arguments:--* `bootstrap` Performs all steps necessary to bootstrap the application-* `config-location` Returns the default location for the settings file- and the data folder-* `create-or-reset-admin` Creates an admin user or resets the password- for an existing one-* `create-settings` Creates a local settings file-* `load-fixtures` Loads all fixtures-* `migrate-db` Run all database migrations-* `start` Start the application using django's built in webserver--To get help on a specific command: ``wger <command> --help``.+If you prefer a local installation, consult the+[development documentation](https://wger.readthedocs.io/en/latest/development.html)## Contact@@ -145,6 +88,12 @@ All the code and the content is available on github:<https://github.com/wger-project/wger>+## Translation+Translate the app to your language on [Weblate](https://hosted.weblate.org/engage/wger/).++[](https://hosted.weblate.org/engage/wger/)++## LicenseThe application is licensed under the Affero GNU General Public License 3 ordiff --git a/docs/commands.rst b/docs/commands.rstindex 87860b722..e0e28513c 100644--- a/docs/commands.rst+++ b/docs/commands.rst@@ -24,6 +24,7 @@ arguments::create-or-reset-admin Creates an admin user or resets the password for an existing onecreate-settings Creates a local settings fileload-fixtures Loads all fixtures+ load-online-fixtures Downloads fixtures from server and installs them (at the moment only ingredients)migrate-db Run all database migrationsstart Start the application using django's built-in webserver@@ -186,12 +187,12 @@ Usage::-Load all fixtures-~~~~~~~~~~~~~~~~~+Load fixtures+~~~~~~~~~~~~~Command: **load-fixtures**-Loads all fixture file with the default data. This data includes all data necessary+Loads all fixture files with the default data. This data includes all data necessaryfor the application to work such as:* exercises, muscles, equipment@@ -200,6 +201,9 @@ for the application to work such as:* permission groups* etc.+Note that ingredients are not included and need to be installed separately with+download-online-fixtures.+This command is called internally when installing the application but you can useit to reset the data to the original state. Note: new entries or user entries suchas workouts are *not* reset with this, only the application data.@@ -215,7 +219,27 @@ Usage::-s STRING, --settings-path=STRING Path to settings file (absolute path recommended). Leave empty for default+Load online fixtures+~~~~~~~~~~~~~~~~~~~~++Command: **load-online-fixtures**++Downloads ingredient and weight units fixtures and installs them. They are not+included in the repository due to size.++This command is called internally when installing the application but you can use+it to reset the data to the original state. Note: new entries or user entries such+as workouts are *not* reset with this, only the application data.++Usage::++ Usage: inv[oke] [--core-opts] load-online-fixtures [--options] [other tasks here ...]+ Docstring:+ Downloads fixtures from server and installs them (at the moment only ingredients)++ Options:+ -s STRING, --settings-path=STRING Path to settings file (absolute path). Leave empty for defaultManagement commandsdiff --git a/docs/conf.py b/docs/conf.pyindex af0288df5..4b4c2149a 100644--- a/docs/conf.py+++ b/docs/conf.py@@ -55,9 +55,9 @@ copyright = '2020, Roland Geider'# built documents.## The short X.Y version.-version = '2.0'+version = '2.1'# The full version, including alpha/beta/rc tags.-release = '2.0 alpha'+release = '2.1 alpha'# The language for content autogenerated by Sphinx. Refer to documentation# for a list of supported languages.diff --git a/docs/development.rst b/docs/development.rstindex 0991c1c9b..1ca864e0c 100644--- a/docs/development.rst+++ b/docs/development.rst@@ -9,7 +9,7 @@ and stable state.Virtual environment~~~~~~~~~~~~~~~~~~~-::+Create a new virtualenv::$ python3 -m venv venv-wger$ source venv-wger/bin/activate@@ -17,17 +17,18 @@ Virtual environmentGet the code~~~~~~~~~~~~-::++Download the source code::$ git clone https://github.com/wger-project/wger.git src$ cd srcInstall Requirements~~~~~~~~~~~~~~~~~~~~-::++Install python requirements::$ pip install -r requirements_dev.txt- $ npm install -g yarn sass$ python setup.py developInstall application@@ -57,5 +58,4 @@ That's it. You can log in with the default administrator user:* **username**: admin* **password**: adminadmin-You can start the application again with the django server with-``python manage.py runserver``.+You can reset the admin's password with ``wger create-or-reset-admin``diff --git a/docs/index.rst b/docs/index.rstindex 876b1615a..a59c1de60 100644--- a/docs/index.rst+++ b/docs/index.rst@@ -6,11 +6,10 @@Welcome to wger Workout Manager's documentation!================================================-wger is a free, open source web application that manages your exercises and-personal workouts, weight and nutrition. It can also be used as a simple gym-management utility, providing different administrative roles (trainer, manager,-etc.). It offers a REST API as well, for easy integration with other projects-and tools. It is written with python/django and uses jQuery and some D3js for charts.+wger (ˈvɛɡɐ) Workout Manager is a free, open source web application that help+you manage your personal workouts, weight and diet plans and can also be used+as a simple gym management utility. It offers a REST API as well, for easy+integration with other projects and tools.For more details and a live system, refer to the project's site:https://github.com/wger-project/wgerdiff --git a/docs/installation.rst b/docs/installation.rstindex 9586cc850..2f76c116b 100644--- a/docs/installation.rst+++ b/docs/installation.rst@@ -13,7 +13,7 @@ slightly different) you will need to change the steps as appropriate.The application is compatible and regularly tested with-* sqlite, postgres+* postgres* python 3.6, 3.7, 3.8, 3.9 and pypy3After installation you might also want to take a look at the :ref:`other-changes` section for other@@ -29,6 +29,7 @@ contact page.These are the necessary packages for both development and production::sudo apt-get install nodejs npm git python3-dev python3-venv+ sudo npm install -g yarn sass.. toctree::diff --git a/docs/production.rst b/docs/production.rstindex d1ccd89ce..c318cd90d 100644--- a/docs/production.rst+++ b/docs/production.rst@@ -66,6 +66,7 @@ Database--------.. _prod_postgres:+postgreSQL~~~~~~~~~~