Skip to content
This repository has been archived by the owner on Feb 16, 2022. It is now read-only.
/ volunteur Public archive

Bringing the fun back into volunteering

Notifications You must be signed in to change notification settings

makerforceio/volunteur

Repository files navigation

Volunteur

Bringing the fun back into volunteering


What's in the name?

Meetup + volunteering. A portmanteau of 'volunteer' and 'connoisseur'.

Running the backend

docker-compose up --build

Services

More documentation can be found in each respective folder.

Default ports:

  • admin: 10201
  • accounts: 10202
  • events: 10203
  • fileserve: 10204

Redis

There exists seperate dbs in redis for different scopes:

  • 0: Volunteer accounts
  • 1: Clients
  • 2: Events
  • 3: Organiser accounts

Objects

Volunteer

{
  "username" : String,
  "name" : String,
  "password" : String,
  "bio" : String,
  "score" : Number,
  "events" : Array
}

Organiser

{
  "username" : String,
  "name" : String,
  "password" : String,
  "bio" : String,
  "score" : Number,
  "events" : Array,
  "organisation" : String
}

contact details?

Event

{
  "name" : String,
  "description" : String,
  "organisation" : String,
  "organiser" : String,
  "starttime" : Number,
  "endtime" : Number,
  "lat" : Number, (OPTIONAL)
  "lng" : Number, (OPTIONAL)
  "size" : Number, (OPTIONAL)
  "max_participants" : Number, (OPTIONAL)  
  "picture" : String (OPTIONAL)
}

Start and end times stored as UNIX epoch time.