Skip to content

Latest commit

 

History

History
135 lines (92 loc) · 6.14 KB

README.md

File metadata and controls

135 lines (92 loc) · 6.14 KB
Raw

AnitaB.org Portal - VMS project

Build Status Coverage Status PRs Welcome project chat

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.

Features

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.

Installation

The VMS project uses the Django web framework and Python.

To get started, read the Installation Guide.

Run VMS in a Docker Container

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.

  1. Install Docker. Follow the installation steps for your specific operating system:
    • Docker runs natively on a Linux-based system.
    • For Windows and Mac OS X, you should follow instructions for installing boot2docker which also installs VirtualBox.
  2. Install docker-compose. Note: fig has been deprecated. Docker-compose replaces fig.
  3. Create a new directory on your local system.
  4. Enter git clone [email protected]:anitab-org/vms.git to clone the AnitaB.org VMS repository. After the clone is done, change directory (cd) to the vms directory.
  5. Run docker-compose build. This pulls the Docker images required to run the project and installs the necessary dependencies.
  6. Run docker run -e SECRET_KEY=foobarbaz vms_web
  7. Run docker-compose run web python vms/manage.py migrate.
  8. Run docker-compose run web python vms/manage.py cities_light for downloading and importing data for django-cities-light.
  9. Optional: Run docker-compose run web python vms/manage.py createsuperuser if you wish to create a superuser to access the admin panel.
  10. Run docker-compose up to start the webserver for the Django AnitaB.org VMS project.
  11. AnitaB.org VMS should be running on port 8000.
    • If you are on Linux, enter http://0.0.0.0:8000 in your browser.
    • If you are using boot2docker on Windows or Mac OS X, enter 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.

Contribute

Branches

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.

Documentation

User and developer documentation for AnitaB.org Portal VMS project is generated using Markdown and available online for convenient reading at VMS Website.

Google Summer of Code (GSoC) Development

We are pleased to participate in the Google Summer of Code and are grateful for the contributions from our GSoC developers.

Communicate

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.

License

The project is licensed under the GNU GENERAL PUBLIC LICENSE.

A heartfelt thank you to all wonderful contributors of software, guidance, and encouragement.