AnitaB.org has many volunteers that offer their skills, time, and commitment to our vision and projects. The Volunteer Management System (VMS) will be useful for volunteer coordinators, volunteer sign-up, tracking hours, and reporting.
This project is under active development.
VMS is live here.
If you are an Outreachy Applicant, start with reading this.
The VMS is developed in phases. The initial implementation tracks volunteers' contact information, enables administrators to track volunteer hours, and allows reporting of useful information.
The VMS project uses the Django web framework and Python.
To get started, read the Installation Guide.
If you wish to view a sneak peek of the AnitaB.org VMS, you may use Docker to preview the VMS. Note: The following Docker configuration is not intended to be run in production at the moment. It may be configured to do so in the future.
git clone git@github.com:anitab-org/vms.git
to clone the AnitaB.org
VMS repository. After the clone is done, change directory (cd) to the
vms
directory.docker-compose build
. This pulls the Docker images required to run the
project and installs the necessary dependencies.docker run -e SECRET_KEY=foobarbaz vms_web
docker-compose run web python vms/manage.py migrate
.docker-compose run web python vms/manage.py cities_light
for downloading and importing data for django-cities-light.docker-compose run web python vms/manage.py createsuperuser
if you wish to create a superuser to access the admin panel.docker-compose up
to start the webserver for the Django AnitaB.org VMS
project.http://0.0.0.0:8000
in your browser.http://192.168.59.103:8000/
in your browser. If this IP address
doesn't work, run boot2docker ip
from the command line and replace
the previous IP address in the HTTP request with the IP returned by
boot2docker.Linking pull request to an issue
When you create a pull request, use closes #id_of_issue or fixes #id_of_issue. It will link the issue with your pull request. It also automatically closes the issue if your pull request gets merged.
The repository has the following permanent branches:
master This contains the code which has been released.
develop This contains the latest code. All the contributing PRs must be sent to this branch. When we want to release the next version of the app, this branch is merged into the master
branch.
aws This is the branch through which the project is deployed.
User and developer documentation for AnitaB.org Portal VMS project is generated using Markdown and available online for convenient reading at VMS Website.
We are pleased to participate in the Google Summer of Code and are grateful for the contributions from our GSoC developers.
The best way to connect with the maintainers is through Github comments. Communicate with our community on AnitaB.org Open Source Zulip. For queries regarding VMS Project join, #vms and newcomers can join, #newcomers.
The project is licensed under the GNU GENERAL PUBLIC LICENSE.
A heartfelt thank you to all wonderful contributors of software, guidance, and encouragement.