Skip to content

Latest commit

 

History

History
241 lines (175 loc) · 7.46 KB

README.md

File metadata and controls

241 lines (175 loc) · 7.46 KB
Raw

volunteers.joomla.org

This is the repository of the website volunteers.joomla.org. This websites runs on a default Joomla! installation extended with a custom component called com_volunteers. Your ideas, feature requests, bug reports and code contributions are welcome!

Bugs, ideas & feature requests

Please use the Issue tracker to report bugs, ideas and feature requests.

Contributing code

Code contributions are very welcome! Browse the Issue tracker for issues that need code and/or come up with your own ideas & code. Please open a Pull Request to contribute your own code.

Local Development

You can fork & clone the repository for local development. To get started you need to:

  • Clone the repository
  • Set up the sample database
  • Rename configuration.php.dist into configuration.php, add the database credentials and paths to the logs and tmp folder. All marked with [XXXXXXXXXX].
  • Rename htaccess.txt into .htaccess

Database changes

Please update the sample database if any code changes are needed for your code contributions and add a .sql file with the changes in the updates folder and use the issue number as filename.

Volunteers Portal Structure

The Volunteers Portal and its custom component com_volunteers is using the following setup.

Note: please read Departments as Leadership until the new organizational structure and methodology of the Joomla!-project is in place.

Departments

com_volunteers/departments

A Department has a Departmental Coordination Team Leader, Assistant Departmental Coordination Team Leader and Departmental Coordinators. A department has several teams within their department. Within the department Reports can be created. Volunteers are assigned to a department as Member.

Teams

com_volunteers/teams

A Team has a Team Leader, Assistant Team Leader, Members and Contributors. A team is assigned to one department. A team can also contain one or more subteams. Within the team Reports and Roles can be created. Volunteers are assigned to a team as Member.

Volunteers

com_volunteers/volunteers

A Volunteer (Joomler) is a user with an account on the website. A volunteer has their own profile with fields that can be edited by the volunteer.

Members

com_volunteers/members

A Member is the relation between a Department or Team and a Volunteer. It also contains their Position and (optional) Role within the Department or Team. Each member has a Start Date. Once someone steps down an End Date will be set and the volunteer will move to the Honour Roll. Permissions connected with their Position will become inactive.

Reports

com_volunteers/reports

A Report is an article reporting about the progress of a Department or Team and written by a Volunteer.

Positions

com_volunteers/positions

A Position is the relation between a Volunteer and its permissions. Departments and Teams have their own set of positions & permissions:

Departments

  • Departmental Coordination Team Leader The Departmental Coordination Team Leader is the leader of a department.

  • Assistant Departmental Coordination Team Leader The Assistant Departmental Coordination Team Leader is the assistant of a Departmental Coordination Team Leader.

  • Departmental Coordinator The Departmental Coordinator is a general member of a department.

Permissions

The Departmental Coordination Team Leader, Assistant Departmental Coordination Team Leader and Departmental Coordinator can:

  • create
    • teams within the department
    • reports for the department and teams within the department
    • members for the department and teams within the department
    • roles for the teams within the department
  • edit
    • department
    • teams within the department
    • reports within the department and its teams
    • members within the department and its teams
    • roles for the teams within the department

Teams

  • Team Leader The Team Leader is the leader of a (sub)team.

  • Assistant Team Leader The Assistant Team Leader is the assistant to the leader of a (sub)team.

  • Member The Member is a general member of a team.

  • Contributor The Contributor is a contributing, but not a member of a team.

Permissions

The Team Leader and Assistant Team Leader can:

  • create
    • subteams for the team
    • reports for the team and subteams
    • members for the team and subteams
    • roles for the team and subteams
  • edit
    • team
    • subteams
    • reports within the team and subteams
    • members within the team and subteams
    • roles within the team and subteams

The Member can:

  • create
    • reports for the team involved
  • edit
    • their own reports

The Contributor can:

  • none

Roles

com_volunteers/roles

A Role is used (optionally) for teams. For each role a description can be provided and if the Role is open (Team is looking for Volunteers for the Role).

Test User Accounts

The sample database has several accounts available for testing.

Admin

Admin User

Departmental Coordination Team Leader

Frontend Department

Backend Department

Assistant Departmental Coordination Team Leader

Frontend Department

Backend Department

Departmental Coordinator

Frontend Department

Backend Department

Team Leader

Extensions Team

Sample Data Team

Assistant Team Leader

Extensions Team

Sample Data Team

Member

Extensions Team

Sample Data Team

Contributor

Extensions Team

Sample Data Team