Merge pull request #110 from ryanwilsonperkin/docker-sample-project

Use Docker for the sample project

Dockerfile

@@ -0,0 +1,6 @@
+FROM python
+COPY . /app
+WORKDIR /app/sample_project
+RUN pip install -r requirements.txt
+RUN python manage.py migrate
+CMD ["python", "manage.py", "runserver", "0.0.0.0:8000"]

README.rst

@@ -270,25 +270,21 @@ Currently there is only one "paid" check - ``watchman.checks.email``. You can
 enable it by setting the ``WATCHMAN_ENABLE_PAID_CHECKS`` to ``True``, or by
 overriding the ``WATCHMAN_CHECKS`` setting.
 
-Trying it out with Vagrant
+Trying it out with Docker
 --------------------------
 
-A sample project is available along with a Vagrantfile to make it easy to try
+A sample project is available along with a Dockerfile to make it easy to try
 out django-watchman.
 
 Requirements
 ************
 
-* `Vagrant <https://www.vagrantup.com/>`_
-* `Virtualbox <https://www.virtualbox.org/>`_
-* `Ansible <http://www.ansible.com/>`_
+* `Docker <https://www.docker.com/get-docker>`
 
 Instructions
 ************
 
-1. Launch vagrant box: ``vagrant up``
-2. SSH into vagrant: ``vagrant ssh``
-3. Activate the virtualenv: ``workon watchman``
-4. Launch the development server: ``python manage.py runserver 0.0.0.0:8000``
-5. Visit watchman json endpoint in your browser: http://127.0.0.1:8000/watchman/
-6. Visit watchman dashboard in your browser: http://127.0.0.1:8000/watchman/dashboard/
+1. Build the Docker image with the current local code: `docker build -t watchman .`
+2. Launch the Docker image: `docker run -it -p 8000:8000 watchman`
+3. Visit watchman json endpoint in your browser: http://127.0.0.1:8000/watchman/
+4. Visit watchman dashboard in your browser: http://127.0.0.1:8000/watchman/dashboard/

sample_project/requirements.txt

@@ -1,4 +1,4 @@
 django<1.9
 
 # django-watchman
--e /vagrant/
+-e /app