README.md

#TEAMMATES Developer Web Site

[](https://travis-ci.org/TEAMMATES/teammates)

[](https://www.versioneye.com/user/projects/579103ca51500e0031886f12)

[](https://www.versioneye.com/user/projects/579103d351500e0039e7b76a)

TEAMMATES is a free online tool for managing peer evaluations and other feedback paths of your students. It is provided as a cloud-based service for educators/students and is currently used by hundreds of universities across the world. This is the developer web site for TEAMMATES. Click here to go to the TEAMMATES product website

##Interested to join TEAMMATES developer team?

We welcome contributions from developers, especially students. Here are some resources:

• Contributor Orientation Guide : This document describes what you need to know/do to become a contributor. This is a MUST READ for new contributors.
• [Project ideas page] (https://docs.google.com/document/d/1fAvYvQr0E93OsZgyneaXGX0jaMA-zptTIxqLn83xwN0/pub?embedded=true) : These are for those who would like to do a relatively bigger projects with TEAMMATES (e.g., summer internships).
• [Instructions for Google Summer of Code applicants] (https://docs.google.com/document/d/1Iu63WRIw8uz8liEW089IQHDQTRbh-QoOLMyfTPXNOa0/pub?embedded=true) : Read this before you apply to work for TEAMMATES under GSoC.

##Documentation For Developers Here are some documents important for TEAMMATES developers:

Main documents

• Specification (short name: Spec) : Product specification, written from the developers point of view. The user's point of view is here.
• The project vision, challenges, and principles from a developer's perspective.
• Software Design - Architecture, APIs, etc.
• How to set up the developer environment- e.g., tools and libraries used.
• The development process.

Supplementary documents

• Resources bin : Learning resources for the use of developers (tutorials, cheat sheets etc).

• Decision analysis : Analysis of problems encountered, solutions considered, rationale for selection etc.

• The glossary of terms used in the project.

• Coding standards for : Java, JSP, JavaScript, CSS, HTML

• Developer Troubleshooting Guide

• Best practices for : UI design, Coding, Testing

• Version History

• Project stats

• Technical reports about TEAMMATES : In-depth descriptions about various aspects of the project

  • An Analysis of Question Types - by Low Weilin
  • Measuring Scalability and Performance - by James Dam Tuan Long
  • Improving Scalability and Performance - by James Dam Tuan Long
  • Data Backup and Disaster Recovery - by Lee Shaw Wei Shawn
  • Dealing with Eventual Consistency - by Lee Shaw Wei Shawn
  • Dealing with Intermittent Null Pointer Exceptions - by Lee Shaw Wei Shawn
  • Using Task Queues - by Hunar Khanna, Lee Shaw Wei Shawn
  • [Using AJAX for dynamic page updates] (https://docs.google.com/document/d/1GjTlIgoZg-vWKGG2b6Bh7ipL9_rV9syymOl93O0iqM4/pub?embedded=true) - by Hunar Khanna
  • Dealing with character sets - by Oo Theong Siang
  • Modifying entity classes with legacy data - by Oo Theong Siang
  • [Notes on the 'comments' feature] (https://docs.google.com/document/d/1YsgDySCOQbLl7Wc5JYPtKqd_hNvGMwea4OqtVOb0HBM/pub?embedded=true) - by Xie Kai, Ju Junchao
  • [Notes on 'access control'] (https://docs.google.com/document/d/1g-1YhhYMCwO4NGJzn26HVzLxzm5PI6JAFxUNtHEEGDc/pub?embedded=true) - by Gu Junchao
  • [Notes on 'profiles' feature] (https://docs.google.com/document/d/1TGVkdu6JlOFX_2dJoeZu1avkiKj8ZqFcpBREJhKK78c/pub?embedded=true) - by Thyagesh Manikandan

##Acknowledgements TEAMMATES team wishes to thank the following invaluable contributions.

• School of Computing, National University of Singapore (NUS), for providing us with the infrastructure support to run the project.
• Centre for Development of Teaching and Learning (CDTL) of NUS, for supporting us with several Teaching Enhancement Grants over the years.
• Learning Innovation Fund-Technology (LIF-T) initiative of NUS, for funding us for the 2015-2018 period.
• Google Summer of Code Program, for including TEAMMATES as a mentor organization in GSoC2014, GSoC2015 and GSoC2016 editions.
• Facebook Open Academy Program, for including TEAMMATES as a mentor organization in FBOA 2016.
• YourKit LLC, for providing us with free licenses for the YourKit Java Profiler (an industry leading profiler tool for Java applications).

##License TEAMMATES is released under GPLv2

##Contact The best way for potential contributors to contact us is by posting a message in our issue tracker (yes, we use the issue tracker as a discussion forum too).

Alternatively (less preferred), you can email teammates [at] comp.nus.edu.sg