Getting Started

Basic concepts of SODAR Core apps are detailed in this document.

NOTE: When viewing this document in GitLab critical content will by default be missing. Please click “display source” if you want to read this in GitLab.

Repository Contents

The following Django apps will be installed when installing the django-sodar-core package:

  • projectroles: Base app for project access management and dynamic app content management. All other apps require the integration of projectroles.
  • adminalerts: Site app for displaying site-wide messages to all users.
  • bgjobs: Project app for managing background jobs.
  • siteinfo: Site app for displaying site information and statistics for administrators.
  • sodarcache: Generic caching and aggregation of data referring to external services.
  • taskflowbackend: Backend app providing an API for the optional sodar_taskflow transaction service.
  • timeline: Project app for logging and viewing project-related activity.
  • userprofile: Site app for viewing user profiles.

The following packages are included in the repository for development and as examples:

  • config: Example Django site configuration
  • docs: Usage and development documentation
  • example_backend_app: Example SODAR Core compatible backend app
  • example_project_app: Example SODAR Core compatible project app
  • example_site: Example/development Django site
  • example_site_app: Example SODAR Core compatible site-wide app
  • requirements: Requirements for SODAR Core and development
  • utility: Setup scripts for development

Requirements

Major requirements for integrating projectroles and other SODAR Core apps into your Django site and/or participating in development are listed below. For a complete requirement list, see the requirements and utility directories in the repository.

  • Ubuntu 16.04 Xenial (NOTE: Older releases no longer supported)
  • Library requirements (see the utility directory and/or your own Django project)
  • Python 3.6+ (NOTE: Python 3.5 no longer supported)
  • Django 1.11.20+ (NOTE: 2.x not currently supported)
  • PostgreSQL 9.6+ and psycopg2-binary
  • Bootstrap 4.3.1
  • JQuery 3.3.1
  • Shepherd 1.8.1 with Tether 1.4.4
  • Clipboard.js 2.0.0
  • DataTables 1.10.18 with JQuery UI, FixedColumns, FixedHeader, Buttons, KeyTables

For more detailed instructions on what to install for local development, see SODAR Core Development.

Next Steps

To proceed with using the SODAR Core framework in your Django site, you must first install and integrate the projectroles app. See the projectroles app documentation for instructions.

Once projectroles has been integrated into your site, you may proceed to install other apps as needed.