Skip to content

Latest commit

 

History

History
76 lines (58 loc) · 2.42 KB

README.md

File metadata and controls

76 lines (58 loc) · 2.42 KB
Raw

incuna-surveys

Allows the creation of custom questionnaires and surveys via the admin.

Usage

Frontend

To set the apiRoot use ProjectConfigProvider.setApiRoot()

Backend

Admin

Create an admin.py with the following content:

from django.contrib import admin
from surveys.base_admin import (
    SurveyAdmin,
    SurveyFieldAdmin,
    SurveyFieldOrderingAdmin,
    SurveyFieldsetAdmin,
    SurveyFieldsetOrderingAdmin,
    UserResponseAdmin,
)
from surveys.models import (
    Survey,
    SurveyField,
    SurveyFieldOrdering,
    SurveyFieldset,
    SurveyFieldsetOrdering,
    UserResponse,
)

admin.site.register(models.SurveyField, SurveyFieldAdmin)
admin.site.register(models.SurveyFieldset, SurveyFieldsetAdmin)
admin.site.register(models.Survey, SurveyAdmin)
admin.site.register(models.SurveyFieldOrdering, SurveyFieldOrderingAdmin)
admin.site.register(models.SurveyFieldsetOrdering, SurveyFieldsetOrderingAdmin)
admin.site.register(models.UserResponse, UserResponseAdmin)

Please follow the instructions for adding languages to the projects using the parler documentation parler: https://github.com/django-parler/django-parler

Development

Frontend

All frontend is located under web/:

  • npm install to install requirements
  • bower install to install dependencies
  • grunt test to test if everything is working properly
  • grunt will start a dev server running under localhost:9000.

This project uses babel and browserify. Source files are located in web/app/scripts/src. Compiled files are put into web/dist, which is symlinked to web/app/scripts/js-build for easy testing in the browser.

Tests

The are two grunt karma targets:

  • grunt karma:dev once run will continue to watch the compiled .js files directory and the test files.
  • grunt karma:ci target only runs once. This target is also used in Travis

Releasing a new version

  1. Commit your changes.
  2. Follow the guidelines at http://semver.org/ to determine your new version number.
  3. Update CHANGELOG.md with your new version number and a description of changes.
  4. Update the version property in package.json
  5. Update the version property in setup.py
  6. Commit those changes with the commit message "Bump to [version number]". [version number] should be in the format x.y.z.
  7. git tag [version number]
  8. git push
  9. git push --tags - must be done separately.
  10. Run make release to publish the release to pypi