Projectroles App

The projectroles app is the base app for building a SODAR Core based Django site. It provides a framework for project access management, dynamic content retrieval, models and tools for SODAR-compatible apps plus a default template and CSS layout.

Other Django apps which intend to use aforementioned functionalities depend on projectroles. While inclusion of other SODAR Core apps can be optional, having projectroles installed is mandatory for working with the SODAR Core project and app structure.

Contents:

• Basics
  • Projects
  • User Roles in Projects
  • Remote Project Sync
  • Rule System
  • App Plugins
  • Other Features
  • Templates and Styles
• Integration
  • Installation on a New Site
    • SODAR Django Site Template (Recommended)
    • Cookiecutter-Django
  • Installation on an Existing Site
    • Django Settings
    • User Configuration
    • URL Configuration
    • Base Template for Your Django Site
    • Site Error Templates
    • Site Icons
    • All Done!
• Settings
  • Site Package and Paths
  • Apps
  • Database
  • Templates
  • Email
  • Authentication
  • Icons
  • Django REST Framework
  • General Site Settings
  • Projectroles Settings
  • Optional Projectroles Settings
  • Backend App Settings
  • API View Settings (Optional)
  • LDAP/AD Configuration (Optional)
  • SAML SSO Configuration (Optional)
    • Keycloak
    • SODAR Core
  • Global JS/CSS Include Modifications (Optional)
  • Modifying SODAR_CONSTANTS (Optional)
  • Logging (Optional)
• Usage
  • Logging In
  • User Interface
    • Basics
    • Home View
    • Project Detail View
  • Category and Project Management
    • Creating a Top Level Category
    • Creating Categories and Projects
    • Updating Categories and Projects
    • Public Guest Access
    • App Settings
    • Project Archiving
  • Member Management
    • Adding Members
    • Modifying Members
    • Invites
    • Batch Member Modifications
  • Remote Projects
    • As Source Site
    • As Target Site
  • Search
  • REST API
• Customization
  • CSS Overrides
    • Static Element Coloring
    • Sidebar Width
  • Title Bar
  • Additional Title Bar Links
  • Extra Login View Content
  • Site Logo
  • Custom Icon Collections
  • Project Breadcrumb
  • Footer
  • Project and Category Display Names
• REST API Documentation
  • API Usage
    • Authentication
    • Versioning
    • Model Access and Permissions
    • Project Type Restriction
    • Return Data
  • API Views
    • ProjectListAPIView
    • ProjectRetrieveAPIView
    • ProjectCreateAPIView
    • ProjectUpdateAPIView
    • RoleAssignmentCreateAPIView
    • RoleAssignmentUpdateAPIView
    • RoleAssignmentDestroyAPIView
    • RoleAssignmentOwnerTransferAPIView
    • ProjectInviteListAPIView
    • ProjectInviteCreateAPIView
    • ProjectInviteRevokeAPIView
    • ProjectInviteResendAPIView
    • ProjectSettingRetrieveAPIView
    • ProjectSettingSetAPIView
    • UserSettingRetrieveAPIView
    • UserSettingSetAPIView
    • UserListAPIView
    • CurrentUserRetrieveAPIView
• Django API Documentation
  • Base UI View Classes
    • LoginRequiredMixin
    • LoggedInPermissionMixin
    • ProjectAccessMixin
    • ProjectPermissionMixin
    • ProjectContextMixin
    • PluginContextMixin
    • InvalidFormMixin
  • Plugins
    • BackendPluginPoint
    • ProjectAppPluginPoint
    • ProjectModifyPluginMixin
    • RemoteSiteAppPlugin
    • SiteAppPluginPoint
    • change_plugin_status()
    • get_active_plugins()
    • get_app_plugin()
    • get_backend_api()
  • Models
    • AppSetting
    • AppSettingManager
    • Project
    • ProjectInvite
    • ProjectManager
    • RemoteProject
    • RemoteSite
    • Role
    • RoleAssignment
    • SODARUser
    • get_role_project_type_default()
  • App Settings
    • AppSettingAPI
  • Common Template Tags
    • check_backend()
    • core_version()
    • force_wrap()
    • get_app_setting()
    • get_backend_include()
    • get_class()
    • get_display_name()
    • get_django_setting()
    • get_full_url()
    • get_history_dropdown()
    • get_info_link()
    • get_project_by_uuid()
    • get_project_link()
    • get_project_title_html()
    • get_remote_icon()
    • get_role_display_name()
    • get_user_by_username()
    • get_user_html()
    • get_visible_projects()
    • highlight_search_term()
    • render_markdown()
    • site_version()
    • static_file_exists()
    • template_exists()
  • Utilities
    • build_invite_url()
    • build_secret()
    • get_app_names()
    • get_display_name()
    • get_expiry_date()
    • get_user_display_name()
  • Base REST API View Classes
    • Permissions / Versioning / Rendering
    • Base API View Mixins
  • Base Ajax API View Classes
    • SODARBaseAjaxMixin
    • SODARBaseAjaxView
    • SODARBasePermissionAjaxView
    • SODARBaseProjectAjaxView
  • Base Serializers
    • SODARModelSerializer
    • SODARProjectModelSerializer
    • SODARNestedListSerializer
    • SODARUserSerializer