/board

Simple, standalone, flexible and very lightweight board app/PWA in JavaScript.

Primary LanguageJavaScriptGNU General Public License v3.0GPL-3.0

Board

Simple, standalone, flexible and very lightweight board app/PWA in JavaScript.

Features

v1.2.0

  • Disable swipe to go back in chrome #15

v1.1.0

  • Added local server
  • Dockerize
  • Undo and Redo
  • Export image with background/ without background

V1.0.0

  • Standalone.
  • Draw on screen.
  • Progressive Web App.
  • Clear All using shortcut or gesture.
    • In desktop (control + x)
    • In mobile (five tap)
  • Custom context menu
    • In desktop (right click to open)
    • In mobile (three finger click)
  • Help Menu
  • About page
  • Settings page:
    • Change marker color.
    • Change background color of board.
    • Change font size of marker.
  • Download as image.

Install

Clone this git clone -b 1.1.0 https://github.com/Lablnet/board.git

Install require dependencies npm i

run the server node server.js

Install With Docker

Pull from docker docker push lablnet/board

Run the container docker run --name board -d -p 9090:9090 lablnet/board:1.1

Build With Docker

Clone this git clone -b 1.1.0 https://github.com/Lablnet/board.git

Run the following commands.

$ cd board

$ chmod +x ./build.sh

$ ./build.sh

You have done it.

Configuration

The config file contain few configuration

 1. The version of app `version`.
 
 2. Developer mode or production `debug`
 
 3. At end, `colors`
	you can change it according to your requirement , you can add more colors too.

Usage

board

File structure

css/app.css => Main core CSS style file.

images Contain fav icon and others icons.

js/app.js => Main core JavaScript file.

js/undo.js => JavaScript file to handle undo/redo logic.

browserconfig.xml Config file for EDGE browsers.

index.html => HTML file of app.

LICENSE => GPL 3 License.

mainfest.json => Browser configuration file.

pwa.js => File to handle service worker for pwa app.

Icon

The logo is created using canva

The other icon from logo generated by using realfavicongenerator

Tested

The app is tested in the following mentioned browsers.

Browser Desktop Mobile
Chrome v83 v84
Firefox v79 v68
Opera v70 v59
EDGE v84 v45
Safari v14 v13

Contributions

There is still a lot of work to do, so feel free to contribute to open PR

Contribution guide

You're welcome to contribute the guideline can be found here Contribution Guideline

License

GPL-3

Disclaimer

I do not accept responsibility for any illegal usage

Similar Project

https://github.com/cs50/draw.cs50.io

Resources: