README.md 3.88 KB
Newer Older
mntmn's avatar
mntmn committed
1
2
3
4
# 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).

5
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.
mntmn's avatar
mntmn committed
6

Lukas F. Hartmann's avatar
Lukas F. Hartmann committed
7
8
Easy to use desktop releases with binaries for Linux, Mac and Windows will be published here soon. In the meantime, you have to install Node.JS.

mntmn's avatar
mntmn committed
9
10
11
12
We appreciate filed issues, pull requests and general discussion.

# Features

13
- Create virtual whiteboards called *Spaces* with virtually unlimited size
mntmn's avatar
mntmn committed
14
15
16
17
18
19
20
21
- 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

Lukas F. Hartmann's avatar
Lukas F. Hartmann committed
22
23
24
25
# Data Import from Spacedeck.com

Spacedeck Open has a data import feature that you can use to migrate your ZIP export from Spacedeck.com.

Lukas F. Hartmann's avatar
Lukas F. Hartmann committed
26
27
28
29
30
1. Just copy your downloaded ZIP file into the spacedeck root folder. Don't extract it.
2. Start your local Spacedeck.
3. Navigate to *Account / Profile* (person icon in the top right corner).
4. Click the *Import* button next to the ZIP file name. It is on the bottom of the page.
5. Wait until console output has finished and you're done.
Lukas F. Hartmann's avatar
Lukas F. Hartmann committed
31

mntmn's avatar
mntmn committed
32
33
# Requirements, Installation

Lukas F. Hartmann's avatar
Lukas F. Hartmann committed
34
Spacedeck requires:
mntmn's avatar
mntmn committed
35

Lukas F. Hartmann's avatar
Lukas F. Hartmann committed
36
- Node.js 9.x: Web Server / API. Download: https://nodejs.org
mntmn's avatar
mntmn committed
37

Lukas F. Hartmann's avatar
Lukas F. Hartmann committed
38
To run Spacedeck, you only need Node.JS 9.x.
mntmn's avatar
mntmn committed
39

Lukas F. Hartmann's avatar
Lukas F. Hartmann committed
40
To install all node dependencies, run (do this once):
mntmn's avatar
mntmn committed
41
42
43

    npm install

Lukas F. Hartmann's avatar
Lukas F. Hartmann committed
44
To rebuild the frontend CSS styles (do this at least once, too):
mntmn's avatar
mntmn committed
45
46
47

    gulp styles

48
49
# Configuration

Lukas F. Hartmann's avatar
Lukas F. Hartmann committed
50
See [config/default.json](config/default.json)
51

52
# Run (web server)
mntmn's avatar
mntmn committed
53

54
55
56
57
58
59
60
    node spacedeck.js

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

# Run (desktop app with integrated web server)

    electron .
mntmn's avatar
mntmn committed
61

Lukas F. Hartmann's avatar
Lukas F. Hartmann committed
62
63
64
65
66
67
68
69
70
71
72
73
74
# 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.

mntmn's avatar
mntmn committed
75
76
# License

77
78
79
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).
mntmn's avatar
mntmn committed
80
81

    Spacedeck Open - Web-based Collaborative Whiteboard For Rich Media
82
83
    Copyright (C) 2011-2018 Lukas F. Hartmann, Martin Güther
    Icons and original CSS design copyright by Thomas Helbig
mntmn's avatar
mntmn committed
84
85
86
87
88
89
90
91
92
93
94
95
96
    
    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/>.