Skip to content

ammsa/django-resumator

Repository files navigation

===== django-resumator ===== pypi Build Status - master branch

django-resumator is a lightwight app to create web-based resumes. Please visit theresumator for a django project that uses it.

installation -----------

pip install django-resumator

or

python setup.py install

Quick start

  1. Add "resumator" to your INSTALLED_APPS setting like this:

    INSTALLED_APPS = (
           ...
           'resumator',
    )
  2. Add the following to your setting.py:

    MEDIA_ROOT = os.path.join(BASE_DIR, 'site_media')
    MEDIA_URL = '/media/'
  3. Include the resumator URLconf in your project urls.py and add MEDIA URL to urlpatterns like this (Note: Don't do this in production):

    from django.conf import settings
    from django.conf.urls.static import static
    
    urlpatterns = [
        ...
        url(r'^resume/', include('resumator.urls')),
        ...
    ] + static(settings.MEDIA_URL, document_root=settings.MEDIA_ROOT)
  4. Run python manage.py migrate to create the resumator models.
  5. Start the development server and visit http://127.0.0.1:8000/admin/ to modify your basic information model and edit your resume (you'll need the Admin app enabled).
  6. Visit http://127.0.0.1:8000/resume/ to see your resume.

Contributing -----------

  1. Fork it!
  2. Create your feature branch: git checkout -b my-new-feature
  3. Commit your changes: git commit -am 'Add some feature'
  4. Push to the branch: git push origin my-new-feature
  5. Submit a pull request :D

License

All parts of theresumator are free to use and abuse under the open-source MIT license.