Self hosted FLOSS fitness/workout, nutrition and weight tracker
Fixed typos
grkm71616ff783c0
diff --git a/AUTHORS.rst b/AUTHORS.rstindex fc77bdb68..9f2fb9db5 100644--- a/AUTHORS.rst+++ b/AUTHORS.rst@@ -59,6 +59,7 @@ Developers* Kristopher Newsome - https://github.com/sysadmin75* Leninux - https://github.com/RedRudeBoy* Ayush Kumar - https://github.com/gr8ayu+* Gorkem Arslan - https://github.com/gorkemarslanTranslators-----------diff --git a/docs/changelog.rst b/docs/changelog.rstindex 79e3ac7a6..a7d08de5a 100644--- a/docs/changelog.rst+++ b/docs/changelog.rst@@ -103,7 +103,7 @@ Upgrade steps from 1.9:* Moved translations to weblate `#266`_* Improved docker and docker-compose images `#340`_-* Updated many libraries to last version (bootstrap, font awesome, etc.)+* Updated many libraries to the last version (bootstrap, font awesome, etc.)* Use yarn to download CSS/JS libraries* Improvements to documentation (e.g. `#494`_)* Improved cache handling `#246`_ (thanks `@louiCoder`_)@@ -203,7 +203,7 @@ New features:Improvements:-* Improve look of weight graph (thanks `@alokhan`_) `#381`_+* Improve the look of weight graph (thanks `@alokhan`_) `#381`_* Added password validation rules for more security* Exercise image downloader checks only accepted exercises (thanks `@gmmoraes`_) `#363`_* Use a native data type for the exercises' UUID (thanks `@gmmoraes`_) `#364`_@@ -242,7 +242,7 @@ Other improvements and bugfixes: `#336`_, `#359`_,`#386`_, `#443`_.. warning ::There have been some changes to the installation procedure. Calling 'invoke'on its own has been deprecated, you should use the 'wger' command (which- accepts the same options). Also some of these commands have been renamed:+ accepts the same options). Also, some of these commands have been renamed:* ``start_wger`` to ``wger``* ``bootstrap_wger`` to ``bootstrap``@@ -290,7 +290,7 @@ Improvements:* Fields in workout log form are no longer required, making it possible to only log weight for certain exercises `#334`_* New, more verbose, API endpoint for exercises, (thanks `@andela-bmwenda`_)* The dashboard page was improved and made more user friendly `#201`_ (partly)-* Replace jquery UI's autocompleter and sortable this reduces size of JS and CSS `#78`_ and `#79`_+* Replace jquery UI's autocompleter and sortable this reduces the size of JS and CSS `#78`_ and `#79`_* Update to D3js v4 `#314`_, `#302`_* Remove hard-coded CC licence from documentation and website `#247`_@@ -363,7 +363,7 @@ New features:* Workout PDF can now print the exercises' images and comments `#261`_* Allow login with username or email (thanks `@warchildmd`_) #164`_-* Correctly use user weight when calculating nutrional plans' calories (thanks `@r-hughes`_) `#210`_+* Correctly use user weight when calculating nutritional plans' calories (thanks `@r-hughes`_) `#210`_* Fix problem with datepicker `#192`_* Order of exercises in supersets is not reverted anymore `#229`_* Improvements to the gym management:@@ -448,7 +448,7 @@ New features:* Allow users to submit corrections to exercises* Add day detail view in workout calendar `#103`_* Fix bug where the exercises added to a superset did not remain sorted `#89`_-* Reduce size of generated html code `#125`_+* Reduce the size of generated HTML code `#125`_* Allow users to copy shared workouts from others `#127`_* Added breadbrumbs, to make navigation easier `#101`_* Add option to delete workout sessions and their logs `#156`_@@ -503,7 +503,7 @@ New features:* Gym managers can create and manage gyms* Trainers can see the gym's users and their routines-* Reduce amount of CSS and JS libraries by using bootstrap as much as possible `#73`_+* Reduce the amount of CSS and JS libraries by using bootstrap as much as possible `#73`_* Improvements to the REST API `#75`_* Add read-write access@@ -638,14 +638,14 @@ New features and bugfixes:New features and bugfixes:* Add option to copy (duplicate) workouts and nutritional plans- * Login without an account with mozilla's Persona (BrowserID)- * Better AJAX handling of the modal dialogs, less page reloads and redirects+ * Login without an account with Mozilla's Persona (BrowserID)+ * Better AJAX handling of the modal dialogs, fewer page reloads and redirects* Expand the list of ingredients in German- * Add a pagination to ingredient list+ * Add pagination to the ingredient list* Improvements to user page:* Add a "reset password" link to the login page- * Email is now user editable+ * Email is now user-editable* More natural lines in weight chart with cubic interpolation@@ -666,7 +666,7 @@ New features and bugfixes:* Fix issue with password change* Small improvements to UI- * Categories editable/deletable from exercise overview page+ * Categories editable/deletable from the exercise overview page* Exercise AJAX search groups by category* More tests!* Use generic views for editing, creating and deleting objectsdiff --git a/docs/codingstyle.rst b/docs/codingstyle.rstindex d6d984d59..b71f7abe9 100644--- a/docs/codingstyle.rst+++ b/docs/codingstyle.rst@@ -6,13 +6,13 @@ Coding Style GuidePython-------Code according to PEP8, but with but with a maximum line length of 100.+Code according to PEP8, but with a maximum line length of 100.-Javascript+JavaScript-----------* Follow AirBnB ES5 style guide, with the following changes:+* Follow Airbnb ES5 style guide, with the following changes:* Disallow named function expressions, except in recursive functions, where a name is needed.* Console logging is alloweddiff --git a/docs/commands.rst b/docs/commands.rstindex e0e28513c..f9ea3551e 100644--- a/docs/commands.rst+++ b/docs/commands.rst@@ -45,13 +45,13 @@ BootstrapCommand: **bootstrap**This command bootstraps the application: it creates a settings file, initialises-a sqlite database, loads all necessary fixtures for the application to work and-creates a default administrator user. While it can also work with e.g. a postgreSQL+a SQLite database, loads all necessary fixtures for the application to work and+creates a default administrator user. While it can also work with e.g. a PostgreSQLdatabase, you will need to create it yourself::wger bootstrap-The most usual use-case is creating the settings file and the sqlite database to+The most usual use-case is creating the settings file and the SQLite database totheir default locations, but you can set your own paths if you want e.g. startdeveloping on a branch that is going to change the database schema.@@ -65,7 +65,7 @@ Usage::Options:-a STRING, --address=STRING Address to use. Default: localhost-b, --browser Whether to open the application in a browser window. Default: false- -d STRING, --database-path=STRING Path to sqlite database (absolute path recommended). Leave empty for default+ -d STRING, --database-path=STRING Path to SQLite database (absolute path recommended). Leave empty for default-p, --port Port to use. Default: 8000-s STRING, --settings-path=STRING Path to settings file (absolute path recommended). Leave empty for default@@ -80,7 +80,7 @@ Starts an already installed application::wger startPlease note that this is simply a comfort function and does not use any *magic*,-it simply calls django's development server and (optionally) opens a browser+it simply calls Django's development server and (optionally) opens a browserwindow. If you are developing, using the usual ``python manage.py runserver``is probably better.@@ -106,7 +106,7 @@ Default locationsCommand: **config-location**Information command that simply outputs the default locations for the settings-file as well as the data folder used for the sqlite database and the uploaded+file as well as the data folder used for the SQLite database and the uploadedfiles.@@ -115,14 +115,14 @@ Create settingsCommand: **create-settings**-Creates a new settings file based. If you call it without further arguments it+Creates a new settings file-based. If you call it without further arguments itwill create the settings in the default locations::wger create-settingsIf you pass custom paths, it's recommended to use absolute paths::- wger create-settings --settings-path /path/to/development/wger/settings-test.py --database-path /path/to/development/wger/database-test.sqlite+ wger create-settings --settings-path /path/to/development/wger/settings-test.py --database-path /path/to/development/wger/database-test.SQLiteUsage::@@ -133,8 +133,8 @@ Usage::Creates a local settings fileOptions:- -a STRING, --database-type=STRING Database type to use. Supported: sqlite3, postgresql. Default: sqlite3- -d STRING, --database-path=STRING Path to sqlite database (absolute path recommended). Leave empty for default+ -a STRING, --database-type=STRING Database type to use. Supported: SQLite3, postgresql. Default: SQLite3+ -d STRING, --database-path=STRING Path to SQLite database (absolute path recommended). Leave empty for default-k, --key-length Lenght of the generated secret key. Default: 50-s STRING, --settings-path=STRING Path to settings file (absolute path recommended). Leave empty for default-u STRING, --url=STRING@@ -146,7 +146,7 @@ Create or reset adminCommand: **create-or-reset-admin**-Makes sure that the default administrator user exists. If you change the password+Makes sure that the default administrator user exists. If you change the password,it is reset.@@ -245,7 +245,7 @@ Usage::Management commands--------------------wger also implements a series of django commands that perform different+wger also implements a series of Django commands that perform differentmanagement functions that are sometimes needed. Call them with``python manage.py <command_name>``:@@ -256,11 +256,11 @@ management functions that are sometimes needed. Call them with**redo-capitalize-names**re-calculates the capitalized exercise names. This command can be called if the- current "smart" capitalization algorithm is changed. This is a safe operation,+ current "smart" capitalization algorithm is changed. This is a safe operationsince the original names (as entered by the user) are still available.**submitted-exercises**- simply prints a list of user submitted exercises+ simply prints a list of user-submitted exercises**extract-i18n**extract strings from the database that have to be inserted manually in the PO@@ -289,10 +289,10 @@ similarconfigured**email-reminders**- sends out email reminders for user that need to create a new workout.+ sends out email reminders for a user that need to create a new workout.**email-weight-reminders**- sends out email reminders for user that need to enter a new (body) weight entry.+ sends out email reminders for a user that need to enter a new (body) weight entry.**inactive-members**Sends email for gym members that have not been to the gym for a specifieddiff --git a/docs/development.rst b/docs/development.rstindex 1ca864e0c..ae9f8d6b1 100644--- a/docs/development.rst+++ b/docs/development.rst@@ -34,7 +34,7 @@ Install python requirements::Install application~~~~~~~~~~~~~~~~~~~-This will download the required JS and CSS libraries and create a SQlite+This will download the required JS and CSS libraries and create an SQLitedatabase and populate it with data on the first run::@@ -42,14 +42,14 @@ database and populate it with data on the first run::$ wger bootstrap$ wger load-online-fixtures-You can of course also use other databases such as postgres or mariaDB. Create+You can of course also use other databases such as PostgreSQL or MariaDB. Createa database and user and edit the DATABASES settings before calling bootstrap.Take a look at the :ref:`prod_postgres` on apache on how that could look like.Start the server-----------------After the first run you can just use django's development server::+After the first run you can just use Django's development server::$ python manage.py runserver@@ -58,4 +58,4 @@ That's it. You can log in with the default administrator user:* **username**: admin* **password**: adminadmin-You can reset the admin's password with ``wger create-or-reset-admin``+You can reset the admin's password with ``wger create-or-reset-admin``.diff --git a/docs/docker.rst b/docs/docker.rstindex 70e64b84c..c2298603c 100644--- a/docs/docker.rst+++ b/docs/docker.rst@@ -30,8 +30,8 @@ Then just open http://localhost:8000 and log in as: **admin**, password **adminaDevelopment------------This image installs the application using virtualenv, uses a sqlite database-and serves it with django's development server.+This image installs the application using virtualenv, uses an SQLite database+and serves it with Django's development server.Get the image::@@ -45,7 +45,7 @@ Run a container and start the application::Then just open http://localhost:8000 and log in as: **admin**, password **adminadmin**-As an alternative you might want to map a local folder to the container.+As an alternative, you might want to map a local folder to the container.This is interesting if e.g. you want to keep the wger source code onyour host machine and use docker only to serve it. Then do this::diff --git a/docs/gym.rst b/docs/gym.rstindex 0b83d30d4..a18104017 100644--- a/docs/gym.rst+++ b/docs/gym.rst@@ -1,7 +1,7 @@.. _gym:-Gym admnistration-=================+Gym administration+==================wger has support for gym and member management, allowing e.g. trainers to followthe progress of their athletes and for the gym managers to keep track of the@@ -17,7 +17,7 @@ to that gym.There are 3 groups used for the different administrative roles:* **general manager:** Can manage (add, edit, delete) the different gyms for the- installation as well as add gym managers, trainers and member, but is not+ installation as well as add gym managers, trainers, and members but is notallowed to see the members' workout data.* **gym manager:** Can manage users for a single gym (editing, deactivating,adding contracts, etc.).@@ -29,7 +29,7 @@ combine all three roles into one account.Except for general managers, administrative users belong to a single gym (theone they were created in) and can access only those members. This setting cannot-be changed later. The user's gym appears in the top right menu.+be changed later. The user's gym appears in the top-right menu.Member management@@ -37,7 +37,7 @@ Member managementYou can add members to a gym by clicking the *Add member* button at the top ofthe member overview. After filling in the form, a password will be generatedfor the user. You should save this and give it to the user, as it is not possible-to retrieve it later. Alternatively you can just instruct the new members to+to retrieve it later. Alternatively, you can just instruct the new members touse the reset password links when logging in for the first time.An export of all gym members is available as well from the "actions" button on@@ -114,10 +114,10 @@ This can be configured in the following ways:**user configuration**Individual users can be opt-out of being included in the reminder emails if- they don't want to use the log or any other reason.+ they don't want to use the log for any other reason.-Gym name in header-~~~~~~~~~~~~~~~~~~+Gym name in the header+~~~~~~~~~~~~~~~~~~~~~~A checkbox to control whether the gym's name will appear in the header instead-of the application's name for all logged in users of this gym. This applies to-members, trainers and managers.+of the application's name for all logged-in users of this gym. This applies to+members, trainers, and managers.diff --git a/docs/i18n.rst b/docs/i18n.rstindex b965f28dd..406b740c2 100644--- a/docs/i18n.rst+++ b/docs/i18n.rst@@ -9,19 +9,19 @@ DjangoUpdating the translation files~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~-wger uses django's translation infrastructure, but there are a couple of things-that need to be considered. First you need to extract some translatable strings+wger uses Django's translation infrastructure, but there are a couple of things+that need to be considered. First, you need to extract some translatable stringsfrom the database such as exercise categories and muscle names::python manage.py extract-i18n-Then, update your po files with the usual django command (run this in the wger+Then, update your po files with the usual Django command (run this in the wgersub folder, not the root one)::django-admin makemessages --all --extension py,html,tpl-and finally you can compile them with::+and finally, you can compile them with::django-admin compilemessages@@ -30,7 +30,7 @@ Adding new languages~~~~~~~~~~~~~~~~~~~~Besides adding the new translations to the locale folder, they have to be-activated in the django settings file and in the application itself.+activated in the Django settings file and in the application itself... note::At the moment composed language codes such as pt-BR (Brazilian Portuguese)@@ -57,7 +57,7 @@ activated in the django settings file and in the application itself.has to be exported so the current language configuration can be reproduced.This is done with the ``filter-fixtures.py`` script:- * while in ``extras/scripts``, export the whole database to a json file with::+ * while in ``extras/scripts``, export the whole database to a JSON file with::python ../../manage.py dumpdata --indent 4 --natural-foreign > data.json@@ -68,7 +68,7 @@ activated in the django settings file and in the application itself.* copy the generated files ``languages.json`` and ``language_config.json`` tothe fixtures folder in core and config (you'll probably want to delete the- remaining json files)::+ remaining JSON files)::cp languages.json ../../wger/core/fixtures/cp language_config.json ../../wger/config/fixtures/diff --git a/docs/index.rst b/docs/index.rstindex a59c1de60..489bdda4b 100644--- a/docs/index.rst+++ b/docs/index.rst@@ -6,8 +6,8 @@Welcome to wger Workout Manager's documentation!================================================-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+wger (ˈvɛɡɐ) Workout Manager is a free, open-source web application that helps+you manage your personal workouts, weight, and diet plans and can also be usedas a simple gym management utility. It offers a REST API as well, for easyintegration with other projects and tools.@@ -65,7 +65,7 @@ issue tracker).Sources--------All the code and the content is freely available and is hosted on github:+All the code and the content is freely available and is hosted on GitHub:https://github.com/wger-project/wger@@ -81,7 +81,7 @@ Creative Commons Attribution Share-Alike 3.0 (CC-BY-SA 3.0)The documentation is released under a CC-BY-SA either version 4 of the License,or (at your option) any later version.-Some images where taken from Wikipedia, see the SOURCES file in their respective+Some images were taken from Wikipedia, see the SOURCES file in their respectivefolders for more details... include the authors file from the root folderdiff --git a/docs/installation.rst b/docs/installation.rstindex 2f76c116b..7ee3521a3 100644--- a/docs/installation.rst+++ b/docs/installation.rst@@ -7,16 +7,16 @@ You can get a local instance of wger installed in a couple of minutes.It is recommended to install a development instance or start a dockerimage if you just want to try the application on your server or PC. All-the following steps are performed on a debian based linux distribution.+the following steps are performed on a Debian-based Linux distribution.If your setup differs (e.g. in Red Hat based distros the package names areslightly different) you will need to change the steps as appropriate.The application is compatible and regularly tested with-* postgres+* PostgreSQL* python 3.6, 3.7, 3.8, 3.9 and pypy3-After installation you might also want to take a look at the :ref:`other-changes` section for other+After installation, you might also want to take a look at the :ref:`other-changes` section for otherchanges you might want to do to your local instance such as Terms of Service orcontact page.diff --git a/docs/production.rst b/docs/production.rstindex c318cd90d..d0afc7278 100644--- a/docs/production.rst+++ b/docs/production.rst@@ -67,10 +67,10 @@ Database.. _prod_postgres:-postgreSQL+PostgreSQL~~~~~~~~~~-Install the postgres server and create a database and a user::+Install the Postgres server and create a database and a user::sudo apt-get install postgresql postgresql-server-dev-12 # or appropriate versionsu - postgres@@ -82,7 +82,7 @@ You might want or need to edit your ``pg_hba.conf`` file to allow local socketconnections or similar.-sqlite+SQLite~~~~~~If using sqlite, create a folder for it (must be writable by the apache user)::diff --git a/docs/settings.rst b/docs/settings.rstindex 2008b97b1..3b2f58cb3 100644--- a/docs/settings.rst+++ b/docs/settings.rst@@ -4,10 +4,10 @@ Settings========You can configure some of the application behaviour with the ``WGER_SETTINGS``-dictionary in your settings file. Currently the following options are supported:+dictionary in your settings file. Currently, the following options are supported:**ALLOW_REGISTRATION**: Default ``True``.- Controls whether users can register on their own or if a gym adminstrator has+ Controls whether users can register on their own or if a gym administrator hasto create the user accounts.**ALLOW_GUEST_USERS**: Default ``True``.@@ -20,7 +20,7 @@ dictionary in your settings file. Currently the following options are supported:**REMOVE_WHITESPACE**: Default ``False``.Removes whitespaces around HTML tags to reduce the size of the resulting HTML.If you are not serving the site using TLS you probably want to use the GZip- middleware instead. Read the django documentation on the security implications+ middleware instead. Read the Django documentation on the security implications(BREACH attack).**EMAIL_FROM**: Default `wger Workout Manager <[email protected]>`@@ -32,5 +32,5 @@ dictionary in your settings file. Currently the following options are supported:but only the keys you need, e.g. ``WGER_SETTINGS['foo'] = 'bar'``. This avoidsproblems when new keys are added in the global settings.-Set the URL for your site in the table ``django_site``. This is ony used e.g. in+Set the URL for your site in the table ``django_site``. This is only used e.g. inthe password reset emails.diff --git a/docs/tips_and_tricks.rst b/docs/tips_and_tricks.rstindex 1b5c6ab0c..026aa8457 100644--- a/docs/tips_and_tricks.rst+++ b/docs/tips_and_tricks.rst@@ -12,8 +12,8 @@ These steps apply to all installation methods above.Upgrading the database``````````````````````-There are regularly changes and upgrades to the database schema (these may also-come from new versions of django or the installed dependencies). If you start+There are regular changes and upgrades to the database schema (these may also+come from new versions of Django or the installed dependencies). If you startthe development server and see a message that there are unapplied migrations,just do ``python manage.py migrate --all``.@@ -70,7 +70,7 @@ To properly test the different parts of the application for usability orperformance, it is often very useful to have some data to work with. For thisreason, there is a dummy data generator script inextras/dummy_generator/generator.py. It allows you to generate entries for-users, gyms, workouts and logs. For detailed usage options do::+users, gyms, workouts, and logs. For detailed usage options do::python generator.py --help@@ -93,7 +93,7 @@ as 10 nutrition diary entries per day::python generator.py nutrition-diary 10.. note::- All generated users have their username as password.+ All generated users have their username as a password... note::While it is possible to generate hundreds of users, gyms are more restricted and@@ -123,9 +123,9 @@ the core app::Using runserver_plus~~~~~~~~~~~~~~~~~~~~-During development you can use ``runserver_plus`` instead of the default django+During development, you can use ``runserver_plus`` instead of the default Djangoserver as you can use an interactive debugger directly from the browser if an-exception occurs. It also accepts the same command line options. For this just+exception occurs. It also accepts the same command-line options. For this justinstall the following packages::pip install django_extensions werkzeug@@ -136,9 +136,9 @@ Contributing------------* **Send pull requests**: for new code you want to share, please send pull- requests in github. Sending patches by email or attaching them to an issue- means a lot more of work. It's recommended that you work on a feature branch- when working on something, specially when it's something bigger. While many+ requests in GitHub. Sending patches by email or attaching them to an issue+ means a lot more work. It's recommended that you work on a feature branch+ when working on something, especially when it's something bigger. While manypeople insist on rebasing before sending a pull request, it's not necessary.* **Run the tests**: wger is proud to have a test coverage of over 90%. When you