Skip to content

QuixoticScientist/whiteboard

Repository files navigation

Albus

Albus is a real-time collaborative whiteboard. Key features include:

  • suggested snapping points to shape corners and midpoints using k-d trees;
  • automatic path smoothing for freehand drawing;
  • path autofill upon closing;
  • infinite board panning and zooming;
  • shape moving, copying, and erasing;
  • color and fill customization; and
  • responsive marching menu

Data flows onto the board in the following path:

alt tag

Team

  • Product Owner: Haley Bash
  • Scrum Master: Lorenzo De Nobili
  • Development Team Members: Christian Everett, Lorenzo De Nobili, Rory Sametz, Haley Bash

Table of Contents

  1. Usage
  2. Technologies Used
  3. Requirements
  4. Development
    1. Installing Dependencies
    2. Tasks
  5. Contributing

Usage

Visit the page, currently hosted on albus.io

Technologies Used

Requirements

Development Process

Step 0: Fork and clone the repository from GitHub

Step 1: Installing Dependencies

Run the following in the command line, from within the repository:

bower install
npm install

Step 2: Running Locally

Run the Redis database from the command line, in one tab:

redis-server

Run the server in the other tab using node:

npm run server

Step 3: Making Local Changes

Each time a change is made, run the following to update the minified files:

grunt release

Step 4: Issuing a Pull Request

Feel free to add contributions by issuing a pull request to the dev branch of this repo.

Visiting the server

While node is running, visit the locally running server at 127.0.0.1:3000