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!
Please use the Issue tracker to report bugs, ideas and feature requests.
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.
You can fork & clone the repository for local development. To get started you need to:
configuration.php.dist into configuration.php, add the database credentials and paths to the logs and tmp folder. All marked with [XXXXXXXXXX].htaccess.txt into .htaccessPlease 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.
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.
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.
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.
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.
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.
com_volunteers/reports
A Report is an article reporting about the progress of a Department or Team and written by a Volunteer.
com_volunteers/positions
A Position is the relation between a Volunteer and its permissions. Departments and Teams have their own set of positions & permissions:
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.
The Departmental Coordination Team Leader, Assistant Departmental Coordination Team Leader and Departmental Coordinator can:
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.
The Team Leader and Assistant Team Leader can:
The Member can:
The Contributor can:
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).
The sample database has several accounts available for testing.
Admin User
Admin Joomleradmin@volunteers.joomla.orgtestFrontend Department
Frontend Leaderfrontend.leader@volunteers.joomla.orgtestBackend Department
Backend Leaderbackend.leader@volunteers.joomla.orgtestFrontend Department
Frontend Assistantfrontend.assistant@volunteers.joomla.orgtestBackend Department
Backend Assistantbackend.assistant@volunteers.joomla.orgtestFrontend Department
Frontend Coordinatorfrontend.coordinator@volunteers.joomla.orgtestBackend Department
Backend Coordinatorbackend.coordinator@volunteers.joomla.orgtestExtensions Team
Extensions Leaderextensions.leader@volunteers.joomla.orgtestSample Data Team
Sample Leadersample.leader@volunteers.joomla.orgtestExtensions Team
Extensions Assistantextensions.assistant@volunteers.joomla.orgtestSample Data Team
Sample Assistantsample.assistant@volunteers.joomla.orgtestExtensions Team
Extensions Memberextensions.member@volunteers.joomla.orgtestSample Data Team
Sample Membersample.member@volunteers.joomla.orgtestExtensions Team
Extensions Contributorextensions.contributor@volunteers.joomla.orgtestSample Data Team
Sample Contributorsample.contributor@volunteers.joomla.orgtest