Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
@rolandgeider
rolandgeider committed Sep 2, 2020
1 parent feb0bd6 commit 31f10ad
Show file tree
Hide file tree
Showing 2 changed files with 49 additions and 86 deletions.
131 changes: 47 additions & 84 deletions README.rst → README.md
View file
Original file line number Diff line number Diff line change
@@ -1,110 +1,84 @@
wger
====
<img src="https://raw.githubusercontent.com/wger-project/wger/master/wger/core/static/images/logos/logo.png" width="100" height="100" />

# wger


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 a live system, refer to the project's site: https://wger.de/
For a live system, refer to the project's site: <https://wger.de/>

![Workout plan](https://raw.githubusercontent.com/wger-project/wger/master/wger/software/static/images/workout.png)

Installation
============
## Installation

These are the basic steps to install and run the application locally on a Linux
system. There are more detailed instructions, other deployment options as well
as an administration guide available at https://wger.readthedocs.io or locally
as an administration guide available at <https://wger.readthedocs.io> or locally
in your code repository in the docs folder.

Please consult the commands' help for further information and available
parameters.


Docker
------
### Docker

Useful to just try it out. Check the REAMES in wger/extras/docker on how to use
the wger/devel docker image or the docker-compose file for development::
the wger/devel docker image or the docker-compose file for development:

```shell script
docker run -ti --name wger.apache --publish 8000:80 wger/apache
```

Then just open http://localhost:8000 and log in as: **admin**, password **admin**
Then just open <http://localhost:8000> and log in as **admin**, password **admin**


Development version (from git)
------------------------------
### Development version (from git)

**Note:** You can safely install from master, it is almost always in a usable
and stable state.


1) Install the necessary packages

::

$ sudo apt-get install python3-dev nodejs npm git
$ sudo npm install -g yarn sass


Then install the python packages from pypi in the virtualenv::
Install the necessary packages

$ python3 -m venv venv-wger
$ source venv-wger/bin/activate
```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

2) 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.
```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.

$ git clone https://github.com/wger-project/wger.git
$ cd wger
$ pip install -r requirements.txt
$ python setup.py develop
$ wger create-settings
$ wger bootstrap
$ python manage.py runserver
```shell script
git clone https://github.com/wger-project/wger.git
cd wger
pip install -r requirements.txt
python setup.py develop
wger create-settings
wger bootstrap
python manage.py runserver
```

3) Log in as: **admin**, password **admin**
Log in as: **admin**, password **admin**

After the first run you just start django's development server::

$ python manage.py runserver


Stable version (from PyPI)
--------------------------

1) Install the necessary packages and their dependencies in a virtualenv

::

$ sudo apt-get install python3-dev nodejs npm git
$ sudo npm install -g yarn
$ python3 -m venv venv-wger
$ source venv-wger/bin/activate
$ pip install wger
```shell script
python manage.py runserver
```


2) 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.
Then, log in as: **admin**, password **admin**
## Command line options

::

$ wger bootstrap


3) To start the installation again, just call wger start

::

$ wger start


Command line options
--------------------
You can get a list of all available commands by calling ``wger`` without any
arguments::

Expand All @@ -120,10 +94,10 @@ arguments::
migrate-db Run all database migrations
start Start the application using django's built in webserver

You can also get help on a specific command with ``wger --help <command>``.
You can also get help on a specific command with ``wger <command> --help``.


Contact
=======
## Contact

Feel free to contact us if you found this useful or if there was something that
didn't behave as you expected. We can't fix what we don't know about, so please
Expand All @@ -135,25 +109,14 @@ file a bug anyway.
* **twitter:** https://twitter.com/wger_project


Sources
=======

All the code and the content is freely available:

* **Main repository:** https://github.com/wger-project/wger
## Sources

All the code and the content is available on github:

Donations
=========
wger is free software and will always remain that way. However, if you want to
help and support the project you are more than welcome to donate an amount of
your choice.
<https://github.com/wger-project/wger>

.. image:: https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif
:target: https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=UPMWQJY85JC5N

License
=======
## License

The application is licensed under the Affero GNU General Public License 3 or
later (AGPL 3+).
Expand Down
4 changes: 2 additions & 2 deletions setup.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
from wger import get_version


with open('README.rst') as readme:
with open('README.md') as readme:
long_description = readme.read()

with open('requirements.txt') as requirements_production:
Expand All @@ -27,7 +27,7 @@
name='wger',
description='FLOSS workout, fitness and weight manager/tracker written with Django',
long_description=long_description,
long_description_content_type='text/x-rst',
long_description_content_type='text/markdown',
version=get_version(),
url='https://github.com/wger-project',
author='Roland Geider',
Expand Down

0 comments on commit 31f10ad

Please sign in to comment.