Software to bring local and foreign students together and create friendships all over the world.
This system is used by some Erasmus Student Union (ESN) Sections to let local and incoming foreign students sign up and be mixed together to so-called buddy groups. All user interaction happens through the web interface and by email notifications.
License: not yet decided.
Authors: Martijn Sack, Michael May
Maintainer: Claudio Harringer [email protected]
Disclaimer: Here, maintainer is defined as someone who is running this system, but not involved in development. I just put it here on github hoping that someone sees it and starts developing :)
(getting started hacking the system)
Where to find configuration? -> ./config.php
Where to find text templates? -> ./actions/templates/*.tpl
Which libraries are used?
- Smarty (template lib)
- some DAO (database abstraction)
What patterns are in the code?
- MVC. M is in ./dao/, V is ./actions/templates/, C is ./actions/
What's all not yet in this repository? -> All personal stuff like templates and configs. See .gitignore.
How to start developing? -> Well, that's not 100% easy:
- Setup a mysql database.
- Setup a mail server.
- Create the database using ./docs/create.sql.example
- Copy each FILE.example to FILE
- set up your local ./config.php
- set up your local ./email/Mailer.php
- optionally, update all the ./actions/templates/*.tpl
- optionally, update js/calendar/calendar_eu.js
- Use test email addresses or code yourself some development mode.
- Yeah, now start playing around and developing!
Once you've done something you want to share, you may make a push request on Github or send a patch to the maintainer.
Yes, there is already some. But I have no clue about that yet. The Buddysystem doesn't depend on it, thus you may safely ignore it in the first place.
(fictive persons with funny names that interact somehow with this system)
Alice ... admin user
Steve ... sysadmin
Louis ... local buddy
Ida ... incoming exchange student
Spambot ... un-desirable guest
(as user stories; priorized)
(A) User Steve want to know how to set up the dev env (pdo, mail, tests).
(A) User Steve wants to database in the background to be Sqlite in order to copy and modify the database more easily and to easily develop the software further.
(A) User Alice wants to create, modify and safe a group assignment set in order to take care of individual whishes and optimize the assignment manually.
- IN: move a person to another group
- IN: remove a person from the match proposal
- IN: see the name, date and some info about each person
- OUT: eye-candy and nice interface; maybe text-only, just has to do the job
(B) User Steve wants to check whether sending emails works so that he can make sure whether the emailing works.
(C) User Alice wants to list incomings ordered by arrival date in order to get an overview when they arrive.
(C) User Spambot wants a captcha that prevents him from registration in order to keep spam away from Alice.
(C) User Louis and Ida want to receive all chat messages by email per default in order to never miss anything even without checking the website.
(C) User Alice wants to add comments to buddies and wants to see these comments when creating groups in order to be able to consider individual whishes of buddies.