Getting Started

This document provides instructions and guidelines for integrating projectroles and other SODAR Core apps into your Django site. Whether you want to set up a new Django site, or integrating the projectroles app into an existing site, you can follow one of the recommended options in this section.

Requirements

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

Ubuntu/Debian (Ubuntu 24.04 LTS recommended and supported for development)
System library requirements (see the utility directory and/or your own Django project)
Python 3.11-3.13 (3.13 recommended)
Django 5.2
PostgreSQL >=12 (16 recommended) and psycopg2-binary
Bootstrap 4.x
JQuery 3.3.x
Shepherd and Tether
Clipboard.js
DataTables

For more details on installation and requirements for local development, see Development Installation.

Installation

This section shows three methods to start using SODAR Core.

SODAR Django Site Template (Recommended)

When setting up a new SODAR Core based site, it is strongly recommended to use sodar-django-site as the template. The repository contains a minimal Django site pre-configured with projectroles and other SODAR Core apps. The main branch of this project always integrates the latest stable release of SODAR Core and projectroles.

To set up your site with this template, clone the repository and follow the installation instructions in the README.rst file.

Cookiecutter-Django

If the SODAR Django site template does not suit your needs, it is also possible to set up your site using cookiecutter-django. In this case, follow the instructions in the integration documentation as if you were integrating SODAR Core to an existing Django site.

Note

The project was created using an old version of the cookiecutter script and evolved from there. This means the site created by the version currently may differ in several ways from how SODAR Core is set up. This method is recommended only for experienced Django developers.

Note

For any other issues regarding the cookiecutter-django setup, see the cookiecutter-django documentation.

Integration to an Existing Site

If you already have a working site and want to migrate it to using SODAR Core, see the integration documentation.

Next Steps

You are now ready to develop your Django site using the SODAR Core framework. You can start by configuring the Projectroles App and, optionally, the other built-in apps. To modify default SODAR Core and projectroles settings, see the Projectroles Django Settings document. For customizing the look and feel of your site, check out the customization tips.

Later on, you may proceed to install or develop other apps as needed (see the Site Development document for instructions).