Skip to content

Latest commit

Β 

History

History
119 lines (80 loc) Β· 3.38 KB

README.md

File metadata and controls

119 lines (80 loc) Β· 3.38 KB

πŸ‘¨πŸΎβ€πŸ« Screenboard πŸ‘¨πŸΎβ€

Version Maintenance Twitter: maykbrito

πŸ‘¨πŸΎβ€πŸ« It's a overlay blackboard on your screen

πŸ“Ή Small presentation about this project https://youtu.be/tq-pzpaqn5Q

🏠 Homepage

πŸŽ‰ Install

npm install

πŸ”₯ Usage

npm start

🍸 Build

If you want to use it as an app for your platform run

npm run build

It will give to you an file ate ./packages directory

⌨️ Shortcuts

While it's running in your terminal, you can do a set of commands:

Functionality Keyboard Shortcut
Toggle Window Alt + Shift + w
Undo Cmd or Ctrl + z
Redo Cmd or Ctrl + y
Clear Cmd or Ctrl + backspace
Toggle Options Esc
Select Pencil w
Select Eraser e
Increase pen size d
Decrease pen size s
Select colors r (red), g (green), b (blue), c (cyan), m (magenta), y (yellow), k (black)

You can customize your own shortcuts in ./src/shortcuts.js file.

😒 Limitations

There are some limitations about the transparency on Electron. You can check out here.

On Windows OS:

  • Transparent windows will not work when DWM is disabled.
  • Transparent windows can not be maximized using the Windows system menu or by double clicking the title bar. The reasoning behind this can be seen on PR #28207.

πŸ•΅πŸΎβ€β™‚οΈ Inspiration ...

And lot of code from:

πŸ‘¨πŸΎβ€πŸ’» Techs

  • Javascript
  • HTML
  • CSS
  • Electron
  • Node.js

πŸ‘€ Author

Mayk Brito

🀝 Contributing

Contributions, issues and feature requests are welcome!
Feel free to check issues page.

πŸ§ͺ Tested in

✨ Show your support

Give a ⭐️ if this project helped you!


πŸ“ License

Copyright Β© 2021 Mayk Brito.
This project is MIT licensed.


πŸ’œ