django-careers 0.1

Home-page: https://github.com/theartling/django-careers
Author: Martin Brochhaus
Author-email: mbrochh@gmail.com
License: The MIT License
Description: Django Careers
==============

A simple app to render a careers-page on your website.

You can use the Django admin to create job offers via Markdown. You can see
the result in action at https://theartling.com/careers/

Installation
------------

To get the latest stable release from PyPi

.. code-block:: bash

pip install django-careers

To get the latest commit from GitHub

.. code-block:: bash

pip install -e git+git://github.com/theartling/django-careers.git#egg=careers

Add ``careers`` to your ``INSTALLED_APPS``

.. code-block:: python

INSTALLED_APPS = (
...,
'careers',
)

Add the ``careers`` URLs to your ``urls.py``

.. code-block:: python

urlpatterns = [
url(r'^careers/', include('careers.urls')),
]

This app has [django-markdown-app](https://github.com/sv0/django-markdown-app)
as a dependency, so please have a look at their repo and follow their
installation instructions.

Don't forget to migrate your database

.. code-block:: bash

./manage.py migrate careers


Usage
-----

Simply visit the django admin and start creating `CareerPosition` objects.

Local Test
----------

If you want to give app a quick try on your local machine, you can do the
following:

.. code-block:: bash

mkvirtualenv -p python2.7 django-careers
pip install -r requirements.txt
pip install -r test_requirements.txt
./manage.py migrate
./manage.py createsuperuser
./manage.py runserver
# browse to the admin and create some objects
# browse to /careers/


Contribute
----------

If you want to contribute to this project, please perform the following steps

.. code-block:: bash

# Fork this repository
# Clone your fork
mkvirtualenv -p python2.7 django-careers
make develop

git co -b feature_branch master
# Implement your feature and tests
git add . && git commit
git push -u origin feature_branch
# Send us a pull request for your feature branch

In order to run the tests, simply execute ``tox``. This will install two new
environments (for Django 1.8 and Django 1.9) and run the tests against both
environments.

If tox throws errors, you can also run the tests via ``./runtests.py``

Keywords: django,app,reusable,careers
Platform: OS Independent