2017-04-07 01:29:05 +02:00
# Spacedeck Open
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). All icons and large parts of the CSS were designed by Thomas Helbig (dergraph).
2018-04-12 18:40:58 +02:00
As we plan to retire the subscription based service at spacedeck.com in May 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.
2017-04-07 01:29:05 +02:00
Data migration features will be added soon.
We appreciate filed issues, pull requests and general discussion.
# Features
2018-03-30 23:21:54 +02:00
- Create virtual whiteboards called *Spaces* with virtually unlimited size
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
- Collaborate and chat in realtime with teammates, students or friends
- Share Spaces on the web or via email
- Export your work as printable PDF or ZIP
# Requirements, Installation
Spacedeck uses the following major building blocks:
2018-04-12 18:40:58 +02:00
- Node.js 9.x: Web Server / API
- Vue.js: Frontend UI Framework (included)
- SQLite (included)
2017-04-07 01:29:05 +02:00
2018-04-12 18:40:58 +02:00
It also has some optional binary dependencies for advanced media conversion:
2017-04-07 01:29:05 +02:00
2018-04-12 18:40:58 +02:00
- ffmpeg and ffprobe (for video/audio conversion)
- audiowaveform (for audio waveform rendering) (https://github.com/bbcrd/audiowaveform)
- ghostscript (gs, for PDF import)
2017-04-07 01:29:05 +02:00
2018-03-30 23:29:27 +02:00
By default, media files are uploaded to the ```storage``` folder.
2018-04-12 18:40:58 +02:00
To use Spacedeck, you only need Node.JS 9.x.
2017-04-07 01:29:05 +02:00
2018-04-12 18:40:58 +02:00
Then, to install all node dependencies, run
2017-04-07 01:29:05 +02:00
npm install
To rebuild the frontend CSS styles (you need to do this at least once):
gulp styles
2017-04-07 11:05:12 +02:00
# Configuration
2018-03-30 22:48:10 +02:00
See [config/default.json ](config/default.json )
2017-04-07 11:05:12 +02:00
2018-04-12 18:40:58 +02:00
# Run (web server)
2017-04-07 01:29:05 +02:00
2018-04-12 18:40:58 +02:00
node spacedeck.js
Then open http://localhost:9666 in a web browser.
# Run (desktop app with integrated web server)
electron .
2017-04-07 01:29:05 +02:00
# License
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).
2017-04-07 01:29:05 +02:00
Spacedeck Open - Web-based Collaborative Whiteboard For Rich Media
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
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 / > .