Skip to content
Emil Rose edited this page Apr 7, 2016 · 24 revisions

Welcome to the McLab-Web wiki!

What is McLab Web?

Deepanjan's COMP 400 report and slide deck should give you a decent overview:

COMP 400 report - Deepanjan

[COMP 400 final presentation slide deck - Deepanjan] (deepanjan_slides.pdf)

Developing McLab Web

Follow these instructions to set up your own dev environment. The testplan file describes how to test if everything is working properly.

React-Flux-Intro links to primers on React/Flux.

Adding-new-features briefly documents what you need to do add new features, and is a good place to start to make yourself familiar with the codebase.

Code-and-style-guideline provides some general comments and style guideline.

API-Documentation describes how to view, edit, and build the API docs.

Tests describes where the tests for the project are and how to run them.

Deployment

If you're on the McGill network, you can view a live version on McLab Web at http://132.206.3.105/

If you want to deploy the latest version on the live site, see deploying-mclab-web.

Getting help

Use the issue tracker to discuss bugs / feature proposals. For more informal questions, ask on the gitter chat and mention one of the contributors (this is preferable to email.)

Updating the wiki

For most updates, using the Edit button should be enough. If you want to update file/image attachments (e.g. if you want to change the pdf document of the report) you will have to clone the wiki locally (github wikis are also git repositories) and make the changes there.