spacedeck-open/README.md

# Spacedeck Open

![Spacedeck 6.0 Screenshot](/public/images/sd6-screenshot.png)

This is the free and open source version of Spacedeck, a web based, real time, collaborative whiteboard application with rich media support. Spacedeck was developed in 6 major releases during Autumn 2011 until the end of 2016 and was originally a commercial SaaS. The developers were Lukas F. Hartmann (mntmn) and Martin Güther (magegu).

The spacedeck.com online service was shut down on May 1st 2018. We decided to open-source Spacedeck to allow educational and other organizations who currently rely on Spacedeck to migrate to a self-hosted or local version.

[MNT Research GmbH](https://mntre.com) has restarted development of Spacedeck Open in 2020.

We appreciate filed issues, pull requests and general discussion.

# Features

- Create virtual whiteboards called *Spaces* with virtually unlimited size
- Drag & drop images, videos and audio from your computer or the web
- Write and format text with full control over fonts, colors and style
- Draw, annotate and highlight with included graphical shapes
- Turn your Space into a zooming presentation
- Collaborate in realtime with teammates, students or friends
- Share Spaces on the web or via email
- Export your work as printable PDF or ZIP (currently being fixed, stay tuned)

# Use Cases

- Education: Virtual classwork with multimedia
- Creative: Mood boards, Brainstorming, Design Thinking
- Visual note taking and planning

# Requirements, Installation

Spacedeck requires:

- Node.js 10.x: Web Server / API. Download: https://nodejs.org

To run Spacedeck, you only need Node.JS 10.x.

To install all node dependencies, run (do this once):

    npm install

# Configuration

See [config/default.json](config/default.json)

# Run (web server)

    node spacedeck.js

Then open http://localhost:9666 in a web browser.

# Optional Dependencies

For advanced media conversion:

- ffmpeg and ffprobe for video/audio conversion. Download: https://www.ffmpeg.org/download.html
- audiowaveform for audio waveform rendering. Download: https://github.com/bbcrd/audiowaveform
- ghostscript for PDF import. Download: https://www.ghostscript.com/download/gsdnld.html

# Data Storage

By default, media files are uploaded to the ```storage``` folder.
The database is stored in ```database.sqlite``` by default.

# Hacking

To rebuild the frontend CSS styles:

    gulp styles

# License

The Spacedeck logo and brand assets are registered trademarks of Spacedeck GmbH. All rights reserved.

Spacedeck Open source code is released under the GNU Affero General Public License Version 3 (GNU AGPLv3).

    Spacedeck Open - Web-based Collaborative Whiteboard For Rich Media
    Copyright (C) 2011-2018 Lukas F. Hartmann, Martin Güther
    Icons and original CSS design copyright by Thomas Helbig
    
    This program is free software: you can redistribute it and/or modify
    it under the terms of the GNU Affero General Public License as
    published by the Free Software Foundation, either version 3 of the
    License, or (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU Affero General Public License for more details.

    You should have received a copy of the GNU Affero General Public License
    along with this program.  If not, see <http://www.gnu.org/licenses/>.
initial commit. 2017-04-07 01:29:05 +02:00			`# Spacedeck Open`

readme update 2020-04-08 22:11:56 +02:00			`![Spacedeck 6.0 Screenshot](/public/images/sd6-screenshot.png)`
readme update 2020-04-08 22:11:10 +02:00
Update README.md 2018-05-01 01:25:07 +02:00			`This is the free and open source version of Spacedeck, a web based, real time, collaborative whiteboard application with rich media support. Spacedeck was developed in 6 major releases during Autumn 2011 until the end of 2016 and was originally a commercial SaaS. The developers were Lukas F. Hartmann (mntmn) and Martin Güther (magegu).`
initial commit. 2017-04-07 01:29:05 +02:00
Update README.md 2018-05-01 01:25:07 +02:00			`The spacedeck.com online service was shut down on May 1st 2018. We decided to open-source Spacedeck to allow educational and other organizations who currently rely on Spacedeck to migrate to a self-hosted or local version.`

readme update 2020-04-08 22:11:10 +02:00			`[MNT Research GmbH](https://mntre.com) has restarted development of Spacedeck Open in 2020.`

Update README.md 2018-05-01 01:25:07 +02:00			`We appreciate filed issues, pull requests and general discussion.`
initial commit. 2017-04-07 01:29:05 +02:00
			`# Features`

updated and fixed README issues 2018-03-30 23:21:54 +02:00			`- Create virtual whiteboards called Spaces with virtually unlimited size`
initial commit. 2017-04-07 01:29:05 +02:00			`- Drag & drop images, videos and audio from your computer or the web`
			`- Write and format text with full control over fonts, colors and style`
			`- Draw, annotate and highlight with included graphical shapes`
			`- Turn your Space into a zooming presentation`
readme update 2020-04-08 22:11:10 +02:00			`- Collaborate in realtime with teammates, students or friends`
initial commit. 2017-04-07 01:29:05 +02:00			`- Share Spaces on the web or via email`
readme update 2020-04-08 22:11:10 +02:00			`- Export your work as printable PDF or ZIP (currently being fixed, stay tuned)`
initial commit. 2017-04-07 01:29:05 +02:00
Update README.md 2018-07-25 11:05:35 +02:00			`# Use Cases`

			`- Education: Virtual classwork with multimedia`
			`- Creative: Mood boards, Brainstorming, Design Thinking`
			`- Visual note taking and planning`

initial commit. 2017-04-07 01:29:05 +02:00			`# Requirements, Installation`

readme tweaks 2018-04-12 20:27:58 +02:00			`Spacedeck requires:`
initial commit. 2017-04-07 01:29:05 +02:00
readme update 2020-04-08 22:11:10 +02:00			`- Node.js 10.x: Web Server / API. Download: https://nodejs.org`
initial commit. 2017-04-07 01:29:05 +02:00
readme update 2020-04-08 22:11:10 +02:00			`To run Spacedeck, you only need Node.JS 10.x.`
initial commit. 2017-04-07 01:29:05 +02:00
readme tweaks 2018-04-12 20:27:58 +02:00			`To install all node dependencies, run (do this once):`
initial commit. 2017-04-07 01:29:05 +02:00
			`npm install`

add configuration lines to readme 2017-04-07 11:05:12 +02:00			`# Configuration`

fix config link in readme 2018-03-30 22:48:10 +02:00			`See [config/default.json](config/default.json)`
add configuration lines to readme 2017-04-07 11:05:12 +02:00
Port Backend to SQLite/Sequelize (removes MongoDB), Support Electron (#14) * The MongoDB/Mongoose data storage is removed in favor of Sequelize. This abstracts over SQLite or RDBMs like PostgreSQL and MSSQL. The default is SQLite, which significantly simplifies deployments in end-user environments. * As Spacedeck now has no more mandatory server dependencies, we can wrap it in Electron and ship it as a desktop application. * Removes docker-compose.yml * First version of import UI 2018-04-12 18:40:58 +02:00			`# Run (web server)`
initial commit. 2017-04-07 01:29:05 +02:00
Port Backend to SQLite/Sequelize (removes MongoDB), Support Electron (#14) * The MongoDB/Mongoose data storage is removed in favor of Sequelize. This abstracts over SQLite or RDBMs like PostgreSQL and MSSQL. The default is SQLite, which significantly simplifies deployments in end-user environments. * As Spacedeck now has no more mandatory server dependencies, we can wrap it in Electron and ship it as a desktop application. * Removes docker-compose.yml * First version of import UI 2018-04-12 18:40:58 +02:00			`node spacedeck.js`

			`Then open http://localhost:9666 in a web browser.`

readme tweaks 2018-04-12 20:27:58 +02:00			`# Optional Dependencies`

			`For advanced media conversion:`

			`- ffmpeg and ffprobe for video/audio conversion. Download: https://www.ffmpeg.org/download.html`
			`- audiowaveform for audio waveform rendering. Download: https://github.com/bbcrd/audiowaveform`
			`- ghostscript for PDF import. Download: https://www.ghostscript.com/download/gsdnld.html`

			`# Data Storage`

			By default, media files are uploaded to the ```storage``` folder.
			The database is stored in ```database.sqlite``` by default.

update README 2018-04-14 22:32:28 +02:00			`# Hacking`

			`To rebuild the frontend CSS styles:`

			`gulp styles`

initial commit. 2017-04-07 01:29:05 +02:00			`# License`

Port Backend to SQLite/Sequelize (removes MongoDB), Support Electron (#14) * The MongoDB/Mongoose data storage is removed in favor of Sequelize. This abstracts over SQLite or RDBMs like PostgreSQL and MSSQL. The default is SQLite, which significantly simplifies deployments in end-user environments. * As Spacedeck now has no more mandatory server dependencies, we can wrap it in Electron and ship it as a desktop application. * Removes docker-compose.yml * First version of import UI 2018-04-12 18:40:58 +02:00			`The Spacedeck logo and brand assets are registered trademarks of Spacedeck GmbH. All rights reserved.`

			`Spacedeck Open source code is released under the GNU Affero General Public License Version 3 (GNU AGPLv3).`
initial commit. 2017-04-07 01:29:05 +02:00
			`Spacedeck Open - Web-based Collaborative Whiteboard For Rich Media`
Port Backend to SQLite/Sequelize (removes MongoDB), Support Electron (#14) * The MongoDB/Mongoose data storage is removed in favor of Sequelize. This abstracts over SQLite or RDBMs like PostgreSQL and MSSQL. The default is SQLite, which significantly simplifies deployments in end-user environments. * As Spacedeck now has no more mandatory server dependencies, we can wrap it in Electron and ship it as a desktop application. * Removes docker-compose.yml * First version of import UI 2018-04-12 18:40:58 +02:00			`Copyright (C) 2011-2018 Lukas F. Hartmann, Martin Güther`
			`Icons and original CSS design copyright by Thomas Helbig`
initial commit. 2017-04-07 01:29:05 +02:00
			`This program is free software: you can redistribute it and/or modify`
			`it under the terms of the GNU Affero General Public License as`
			`published by the Free Software Foundation, either version 3 of the`
			`License, or (at your option) any later version.`

			`This program is distributed in the hope that it will be useful,`
			`but WITHOUT ANY WARRANTY; without even the implied warranty of`
			`MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the`
			`GNU Affero General Public License for more details.`

			`You should have received a copy of the GNU Affero General Public License`
			`along with this program. If not, see <http://www.gnu.org/licenses/>.`