WebDev/spacedeck-open
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
f396bc2e40
spacedeck-open/README.md

99 lines
3.9 KiB
Markdown
Raw Normal View History

initial commit.
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).
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
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.
initial commit.
2017-04-07 01:29:05 +02:00
update README
2018-04-12 19:56:06 +02:00
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.
initial commit.
2017-04-07 01:29:05 +02:00
We appreciate filed issues, pull requests and general discussion.
# 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
- 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
tune README
2018-04-12 18:49:45 +02:00
# Data Import from Spacedeck.com
Spacedeck Open has a data import feature that you can use to migrate your ZIP export from Spacedeck.com.
readme tweaks
2018-04-12 20:27:58 +02:00
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.
tune README
2018-04-12 18:49:45 +02:00
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
tune README
2018-04-12 18:49:45 +02:00
- Node.js 9.x: Web Server / API. Download: https://nodejs.org
initial commit.
2017-04-07 01:29:05 +02:00
readme tweaks
2018-04-12 20:27:58 +02:00
To run Spacedeck, you only need Node.JS 9.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.
# Run (desktop app with integrated web server)
electron .
initial commit.
2017-04-07 01:29:05 +02:00
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/>.
Reference in New Issue Copy Permalink