Skip to content

Commit

Permalink
Merge pull request #6 from GovReady/windows_docs
Browse files Browse the repository at this point in the history
Adding documentation for windows local usage
  • Loading branch information
cityinohio2019 committed Sep 30, 2020
2 parents 621bb93 + d9cf988 commit ac9b186
Showing 1 changed file with 61 additions and 3 deletions.
64 changes: 61 additions & 3 deletions source/installation-and-setup/desktop-installation/windows.rst
Original file line number Diff line number Diff line change
@@ -1,14 +1,72 @@
.. Copyright (C) 2020 GovReady PBC
.. _Windows:
.. _gitbash: https://gitforwindows.org/
.. _virtualenv: https://pypi.org/project/virtualenv/
.. _pip-tools: https://pypi.org/project/pip-tools/
.. _wkhtmltopdf: https://wkhtmltopdf.org/downloads.html


Windows
=======

GovReady-Q is designed to be installed on Unix-like operating systems.
GovReady-Q is primarily designed to be installed on Unix-like operating systems, but we include these instructions for installing GovReady-Q on Windows computers.

There are two ways to run GovReady-Q on Windows.
There are three ways to run GovReady-Q on Windows.

To try GovReady-Q, or to run it without modifications, we recommend using a container solution. See :ref:`Container-based Installation` and :ref:`Docker Local`.

For a deeper trial of GovReady-Q, or to install it for development (making changes to the source code), you should set up a Unix-like environment on your Windows computer, and then refer to :ref:`Server-based Installation`.
.. note::
For Windows, the Docker local installation guide is the same process, except for the creation of your GovReady-Q Django
Superuser account and organization. For this section you need to prepend **winpty** when using Git Bash since the
input device is not a TTY:

**winpty docker container exec -it govready-q first_run**

For a deeper trial of GovReady-Q, or to install it for development (making changes to the source code), you should set up
a Unix-like environment on your Windows computer, and then refer to :ref:`Server-based Installation`.

A third way is to build from source, using virtualenv_ and gitbash_ (included in Git for Windows).

Requirements
------------

- virtualenv_
- gitbash_
- pip-tools_
- wkhtmltopdf_


Navigate Git Bash to the root directory of govready-q-docs
----------------------------------------------------------

.. code:: bash
cd /path/to/govready-q-docs
Create and activate a virtual environment with virtualenv
---------------------------------------------------------

.. code:: bash
virtualenv venv
source venv/Scripts/activate
Install all required libraries
------------------------------

.. code:: bash
pip install -r requirements.txt
.. note::
Sample of errors when missing required libraries:

``the magic library is not contained in windows``: In Windows there is
no magic library, so make sure to ``pip install python-magic-bin``.

Run server
----------

Run the test server with ``python manage.py runserver`` and visit your GovReady-Q site in your web browser at
http://localhost:8000/

0 comments on commit ac9b186

Please sign in to comment.