If you are looking to install the application, the go to the releases page and download the installer for your system.
\n\n
Find the latest stable release.
\n
Toggle the Assets and find the installer for your system. For Windows it will be arc-setup.exe. macOS users should download arc-x.x.x.dmg, where x.x.x is the version number. Linux users should find the distribution corresponding to the system you are using.
\n
Run the installer by clicking on it.
\n\n
Note that you may be asked to use an account with upgraded privileges to install the application.
\n
Project planning
\n
We believe in open web and open API tooling. The project is managed in an open way and you can also contribute by requesting features and reporting issues. You can check current planning in the project plan.
\n
Contributing to the project
\n
Get familiar with the application architecture. You may also want to look into the .github/CONTRIBUTING.md document before you jump into the development.
If you are looking to install the application, the go to the releases page and download the installer for your system.
\n\n
Find the latest stable release.
\n
Toggle the Assets and find the installer for your system. For Windows it will be arc-setup.exe. macOS users should download arc-x.x.x.dmg, where x.x.x is the version number. Linux users should find the distribution corresponding to the system you are using.
\n
Run the installer by clicking on it.
\n\n
Note that you may be asked to use an account with upgraded privileges to install the application.
\n
Project planning
\n
We believe in open web and open API tooling. The project is managed in an open way and you can also contribute by requesting features and reporting issues. You can check current planning in the project plan.
\n
Contributing to the project
\n
Get familiar with the application architecture. You may also want to look into the .github/CONTRIBUTING.md document before you jump into the development.
Abricotine is an open source program. Feel free to fork and contribute.
\n
In order to keep the match between this documentation and the last release, please contribute and pull requests on the dedicated develop branch.
\n
License
\n
Abricotine - Markdown Editor \nCopyright (c) 2020 Thomas Brouard
\n
This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
\n
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 General Public License for more details.
\n
You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.
\n
",
"readmeOriginal": "
Abricotine
\n
\n
Desktop markdown editor with inline preview
\n
\n
\n
In Abricotine, you can preview your document directly in the text editor rather than in a side pane.
\n
Abricotine is an open-source software based on modern web technologies (HTML5, CSS3 & Node.js). It is available on Windows (7 and +), Linux and OS X.
\n
Features
\n
\n
Write in markdown (or GFM) and export your documents in HTML using templates, or in any other format supported by Pandoc (PDF, docx, ODT, etc.),
\n
Preview text elements (such as headers, images, math, embedded videos, todo lists...) while you type,
\n
Use different themes to display your documents,
\n
Use custom postprocessors to export your documents (\"tasks\"),
\n
Auto save your document on change (optional),
\n
Display document table of content in the side pane,
\n
Display syntax highlighting for code,
\n
Show helpers, anchors and hidden characters,
\n
Copy formatted HTML in the clipboard,
\n
Write in a distraction-free fullscreen view,
\n
Manage and beautify markdown tables,
\n
Search and replace text,
\n
Ligatures support (Fira Code must be installed on your computer),
Abricotine is an open source program. Feel free to fork and contribute.
\n
In order to keep the match between this documentation and the last release, please contribute and pull requests on the dedicated develop branch.
\n
License
\n
Abricotine - Markdown Editor \nCopyright (c) 2020 Thomas Brouard
\n
This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
\n
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 General Public License for more details.
\n
You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.
A universal clipboard managing app that makes it easy to access your clipboard from anywhere on any device.
\n
\n\n
1Clipboard
\n
1Clipboard is Electron based modern web application written by Typescript using Angular4 (angular-cli) + ngrx (redux for Angular) + PouchDB. I can't say this project is the best example, but anyway it is worth to look for those who are going to use Angular framework as their native application. This project is still a work in progress and not yet ready for production.
\n
Note
\n
I am currently working on this project from scratch with the newer web technology, so the source code is different from the released version.\nI am going to open this project as a public repository in the future when it is ready.\nIf you want to access to the current private repo, please contact me with your github account.
\n
Download
\n
You can download current released version of 1Clipboard for Windows, macOS from http://1clipboard.io.
A universal clipboard managing app that makes it easy to access your clipboard from anywhere on any device.
\n
\n\n
1Clipboard
\n
1Clipboard is Electron based modern web application written by Typescript using Angular4 (angular-cli) + ngrx (redux for Angular) + PouchDB. I can't say this project is the best example, but anyway it is worth to look for those who are going to use Angular framework as their native application. This project is still a work in progress and not yet ready for production.
\n
Note
\n
I am currently working on this project from scratch with the newer web technology, so the source code is different from the released version.\nI am going to open this project as a public repository in the future when it is ready.\nIf you want to access to the current private repo, please contact me with your github account.
\n
Download
\n
You can download current released version of 1Clipboard for Windows, macOS from http://1clipboard.io.
If you are looking to install the application, the go to the releases page and download the installer for your system.
\n\n
Find the latest stable release.
\n
Toggle the Assets and find the installer for your system. For Windows it will be arc-setup.exe. macOS users should download arc-x.x.x.dmg, where x.x.x is the version number. Linux users should find the distribution corresponding to the system you are using.
\n
Run the installer by clicking on it.
\n\n
Note that you may be asked to use an account with upgraded privileges to install the application.
\n
Project planning
\n
We believe in open web and open API tooling. The project is managed in an open way and you can also contribute by requesting features and reporting issues. You can check current planning in the project plan.
\n
Contributing to the project
\n
Get familiar with the application architecture. You may also want to look into the .github/CONTRIBUTING.md document before you jump into the development.
If you are looking to install the application, the go to the releases page and download the installer for your system.
\n\n
Find the latest stable release.
\n
Toggle the Assets and find the installer for your system. For Windows it will be arc-setup.exe. macOS users should download arc-x.x.x.dmg, where x.x.x is the version number. Linux users should find the distribution corresponding to the system you are using.
\n
Run the installer by clicking on it.
\n\n
Note that you may be asked to use an account with upgraded privileges to install the application.
\n
Project planning
\n
We believe in open web and open API tooling. The project is managed in an open way and you can also contribute by requesting features and reporting issues. You can check current planning in the project plan.
\n
Contributing to the project
\n
Get familiar with the application architecture. You may also want to look into the .github/CONTRIBUTING.md document before you jump into the development.
A universal clipboard managing app that makes it easy to access your clipboard from anywhere on any device.
\n
\n\n
1Clipboard
\n
1Clipboard is Electron based modern web application written by Typescript using Angular4 (angular-cli) + ngrx (redux for Angular) + PouchDB. I can't say this project is the best example, but anyway it is worth to look for those who are going to use Angular framework as their native application. This project is still a work in progress and not yet ready for production.
\n
Note
\n
I am currently working on this project from scratch with the newer web technology, so the source code is different from the released version.\nI am going to open this project as a public repository in the future when it is ready.\nIf you want to access to the current private repo, please contact me with your github account.
\n
Download
\n
You can download current released version of 1Clipboard for Windows, macOS from http://1clipboard.io.
A universal clipboard managing app that makes it easy to access your clipboard from anywhere on any device.
\n
\n\n
1Clipboard
\n
1Clipboard is Electron based modern web application written by Typescript using Angular4 (angular-cli) + ngrx (redux for Angular) + PouchDB. I can't say this project is the best example, but anyway it is worth to look for those who are going to use Angular framework as their native application. This project is still a work in progress and not yet ready for production.
\n
Note
\n
I am currently working on this project from scratch with the newer web technology, so the source code is different from the released version.\nI am going to open this project as a public repository in the future when it is ready.\nIf you want to access to the current private repo, please contact me with your github account.
\n
Download
\n
You can download current released version of 1Clipboard for Windows, macOS from http://1clipboard.io.
Akiee is a task manager that allows you to organize your task in a new way. It is build with Node-Webkit, Clojurescript and React. It is available for Linux, Mac and Windows.
\n
\n
What makes Akiee different from other task managers?
\n
\n
\n
Tasks should be easy to organize. Akiee lets you easily arange the order of your tasks. Unlike other task managers, that only let you change priorities and due dates of your tasks. With Akiee you always know which task you should finish next.
\n
\n
\n
Akiee saves your tasks in a Markdown file! You can access your tasks with every text editor available, it is easy to add notes in the Markdown file the way you like. Akiee doesn't hide your todo list in a database. If you link your tasks to your Dropbox you can even access it over the web.
\n
\n
\n
Akiee's tasks have 3 states: Todo, Doing, Done! Inspired from agile methods like Kanban and Scrum, Akiee's tasks have three states. This way you can focus on the tasks you are currently working on. Other tasks get out of your way.
\n
\n
\n
Akiee is at 0.0.1, it's the first beta release. I have been using it for some time now and it is working stable on Arch 64 bit. So take it for a test drive, if you feel task management is broken for you.
\n
Akiee is heavily inspired by the great Org-Mode and my work as a product owner in a software company.
Akiee is a task manager that allows you to organize your task in a new way. It is build with Node-Webkit, Clojurescript and React. It is available for Linux, Mac and Windows.
\n
\n
What makes Akiee different from other task managers?
\n
\n
\n
Tasks should be easy to organize. Akiee lets you easily arange the order of your tasks. Unlike other task managers, that only let you change priorities and due dates of your tasks. With Akiee you always know which task you should finish next.
\n
\n
\n
Akiee saves your tasks in a Markdown file! You can access your tasks with every text editor available, it is easy to add notes in the Markdown file the way you like. Akiee doesn't hide your todo list in a database. If you link your tasks to your Dropbox you can even access it over the web.
\n
\n
\n
Akiee's tasks have 3 states: Todo, Doing, Done! Inspired from agile methods like Kanban and Scrum, Akiee's tasks have three states. This way you can focus on the tasks you are currently working on. Other tasks get out of your way.
\n
\n
\n
Akiee is at 0.0.1, it's the first beta release. I have been using it for some time now and it is working stable on Arch 64 bit. So take it for a test drive, if you feel task management is broken for you.
\n
Akiee is heavily inspired by the great Org-Mode and my work as a product owner in a software company.
The current version is a developer preview. It collects usage metrics to help debugging.
\n
This is a developer preview, a pre-alpha. It is unstable and untested. It is not production-ready.
\n
Legalese
\n
This software is provided for free, on an as-is basis, with no warranty, and without any expressed or implied offer of support.
\n
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY\nAPPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT\nHOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM \"AS IS\" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM\nIS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF\nALL NECESSARY SERVICING, REPAIR OR CORRECTION.
Aether is available for Mac OS, Windows and Linux. Our community supports Windows, Mac OS and Linux versions at meta.geteather.net.
\n
Compiling
\n
Aether is a relatively large app with an Electron and Go toolchain, at 100,000+ lines of code. Getting it to compile requires setting up a correct build runtime with the latest versions of Go, Node (for Electron) and C dependencies and development environments. Expect the initial set-up to take a few hours. Be patient! 🙂
Please create a topic in the appropriate section of meta.getaether.net. This allows the non-Github-using majority of Aether users to help with your issue, and point you in the right direction.
\n
Backers
\n
Aether exists thanks to the generous fellows below. Funding Aether comes with some perks, such as registering your unique name before anyone else. See here for full benefits.
The current version is a developer preview. It collects usage metrics to help debugging.
\n
This is a developer preview, a pre-alpha. It is unstable and untested. It is not production-ready.
\n
Legalese
\n
This software is provided for free, on an as-is basis, with no warranty, and without any expressed or implied offer of support.
\n
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY\nAPPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT\nHOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM \"AS IS\" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM\nIS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF\nALL NECESSARY SERVICING, REPAIR OR CORRECTION.
Aether is available for Mac OS, Windows and Linux. Our community supports Windows, Mac OS and Linux versions at meta.geteather.net.
\n
Compiling
\n
Aether is a relatively large app with an Electron and Go toolchain, at 100,000+ lines of code. Getting it to compile requires setting up a correct build runtime with the latest versions of Go, Node (for Electron) and C dependencies and development environments. Expect the initial set-up to take a few hours. Be patient! 🙂
Please create a topic in the appropriate section of meta.getaether.net. This allows the non-Github-using majority of Aether users to help with your issue, and point you in the right direction.
\n
Backers
\n
Aether exists thanks to the generous fellows below. Funding Aether comes with some perks, such as registering your unique name before anyone else. See here for full benefits.
Akiee is a task manager that allows you to organize your task in a new way. It is build with Node-Webkit, Clojurescript and React. It is available for Linux, Mac and Windows.
\n
\n
What makes Akiee different from other task managers?
\n
\n
\n
Tasks should be easy to organize. Akiee lets you easily arange the order of your tasks. Unlike other task managers, that only let you change priorities and due dates of your tasks. With Akiee you always know which task you should finish next.
\n
\n
\n
Akiee saves your tasks in a Markdown file! You can access your tasks with every text editor available, it is easy to add notes in the Markdown file the way you like. Akiee doesn't hide your todo list in a database. If you link your tasks to your Dropbox you can even access it over the web.
\n
\n
\n
Akiee's tasks have 3 states: Todo, Doing, Done! Inspired from agile methods like Kanban and Scrum, Akiee's tasks have three states. This way you can focus on the tasks you are currently working on. Other tasks get out of your way.
\n
\n
\n
Akiee is at 0.0.1, it's the first beta release. I have been using it for some time now and it is working stable on Arch 64 bit. So take it for a test drive, if you feel task management is broken for you.
\n
Akiee is heavily inspired by the great Org-Mode and my work as a product owner in a software company.
Akiee is a task manager that allows you to organize your task in a new way. It is build with Node-Webkit, Clojurescript and React. It is available for Linux, Mac and Windows.
\n
\n
What makes Akiee different from other task managers?
\n
\n
\n
Tasks should be easy to organize. Akiee lets you easily arange the order of your tasks. Unlike other task managers, that only let you change priorities and due dates of your tasks. With Akiee you always know which task you should finish next.
\n
\n
\n
Akiee saves your tasks in a Markdown file! You can access your tasks with every text editor available, it is easy to add notes in the Markdown file the way you like. Akiee doesn't hide your todo list in a database. If you link your tasks to your Dropbox you can even access it over the web.
\n
\n
\n
Akiee's tasks have 3 states: Todo, Doing, Done! Inspired from agile methods like Kanban and Scrum, Akiee's tasks have three states. This way you can focus on the tasks you are currently working on. Other tasks get out of your way.
\n
\n
\n
Akiee is at 0.0.1, it's the first beta release. I have been using it for some time now and it is working stable on Arch 64 bit. So take it for a test drive, if you feel task management is broken for you.
\n
Akiee is heavily inspired by the great Org-Mode and my work as a product owner in a software company.
A free, light and easy to use desktop app to generate PGP key pairs, encrypt and decrypt messages. The desktop app works fully offline to ensure maximum security to the user.
\n
⚡ Looking for the online PGP tool from aliceandbob.io instead? Go here or on its GitHub's page.
⚠️ If you install the app on windows, you might get a warning from your anti-virus. It is because Windows builds are not signed. No worries, just add an exception for the app in your anti-virus software.
\n
Features ✨
\n
\n
🗝️ Generate PGP key pairs
\n
🔒 Encrypt messages with the public PGP key of the receiver
\n
🔓 Decrypt messages with your private PGP key
\n
\n
Tech 🔧
\n
\n
Electron.js: Electron.js helps building cross-platform desktop apps with JavaScript, HTML, and CSS
\n
Electron-forge: Electron Forge is a complete tool for creating, publishing, and installing modern Electron applications
When forking and cloning the repo, don't forget to do the following:
\n\n
Make sure to have node, npm and yarn installed on your machine
\n
run yarn install from the cloned repo.
\n
Then, yarn start to launch aliceandbob.io Desktop App in dev mode.
\n\n
⚠️ If you get any errors and warnings, install the necessary apps, packages or updates your platform may require.
\n
Find more info regarding the process and the configuration on the electronforge.io page.
\n
Building the desktop app locally 🏗️
\n
If you want to package and build the app on your machine, run yarn make --platform=<target build platform> --arch=<target arch>.\nAs for the platform, you can choose either:
A free, light and easy to use desktop app to generate PGP key pairs, encrypt and decrypt messages. The desktop app works fully offline to ensure maximum security to the user.
\n
⚡ Looking for the online PGP tool from aliceandbob.io instead? Go here or on its GitHub's page.
⚠️ If you install the app on windows, you might get a warning from your anti-virus. It is because Windows builds are not signed. No worries, just add an exception for the app in your anti-virus software.
\n
Features ✨
\n
\n
🗝️ Generate PGP key pairs
\n
🔒 Encrypt messages with the public PGP key of the receiver
\n
🔓 Decrypt messages with your private PGP key
\n
\n
Tech 🔧
\n
\n
Electron.js: Electron.js helps building cross-platform desktop apps with JavaScript, HTML, and CSS
\n
Electron-forge: Electron Forge is a complete tool for creating, publishing, and installing modern Electron applications
When forking and cloning the repo, don't forget to do the following:
\n\n
Make sure to have node, npm and yarn installed on your machine
\n
run yarn install from the cloned repo.
\n
Then, yarn start to launch aliceandbob.io Desktop App in dev mode.
\n\n
⚠️ If you get any errors and warnings, install the necessary apps, packages or updates your platform may require.
\n
Find more info regarding the process and the configuration on the electronforge.io page.
\n
Building the desktop app locally 🏗️
\n
If you want to package and build the app on your machine, run yarn make --platform=<target build platform> --arch=<target arch>.\nAs for the platform, you can choose either:
Alchemy is an open-source file converter (built on Electron and React). It also supports operations like merging files together into a pdf. We hope to support more operations and file types soon!
Beautifully simple. Super easy, drag-and-drop interface for converting/merging files
\n
Merge files. Merge multiple images into one pdf, you can even change the file order
\n
Convert files. Batch-convert multiple files to a variety of file types
\n
\n
Usage
\n
\n\n
Simply open the app by clicking on the menubar icon, or by hitting ⌘-⇧-8.
\n
Then just drag your image files into the application and select any options.
\n
Finally, click the convert/merge to seamlessly convert them into a variety of formats, or merge them into a pdf or gif. You can also hold ⇧ while dropping to merge the files into a pdf immediately.
Alchemy is an open-source file converter (built on Electron and React). It also supports operations like merging files together into a pdf. We hope to support more operations and file types soon!
Beautifully simple. Super easy, drag-and-drop interface for converting/merging files
\n
Merge files. Merge multiple images into one pdf, you can even change the file order
\n
Convert files. Batch-convert multiple files to a variety of file types
\n
\n
Usage
\n
\n\n
Simply open the app by clicking on the menubar icon, or by hitting ⌘-⇧-8.
\n
Then just drag your image files into the application and select any options.
\n
Finally, click the convert/merge to seamlessly convert them into a variety of formats, or merge them into a pdf or gif. You can also hold ⇧ while dropping to merge the files into a pdf immediately.
A free, light and easy to use desktop app to generate PGP key pairs, encrypt and decrypt messages. The desktop app works fully offline to ensure maximum security to the user.
\n
⚡ Looking for the online PGP tool from aliceandbob.io instead? Go here or on its GitHub's page.
⚠️ If you install the app on windows, you might get a warning from your anti-virus. It is because Windows builds are not signed. No worries, just add an exception for the app in your anti-virus software.
\n
Features ✨
\n
\n
🗝️ Generate PGP key pairs
\n
🔒 Encrypt messages with the public PGP key of the receiver
\n
🔓 Decrypt messages with your private PGP key
\n
\n
Tech 🔧
\n
\n
Electron.js: Electron.js helps building cross-platform desktop apps with JavaScript, HTML, and CSS
\n
Electron-forge: Electron Forge is a complete tool for creating, publishing, and installing modern Electron applications
When forking and cloning the repo, don't forget to do the following:
\n\n
Make sure to have node, npm and yarn installed on your machine
\n
run yarn install from the cloned repo.
\n
Then, yarn start to launch aliceandbob.io Desktop App in dev mode.
\n\n
⚠️ If you get any errors and warnings, install the necessary apps, packages or updates your platform may require.
\n
Find more info regarding the process and the configuration on the electronforge.io page.
\n
Building the desktop app locally 🏗️
\n
If you want to package and build the app on your machine, run yarn make --platform=<target build platform> --arch=<target arch>.\nAs for the platform, you can choose either:
A free, light and easy to use desktop app to generate PGP key pairs, encrypt and decrypt messages. The desktop app works fully offline to ensure maximum security to the user.
\n
⚡ Looking for the online PGP tool from aliceandbob.io instead? Go here or on its GitHub's page.
⚠️ If you install the app on windows, you might get a warning from your anti-virus. It is because Windows builds are not signed. No worries, just add an exception for the app in your anti-virus software.
\n
Features ✨
\n
\n
🗝️ Generate PGP key pairs
\n
🔒 Encrypt messages with the public PGP key of the receiver
\n
🔓 Decrypt messages with your private PGP key
\n
\n
Tech 🔧
\n
\n
Electron.js: Electron.js helps building cross-platform desktop apps with JavaScript, HTML, and CSS
\n
Electron-forge: Electron Forge is a complete tool for creating, publishing, and installing modern Electron applications
When forking and cloning the repo, don't forget to do the following:
\n\n
Make sure to have node, npm and yarn installed on your machine
\n
run yarn install from the cloned repo.
\n
Then, yarn start to launch aliceandbob.io Desktop App in dev mode.
\n\n
⚠️ If you get any errors and warnings, install the necessary apps, packages or updates your platform may require.
\n
Find more info regarding the process and the configuration on the electronforge.io page.
\n
Building the desktop app locally 🏗️
\n
If you want to package and build the app on your machine, run yarn make --platform=<target build platform> --arch=<target arch>.\nAs for the platform, you can choose either:
Altus is an Electron-based WhatsApp client with themes and multiple account support, available for Windows, Mac and Linux!
\n
Features
\n
Altus uses the GitHub-produced Electron framework to wrap around WhatsApp Web and add extra features to it.
\n
\n
Multiple Account Support: As of v2.0, you can use multiple WhatsApp accounts simultaneously!
\n
Native notification support for all of the platforms. Clicking the notification opens that specific chat!
\n
Online Indicator: Shows an indicator at the bottom-left corner of the chats that are online!
\n
Dark mode for when you need to chill out your eyes in the night (or even in the day)
\n
Custom Theme Support: Write your own CSS theme for WhatsApp or use the in-built Theme Customizer to create a new one just by picking colors!
\n
Available for most desktop platforms including Windows (7 or above), Linux and MacOS.
\n
Tray icon so you can minimize the app completely and still receive notifications.
\n
\n
Feature Requests
\n
In order to submit a feature request, create a new issue with the label enhancement.
\n
Please make sure that you provide a helpful description of your feature request. If possible, try implementing the feature yourself by forking this repository and then creating a pull request.
\n
Screenshots
\n
First Start
\n
\n
Default Theme
\n
\n
\"Dark Plus\" Theme
\n
\n
Support
\n
If you like Altus, consider supporting it by donating using any of the following methods:
Marcelo Zapatta - PR #77 (Fixed #23 by adding tray icon support on Linux)
\n
",
- "readmeOriginal": "
Altus
\n
\n
Altus is an Electron-based WhatsApp client with themes and multiple account support, available for Windows, Mac and Linux!
\n
Features
\n
Altus uses the GitHub-produced Electron framework to wrap around WhatsApp Web and add extra features to it.
\n
\n
Multiple Account Support: As of v2.0, you can use multiple WhatsApp accounts simultaneously!
\n
Native notification support for all of the platforms. Clicking the notification opens that specific chat!
\n
Online Indicator: Shows an indicator at the bottom-left corner of the chats that are online!
\n
Dark mode for when you need to chill out your eyes in the night (or even in the day)
\n
Custom Theme Support: Write your own CSS theme for WhatsApp or use the in-built Theme Customizer to create a new one just by picking colors!
\n
Available for most desktop platforms including Windows (7 or above), Linux and MacOS.
\n
Tray icon so you can minimize the app completely and still receive notifications.
\n
\n
Feature Requests
\n
In order to submit a feature request, create a new issue with the label enhancement.
\n
Please make sure that you provide a helpful description of your feature request. If possible, try implementing the feature yourself by forking this repository and then creating a pull request.
\n
Screenshots
\n
First Start
\n
\n
Default Theme
\n
\n
\"Dark Plus\" Theme
\n
\n
Support
\n
If you like Altus, consider supporting it by donating using any of the following methods:
A clean and native interface to https://messages.google.com/web. Supports dark and light mode on macOS Mojave. This project is 100% open-source and available for macOS. Enjoy!
\n
\n
\n
Build Instructions
\n
To build a new version of the application, first download nativefier using the following command:
\n
yarn global add nativefier\n
\n
OR
\n
npm install nativefier -g\n
\n
Next, download the required CSS and image assets from one of the releases here located here. For example, you will need the electron.css and logo.png files.
\n
Last, you'll need to run the nativefier command to build your package.
Note: Nativefier allows for osx, mas, linux, and windows platform types. You can specify this with the --platform flag.
\n
\n
",
+ "readmeOriginal": "
\n
Android Messages
\n
A clean and native interface to https://messages.google.com/web. Supports dark and light mode on macOS Mojave. This project is 100% open-source and available for macOS. Enjoy!
\n
\n
\n
Build Instructions
\n
To build a new version of the application, first download nativefier using the following command:
\n
yarn global add nativefier\n
\n
OR
\n
npm install nativefier -g\n
\n
Next, download the required CSS and image assets from one of the releases here located here. For example, you will need the electron.css and logo.png files.
\n
Last, you'll need to run the nativefier command to build your package.
Start with a minimal set of components to sketch concepts and iterate fast your team to create and enrich components, refine design and implemenation and compose a working, living prototype.
\n
\n
⚠️ This is the contributor documentation of Alva. Please refer to meetalva.io/doc/docs/guides for user docs.
\n
\n
Develop Alva
\n
\n
🐢🚀 Node.js >=8
\n
🌲 Git
\n
🐈 yarn >= 1.12
\n
🌐 Internet connection
\n
\n
git clone https://github.com/meetalva/alva.git\ncd alva\nyarn\nyarn tsc -b -w\n\n# In a second terminal window\nyarn webpack -w\n\n# In a third terminal window\nyarn alva
\n
Package commands
\n
Execute commands in all applicable packages via yarn lerna run [cmd]:
\n
\n\n
\n
Command
\n
Description
\n
\n\n\n
\n
test
\n
Run unit tests
\n
\n
\n
watch
\n
Rebuild on file changes
\n
\n
\n
build
\n
Build once
\n
\n\n
\n
Contribute
\n
Feel free to dive in! Open an issue, submit a\nPull Request or let’s discuss what should be next. ❤️
Start with a minimal set of components to sketch concepts and iterate fast your team to create and enrich components, refine design and implemenation and compose a working, living prototype.
\n
\n
⚠️ This is the contributor documentation of Alva. Please refer to meetalva.io/doc/docs/guides for user docs.
\n
\n
Develop Alva
\n
\n
🐢🚀 Node.js >=8
\n
🌲 Git
\n
🐈 yarn >= 1.12
\n
🌐 Internet connection
\n
\n
git clone https://github.com/meetalva/alva.git\ncd alva\nyarn\nyarn tsc -b -w\n\n# In a second terminal window\nyarn webpack -w\n\n# In a third terminal window\nyarn alva
\n
Package commands
\n
Execute commands in all applicable packages via yarn lerna run [cmd]:
\n
\n\n
\n
Command
\n
Description
\n
\n\n\n
\n
test
\n
Run unit tests
\n
\n
\n
watch
\n
Rebuild on file changes
\n
\n
\n
build
\n
Build once
\n
\n\n
\n
Contribute
\n
Feel free to dive in! Open an issue, submit a\nPull Request or let’s discuss what should be next. ❤️
A clean and native interface to https://messages.google.com/web. Supports dark and light mode on macOS Mojave. This project is 100% open-source and available for macOS. Enjoy!
\n
\n
\n
Build Instructions
\n
To build a new version of the application, first download nativefier using the following command:
\n
yarn global add nativefier\n
\n
OR
\n
npm install nativefier -g\n
\n
Next, download the required CSS and image assets from one of the releases here located here. For example, you will need the electron.css and logo.png files.
\n
Last, you'll need to run the nativefier command to build your package.
Note: Nativefier allows for osx, mas, linux, and windows platform types. You can specify this with the --platform flag.
\n
\n
",
- "readmeOriginal": "
\n
Android Messages
\n
A clean and native interface to https://messages.google.com/web. Supports dark and light mode on macOS Mojave. This project is 100% open-source and available for macOS. Enjoy!
\n
\n
\n
Build Instructions
\n
To build a new version of the application, first download nativefier using the following command:
\n
yarn global add nativefier\n
\n
OR
\n
npm install nativefier -g\n
\n
Next, download the required CSS and image assets from one of the releases here located here. For example, you will need the electron.css and logo.png files.
\n
Last, you'll need to run the nativefier command to build your package.
Altus is an Electron-based WhatsApp client with themes and multiple account support, available for Windows, Mac and Linux!
\n
Features
\n
Altus uses the GitHub-produced Electron framework to wrap around WhatsApp Web and add extra features to it.
\n
\n
Multiple Account Support: As of v2.0, you can use multiple WhatsApp accounts simultaneously!
\n
Native notification support for all of the platforms. Clicking the notification opens that specific chat!
\n
Online Indicator: Shows an indicator at the bottom-left corner of the chats that are online!
\n
Dark mode for when you need to chill out your eyes in the night (or even in the day)
\n
Custom Theme Support: Write your own CSS theme for WhatsApp or use the in-built Theme Customizer to create a new one just by picking colors!
\n
Available for most desktop platforms including Windows (7 or above), Linux and MacOS.
\n
Tray icon so you can minimize the app completely and still receive notifications.
\n
\n
Feature Requests
\n
In order to submit a feature request, create a new issue with the label enhancement.
\n
Please make sure that you provide a helpful description of your feature request. If possible, try implementing the feature yourself by forking this repository and then creating a pull request.
\n
Screenshots
\n
First Start
\n
\n
Default Theme
\n
\n
\"Dark Plus\" Theme
\n
\n
Support
\n
If you like Altus, consider supporting it by donating using any of the following methods:
Marcelo Zapatta - PR #77 (Fixed #23 by adding tray icon support on Linux)
\n
",
+ "readmeOriginal": "
Altus
\n
\n
Altus is an Electron-based WhatsApp client with themes and multiple account support, available for Windows, Mac and Linux!
\n
Features
\n
Altus uses the GitHub-produced Electron framework to wrap around WhatsApp Web and add extra features to it.
\n
\n
Multiple Account Support: As of v2.0, you can use multiple WhatsApp accounts simultaneously!
\n
Native notification support for all of the platforms. Clicking the notification opens that specific chat!
\n
Online Indicator: Shows an indicator at the bottom-left corner of the chats that are online!
\n
Dark mode for when you need to chill out your eyes in the night (or even in the day)
\n
Custom Theme Support: Write your own CSS theme for WhatsApp or use the in-built Theme Customizer to create a new one just by picking colors!
\n
Available for most desktop platforms including Windows (7 or above), Linux and MacOS.
\n
Tray icon so you can minimize the app completely and still receive notifications.
\n
\n
Feature Requests
\n
In order to submit a feature request, create a new issue with the label enhancement.
\n
Please make sure that you provide a helpful description of your feature request. If possible, try implementing the feature yourself by forking this repository and then creating a pull request.
\n
Screenshots
\n
First Start
\n
\n
Default Theme
\n
\n
\"Dark Plus\" Theme
\n
\n
Support
\n
If you like Altus, consider supporting it by donating using any of the following methods:
🚀🚀🚀 A faster, better and more stable redis desktop manager, compatible with Linux, windows, mac. What's more, it won't crash when loading a large number of keys.
\n
\n
\n\n\n\n
\n
Windows
\n
Download latest exe package from release [or gitee in China], double click to install.
\n
Linux
\n
Download latest AppImage package from release [or gitee in China], chmod +x, double click to run.
\n
Mac
\n
\n
Download latest dmg package from release [or gitee in China], double click to install.
\n
Or by brew: brew install --cask another-redis-desktop-manager
\n
Or sponsor by app store, It's not free, and I will be very grateful to you.\n
\n
\n\n
Enjoy!
\n
\n\n
\n
\n
Feature Log
\n
\n
2021-06-30: Sentinel Support!!
\n
2021-06-24: ACL Support
\n
2021-05-03: Stream Support && Cli Command Tips Support
\n
2021-02-28: Connection Color Tag && Search History Support
\n
2021-02-03: Multiple Select\\Delete && Msgpack Viewer Support
\n
2020-12-30: Tree View Support!!!
\n
2020-11-03: Binary View Support && SSH Passparse\\Timeout Support
\n
2020-09-04: SSH Cluster Support && Extension Commands Support
\n
2020-06-18: SSL/TLS Support!!!
\n
2020-04-28: Page Zoom && Big Key Loads With Scan && Auto Json
\n
2020-04-18: Unvisible Key\\Value Format Support
\n
2020-04-04: Cluster Support!!!
\n
2020-03-13: Dark Mode Support!!! && JsonView In Other Place
\n
2020-02-16: SSH Private Key Support
\n
2020-02-13: Open Cli Console In Tabs
\n
2019-06-14: Custom Font-Family Support
\n
2019-05-28: Key List Resizable
\n
2019-05-09: Search Support In Hash List Set Zset
\n
2019-04-26: Auto Updater
\n
2019-04-09: SSH Tunnel Connection Support
\n
2019-04-01: Extract Search Support
\n
2019-02-22: Single Connection Support
\n
2019-01-08: Project Start
\n
\n
Dev Build
\n
Linux Or Mac
\n
# clone code\ngit clone https://github.com/qishibo/AnotherRedisDesktopManager.git --depth=1\ncd AnotherRedisDesktopManager\n\n# install dependencies\nnpm install\n\n# if download electron failed during installing, use this command\n# ELECTRON_MIRROR=\"https://npm.taobao.org/mirrors/electron/\" npm install\n\n# serve with hot reload at localhost:9988\nnpm start\n\n\n# after the previous step is completed to 100%, open another tab, build up a desktop client\nnpm run electron
\n
If linux errors like this:
\n
# if error like this\n../src/FontManagerLinux.cc:1:35: fatal error: fontconfig/fontconfig.h: No such file or directory\n\n# then try this\nsudo apt install libfontconfig1-dev
\n
Windows
\n
# install build tools for the first time, just execute once\nnpm install -g windows-build-tools\n\n# clone code\ngit clone https://github.com/qishibo/AnotherRedisDesktopManager.git --depth=1\ncd AnotherRedisDesktopManager\n\n# install dependencies, 32-bit or 64-bit all use win32\nnpm install --platform=win32\n\n# if download electron failed during installing, use this command\n# npm config set ELECTRON_MIRROR http://npm.taobao.org/mirrors/electron/\n# npm install --platform=win32\n\n# serve with hot reload at localhost:9988\nnpm start\n\n\n# after the previous step is completed to 100%, open another tab, build up a desktop client\nnpm run electron
\n
Build Package
\n
# prepare before package\nnpm run pack:prepare\n\n# build package on respective platforms\n# on windows build 64bit package\nnpm run pack:win\n# on windows build 32bit package\nnpm run pack:win32\n\n# on mac\nnpm run pack:mac\n\n# on linux\nnpm run pack:linux
🚀🚀🚀 A faster, better and more stable redis desktop manager, compatible with Linux, windows, mac. What's more, it won't crash when loading a large number of keys.
\n
\n
\n\n\n\n
\n
Windows
\n
Download latest exe package from release [or gitee in China], double click to install.
\n
Linux
\n
Download latest AppImage package from release [or gitee in China], chmod +x, double click to run.
\n
Mac
\n
\n
Download latest dmg package from release [or gitee in China], double click to install.
\n
Or by brew: brew install --cask another-redis-desktop-manager
\n
Or sponsor by app store, It's not free, and I will be very grateful to you.\n
\n
\n\n
Enjoy!
\n
\n\n
\n
\n
Feature Log
\n
\n
2021-06-30: Sentinel Support!!
\n
2021-06-24: ACL Support
\n
2021-05-03: Stream Support && Cli Command Tips Support
\n
2021-02-28: Connection Color Tag && Search History Support
\n
2021-02-03: Multiple Select\\Delete && Msgpack Viewer Support
\n
2020-12-30: Tree View Support!!!
\n
2020-11-03: Binary View Support && SSH Passparse\\Timeout Support
\n
2020-09-04: SSH Cluster Support && Extension Commands Support
\n
2020-06-18: SSL/TLS Support!!!
\n
2020-04-28: Page Zoom && Big Key Loads With Scan && Auto Json
\n
2020-04-18: Unvisible Key\\Value Format Support
\n
2020-04-04: Cluster Support!!!
\n
2020-03-13: Dark Mode Support!!! && JsonView In Other Place
\n
2020-02-16: SSH Private Key Support
\n
2020-02-13: Open Cli Console In Tabs
\n
2019-06-14: Custom Font-Family Support
\n
2019-05-28: Key List Resizable
\n
2019-05-09: Search Support In Hash List Set Zset
\n
2019-04-26: Auto Updater
\n
2019-04-09: SSH Tunnel Connection Support
\n
2019-04-01: Extract Search Support
\n
2019-02-22: Single Connection Support
\n
2019-01-08: Project Start
\n
\n
Dev Build
\n
Linux Or Mac
\n
# clone code\ngit clone https://github.com/qishibo/AnotherRedisDesktopManager.git --depth=1\ncd AnotherRedisDesktopManager\n\n# install dependencies\nnpm install\n\n# if download electron failed during installing, use this command\n# ELECTRON_MIRROR=\"https://npm.taobao.org/mirrors/electron/\" npm install\n\n# serve with hot reload at localhost:9988\nnpm start\n\n\n# after the previous step is completed to 100%, open another tab, build up a desktop client\nnpm run electron
\n
If linux errors like this:
\n
# if error like this\n../src/FontManagerLinux.cc:1:35: fatal error: fontconfig/fontconfig.h: No such file or directory\n\n# then try this\nsudo apt install libfontconfig1-dev
\n
Windows
\n
# install build tools for the first time, just execute once\nnpm install -g windows-build-tools\n\n# clone code\ngit clone https://github.com/qishibo/AnotherRedisDesktopManager.git --depth=1\ncd AnotherRedisDesktopManager\n\n# install dependencies, 32-bit or 64-bit all use win32\nnpm install --platform=win32\n\n# if download electron failed during installing, use this command\n# npm config set ELECTRON_MIRROR http://npm.taobao.org/mirrors/electron/\n# npm install --platform=win32\n\n# serve with hot reload at localhost:9988\nnpm start\n\n\n# after the previous step is completed to 100%, open another tab, build up a desktop client\nnpm run electron
\n
Build Package
\n
# prepare before package\nnpm run pack:prepare\n\n# build package on respective platforms\n# on windows build 64bit package\nnpm run pack:win\n# on windows build 32bit package\nnpm run pack:win32\n\n# on mac\nnpm run pack:mac\n\n# on linux\nnpm run pack:linux
Head to the releases page and download the appropriate installer for your system.
\n
Snapcraft
\n
Ubuntu Linux users can directly install through Snapcraftsnap install ao
\n
Homebrew
\n
Macos users can directly install through Homebrew Caskbrew cask install ao
\n
Note
\n
The version available on Homebrew Cask may not be the latest, since unlike Snapcraft, it is not offically maintained. If that is the case, please consider downloading directly from the Github releases page.
\n
Features
\n
Visit the project homepage to view all features in detail.
\n
\n
Auto Night Mode - Press Cmd/CtrlAltN to allow Tusk to adjust to your environment.
\n
Black Theme - Activate it by pressing Cmd/CtrlB
\n
Compact Mode - Downsize the window to enter the mode.
\n
Custom Shortcut Keys - Navigate to ~/.ao.json or press Cmd/Ctrl. to modify any shortcut key. To reset delete ~/.ao.json & restart the app.
\n
Dark Theme -Activate it by pressing Cmd/CtrlH
\n
Global Shortcut Keys - Enable them by using the File > Enable Global Shortcut Keys option.
\n
List Navigation - Navigate your lists by pressing Cmd/CtrlTab / Cmd/CtrlShiftTab or jump directly to one by using Cmd/Ctrl1 - 9
\n
Scalable Interface - Adjust the zooming factor by pressing Cmd/CtrlShift= or Cmd/Ctrl-.
\n
Sepia Theme - Activate it by pressing Cmd/CtrlG.
\n
Update Notifications - Customize the app's update checking frequency.
\n
\n
Keyboard Shortcuts
\n
Local Shortcut Keys
\n
40+ local keyboard shortcuts. Toggle anything in a flash.
\n\nView all the available local keyboard shortcuts.\n \n
\n\n
\n
Description
\n
Keys
\n
\n\n\n
\n
Activate Auto Night Mode
\n
Cmd/CtrlAltN
\n
\n
\n
Add Due Date
\n
Cmd/CtrlShiftT
\n
\n
\n
Add Todo to My Day
\n
Cmd/CtrlK
\n
\n
\n
Complete Todo
\n
Cmd/CtrlShiftN
\n
\n
\n
Delete List
\n
Cmd/CtrlShiftD
\n
\n
\n
Delete Todo
\n
Cmd/CtrlD
\n
\n
\n
Edit Shortcut Keys
\n
Cmd/Ctrl.
\n
\n
\n
Hide Completed Todos
\n
Cmd/CtrlShiftH
\n
\n
\n
Jump to List
\n
Cmd/Ctrl1 - 9
\n
\n
\n
Make Text Larger
\n
Cmd/CtrlShift=
\n
\n
\n
Make Text Smaller
\n
Cmd/Ctrl-
\n
\n
\n
Navigate to Next List
\n
Cmd/CtrlTab
\n
\n
\n
New List
\n
Cmd/CtrlL
\n
\n
\n
New Todo
\n
Cmd/CtrlN
\n
\n
\n
Rename List
\n
Cmd/CtrlY
\n
\n
\n
Rename Todo
\n
Cmd/CtrlT
\n
\n
\n
Reset Zoom Level
\n
Cmd/Ctrl0
\n
\n
\n
Return to Todos
\n
Esc
\n
\n
\n
Search Todos
\n
Cmd/CtrlF
\n
\n
\n
Set Always on Top
\n
Cmd/CtrlShiftP
\n
\n
\n
Set Reminder
\n
Cmd/CtrlShiftE
\n
\n
\n
Sign out
\n
Cmd/CtrlAltQ
\n
\n
\n
Toggle Black Theme
\n
Cmd/CtrlB
\n
\n
\n
Toggle Dark Theme
\n
Cmd/CtrlH
\n
\n
\n
Toggle Important
\n
Cmd/CtrlI
\n
\n
\n
Toggle My Day
\n
Cmd/CtrlM
\n
\n
\n
Toggle Planned
\n
Cmd/CtrlP
\n
\n
\n
Toggle Sepia Theme
\n
Cmd/CtrlG
\n
\n
\n
Toggle Settings
\n
Cmd/Ctrl,
\n
\n
\n
Toggle Sidebar
\n
Cmd/CtrlO
\n
\n
\n
Toggle Tasks
\n
Cmd/CtrlJ
\n
\n
\n
Toggle Window Menu
\n
Alt
\n
\n\n
\n \n\n
Global Shortcut Keys
\n
Access Ao at any moment from anywhere within your operating system. All global shortcuts can be customized to match your own preference through the configuration file ~/.ao.json.
\n\nView all the available global keyboard shortcuts.\n \n
Head to the releases page and download the appropriate installer for your system.
\n
Snapcraft
\n
Ubuntu Linux users can directly install through Snapcraftsnap install ao
\n
Homebrew
\n
Macos users can directly install through Homebrew Caskbrew cask install ao
\n
Note
\n
The version available on Homebrew Cask may not be the latest, since unlike Snapcraft, it is not offically maintained. If that is the case, please consider downloading directly from the Github releases page.
\n
Features
\n
Visit the project homepage to view all features in detail.
\n
\n
Auto Night Mode - Press Cmd/CtrlAltN to allow Tusk to adjust to your environment.
\n
Black Theme - Activate it by pressing Cmd/CtrlB
\n
Compact Mode - Downsize the window to enter the mode.
\n
Custom Shortcut Keys - Navigate to ~/.ao.json or press Cmd/Ctrl. to modify any shortcut key. To reset delete ~/.ao.json & restart the app.
\n
Dark Theme -Activate it by pressing Cmd/CtrlH
\n
Global Shortcut Keys - Enable them by using the File > Enable Global Shortcut Keys option.
\n
List Navigation - Navigate your lists by pressing Cmd/CtrlTab / Cmd/CtrlShiftTab or jump directly to one by using Cmd/Ctrl1 - 9
\n
Scalable Interface - Adjust the zooming factor by pressing Cmd/CtrlShift= or Cmd/Ctrl-.
\n
Sepia Theme - Activate it by pressing Cmd/CtrlG.
\n
Update Notifications - Customize the app's update checking frequency.
\n
\n
Keyboard Shortcuts
\n
Local Shortcut Keys
\n
40+ local keyboard shortcuts. Toggle anything in a flash.
\n\nView all the available local keyboard shortcuts.\n \n
\n\n
\n
Description
\n
Keys
\n
\n\n\n
\n
Activate Auto Night Mode
\n
Cmd/CtrlAltN
\n
\n
\n
Add Due Date
\n
Cmd/CtrlShiftT
\n
\n
\n
Add Todo to My Day
\n
Cmd/CtrlK
\n
\n
\n
Complete Todo
\n
Cmd/CtrlShiftN
\n
\n
\n
Delete List
\n
Cmd/CtrlShiftD
\n
\n
\n
Delete Todo
\n
Cmd/CtrlD
\n
\n
\n
Edit Shortcut Keys
\n
Cmd/Ctrl.
\n
\n
\n
Hide Completed Todos
\n
Cmd/CtrlShiftH
\n
\n
\n
Jump to List
\n
Cmd/Ctrl1 - 9
\n
\n
\n
Make Text Larger
\n
Cmd/CtrlShift=
\n
\n
\n
Make Text Smaller
\n
Cmd/Ctrl-
\n
\n
\n
Navigate to Next List
\n
Cmd/CtrlTab
\n
\n
\n
New List
\n
Cmd/CtrlL
\n
\n
\n
New Todo
\n
Cmd/CtrlN
\n
\n
\n
Rename List
\n
Cmd/CtrlY
\n
\n
\n
Rename Todo
\n
Cmd/CtrlT
\n
\n
\n
Reset Zoom Level
\n
Cmd/Ctrl0
\n
\n
\n
Return to Todos
\n
Esc
\n
\n
\n
Search Todos
\n
Cmd/CtrlF
\n
\n
\n
Set Always on Top
\n
Cmd/CtrlShiftP
\n
\n
\n
Set Reminder
\n
Cmd/CtrlShiftE
\n
\n
\n
Sign out
\n
Cmd/CtrlAltQ
\n
\n
\n
Toggle Black Theme
\n
Cmd/CtrlB
\n
\n
\n
Toggle Dark Theme
\n
Cmd/CtrlH
\n
\n
\n
Toggle Important
\n
Cmd/CtrlI
\n
\n
\n
Toggle My Day
\n
Cmd/CtrlM
\n
\n
\n
Toggle Planned
\n
Cmd/CtrlP
\n
\n
\n
Toggle Sepia Theme
\n
Cmd/CtrlG
\n
\n
\n
Toggle Settings
\n
Cmd/Ctrl,
\n
\n
\n
Toggle Sidebar
\n
Cmd/CtrlO
\n
\n
\n
Toggle Tasks
\n
Cmd/CtrlJ
\n
\n
\n
Toggle Window Menu
\n
Alt
\n
\n\n
\n \n\n
Global Shortcut Keys
\n
Access Ao at any moment from anywhere within your operating system. All global shortcuts can be customized to match your own preference through the configuration file ~/.ao.json.
\n\nView all the available global keyboard shortcuts.\n \n
Altair is a beautiful feature-rich GraphQL Client IDE for all platforms. Available for MacOS, Windows, Linux, Chrome, Firefox.\nIt enables you interact with any GraphQL server you are authorized to access from any platform you are on.
\n
Features
\n
Altair provides several features that make developing with GraphQL very efficient and friendly. These features include:
Is there a feature that is missing? You can let us know by creating a new issue or you can add the feature by creating a Pull Request.
\n
Sponsors
\n
Thanks to all our sponsors for sponsoring this project! Do you use Altair GraphQL client at your company? Consider supporting this project as a major sponsor (primary, gold, silver or bronze) on open collective.
instanceStorageNamespacestring - Namespace for storing the data for the altair instance. Use this when you have multiple altair instances running on the same domain. e.g. 'altair_dev_'
Altair has been tested in the latest versions of Google Chrome and Mozilla Firefox. It might not work as expected in other browsers like Safari and Edge.
Altair is a beautiful feature-rich GraphQL Client IDE for all platforms. Available for MacOS, Windows, Linux, Chrome, Firefox.\nIt enables you interact with any GraphQL server you are authorized to access from any platform you are on.
\n
Features
\n
Altair provides several features that make developing with GraphQL very efficient and friendly. These features include:
Is there a feature that is missing? You can let us know by creating a new issue or you can add the feature by creating a Pull Request.
\n
Sponsors
\n
Thanks to all our sponsors for sponsoring this project! Do you use Altair GraphQL client at your company? Consider supporting this project as a major sponsor (primary, gold, silver or bronze) on open collective.
instanceStorageNamespacestring - Namespace for storing the data for the altair instance. Use this when you have multiple altair instances running on the same domain. e.g. 'altair_dev_'
Altair has been tested in the latest versions of Google Chrome and Mozilla Firefox. It might not work as expected in other browsers like Safari and Edge.
Antares is an SQL client based on Electron.js and Vue.js that aims to become a useful tool, especially for developers. \nMy target is to support as many databases as possible, and all major operating systems, including the ARM versions.
\n
At the moment this application is in development state, many features will come in future updates, and supports only MySQL/MariaDB and PostgreSQL. \nAt the moment, however, there are all the features necessary to have a pleasant database management experience, so give it a chance and send us your feedback, we would really appreciate it. \nWe are actively working on it, hoping to provide new cool features, improvements and fixes as soon as possible.
\n
🔗 If you are curious to try Antares you can download and install the latest release. \n👁 To stay tuned for new releases follow Antares SQL on Twitter. \n🌟 Don't forget to leave a star if you appreciate this project.
\n
Philosophy
\n
Why are we developing an SQL client when there are a lot of them on the market? \nThe main goal is to develop a totally free, full featured, cross platform and open source alternative, empowered by JavaScript's ecosystem. \nA modern application created with minimalism and semplicity in mind, with features in the right places, not hundreds of tiny buttons, nested tabs or submenu; productivity comes first.
Antares is an SQL client based on Electron.js and Vue.js that aims to become a useful tool, especially for developers. \nMy target is to support as many databases as possible, and all major operating systems, including the ARM versions.
\n
At the moment this application is in development state, many features will come in future updates, and supports only MySQL/MariaDB and PostgreSQL. \nAt the moment, however, there are all the features necessary to have a pleasant database management experience, so give it a chance and send us your feedback, we would really appreciate it. \nWe are actively working on it, hoping to provide new cool features, improvements and fixes as soon as possible.
\n
🔗 If you are curious to try Antares you can download and install the latest release. \n👁 To stay tuned for new releases follow Antares SQL on Twitter. \n🌟 Don't forget to leave a star if you appreciate this project.
\n
Philosophy
\n
Why are we developing an SQL client when there are a lot of them on the market? \nThe main goal is to develop a totally free, full featured, cross platform and open source alternative, empowered by JavaScript's ecosystem. \nA modern application created with minimalism and semplicity in mind, with features in the right places, not hundreds of tiny buttons, nested tabs or submenu; productivity comes first.
🚀🚀🚀 A faster, better and more stable redis desktop manager, compatible with Linux, windows, mac. What's more, it won't crash when loading a large number of keys.
\n
\n
\n\n\n\n
\n
Windows
\n
Download latest exe package from release [or gitee in China], double click to install.
\n
Linux
\n
Download latest AppImage package from release [or gitee in China], chmod +x, double click to run.
\n
Mac
\n
\n
Download latest dmg package from release [or gitee in China], double click to install.
\n
Or by brew: brew install --cask another-redis-desktop-manager
\n
Or sponsor by app store, It's not free, and I will be very grateful to you.\n
\n
\n\n
Enjoy!
\n
\n\n
\n
\n
Feature Log
\n
\n
2021-06-30: Sentinel Support!!
\n
2021-06-24: ACL Support
\n
2021-05-03: Stream Support && Cli Command Tips Support
\n
2021-02-28: Connection Color Tag && Search History Support
\n
2021-02-03: Multiple Select\\Delete && Msgpack Viewer Support
\n
2020-12-30: Tree View Support!!!
\n
2020-11-03: Binary View Support && SSH Passparse\\Timeout Support
\n
2020-09-04: SSH Cluster Support && Extension Commands Support
\n
2020-06-18: SSL/TLS Support!!!
\n
2020-04-28: Page Zoom && Big Key Loads With Scan && Auto Json
\n
2020-04-18: Unvisible Key\\Value Format Support
\n
2020-04-04: Cluster Support!!!
\n
2020-03-13: Dark Mode Support!!! && JsonView In Other Place
\n
2020-02-16: SSH Private Key Support
\n
2020-02-13: Open Cli Console In Tabs
\n
2019-06-14: Custom Font-Family Support
\n
2019-05-28: Key List Resizable
\n
2019-05-09: Search Support In Hash List Set Zset
\n
2019-04-26: Auto Updater
\n
2019-04-09: SSH Tunnel Connection Support
\n
2019-04-01: Extract Search Support
\n
2019-02-22: Single Connection Support
\n
2019-01-08: Project Start
\n
\n
Dev Build
\n
Linux Or Mac
\n
# clone code\ngit clone https://github.com/qishibo/AnotherRedisDesktopManager.git --depth=1\ncd AnotherRedisDesktopManager\n\n# install dependencies\nnpm install\n\n# if download electron failed during installing, use this command\n# ELECTRON_MIRROR=\"https://npm.taobao.org/mirrors/electron/\" npm install\n\n# serve with hot reload at localhost:9988\nnpm start\n\n\n# after the previous step is completed to 100%, open another tab, build up a desktop client\nnpm run electron
\n
If linux errors like this:
\n
# if error like this\n../src/FontManagerLinux.cc:1:35: fatal error: fontconfig/fontconfig.h: No such file or directory\n\n# then try this\nsudo apt install libfontconfig1-dev
\n
Windows
\n
# install build tools for the first time, just execute once\nnpm install -g windows-build-tools\n\n# clone code\ngit clone https://github.com/qishibo/AnotherRedisDesktopManager.git --depth=1\ncd AnotherRedisDesktopManager\n\n# install dependencies, 32-bit or 64-bit all use win32\nnpm install --platform=win32\n\n# if download electron failed during installing, use this command\n# npm config set ELECTRON_MIRROR http://npm.taobao.org/mirrors/electron/\n# npm install --platform=win32\n\n# serve with hot reload at localhost:9988\nnpm start\n\n\n# after the previous step is completed to 100%, open another tab, build up a desktop client\nnpm run electron
\n
Build Package
\n
# prepare before package\nnpm run pack:prepare\n\n# build package on respective platforms\n# on windows build 64bit package\nnpm run pack:win\n# on windows build 32bit package\nnpm run pack:win32\n\n# on mac\nnpm run pack:mac\n\n# on linux\nnpm run pack:linux
🚀🚀🚀 A faster, better and more stable redis desktop manager, compatible with Linux, windows, mac. What's more, it won't crash when loading a large number of keys.
\n
\n
\n\n\n\n
\n
Windows
\n
Download latest exe package from release [or gitee in China], double click to install.
\n
Linux
\n
Download latest AppImage package from release [or gitee in China], chmod +x, double click to run.
\n
Mac
\n
\n
Download latest dmg package from release [or gitee in China], double click to install.
\n
Or by brew: brew install --cask another-redis-desktop-manager
\n
Or sponsor by app store, It's not free, and I will be very grateful to you.\n
\n
\n\n
Enjoy!
\n
\n\n
\n
\n
Feature Log
\n
\n
2021-06-30: Sentinel Support!!
\n
2021-06-24: ACL Support
\n
2021-05-03: Stream Support && Cli Command Tips Support
\n
2021-02-28: Connection Color Tag && Search History Support
\n
2021-02-03: Multiple Select\\Delete && Msgpack Viewer Support
\n
2020-12-30: Tree View Support!!!
\n
2020-11-03: Binary View Support && SSH Passparse\\Timeout Support
\n
2020-09-04: SSH Cluster Support && Extension Commands Support
\n
2020-06-18: SSL/TLS Support!!!
\n
2020-04-28: Page Zoom && Big Key Loads With Scan && Auto Json
\n
2020-04-18: Unvisible Key\\Value Format Support
\n
2020-04-04: Cluster Support!!!
\n
2020-03-13: Dark Mode Support!!! && JsonView In Other Place
\n
2020-02-16: SSH Private Key Support
\n
2020-02-13: Open Cli Console In Tabs
\n
2019-06-14: Custom Font-Family Support
\n
2019-05-28: Key List Resizable
\n
2019-05-09: Search Support In Hash List Set Zset
\n
2019-04-26: Auto Updater
\n
2019-04-09: SSH Tunnel Connection Support
\n
2019-04-01: Extract Search Support
\n
2019-02-22: Single Connection Support
\n
2019-01-08: Project Start
\n
\n
Dev Build
\n
Linux Or Mac
\n
# clone code\ngit clone https://github.com/qishibo/AnotherRedisDesktopManager.git --depth=1\ncd AnotherRedisDesktopManager\n\n# install dependencies\nnpm install\n\n# if download electron failed during installing, use this command\n# ELECTRON_MIRROR=\"https://npm.taobao.org/mirrors/electron/\" npm install\n\n# serve with hot reload at localhost:9988\nnpm start\n\n\n# after the previous step is completed to 100%, open another tab, build up a desktop client\nnpm run electron
\n
If linux errors like this:
\n
# if error like this\n../src/FontManagerLinux.cc:1:35: fatal error: fontconfig/fontconfig.h: No such file or directory\n\n# then try this\nsudo apt install libfontconfig1-dev
\n
Windows
\n
# install build tools for the first time, just execute once\nnpm install -g windows-build-tools\n\n# clone code\ngit clone https://github.com/qishibo/AnotherRedisDesktopManager.git --depth=1\ncd AnotherRedisDesktopManager\n\n# install dependencies, 32-bit or 64-bit all use win32\nnpm install --platform=win32\n\n# if download electron failed during installing, use this command\n# npm config set ELECTRON_MIRROR http://npm.taobao.org/mirrors/electron/\n# npm install --platform=win32\n\n# serve with hot reload at localhost:9988\nnpm start\n\n\n# after the previous step is completed to 100%, open another tab, build up a desktop client\nnpm run electron
\n
Build Package
\n
# prepare before package\nnpm run pack:prepare\n\n# build package on respective platforms\n# on windows build 64bit package\nnpm run pack:win\n# on windows build 32bit package\nnpm run pack:win32\n\n# on mac\nnpm run pack:mac\n\n# on linux\nnpm run pack:linux
Appium Desktop is a suite of apps for Mac, Windows, and Linux which gives you the power of the Appium automation server in a beautiful and flexible UI. It is a combination of a few Appium-related tools:
\n
\n
A graphical interface for the Appium Server. You can set options, start/stop the server, see logs, etc... You also don't need to use Node/NPM to install Appium, as the Node runtime comes bundled with Appium Desktop.
\n
An Inspector that you can use to look at your app's elements (Safari/Chrome browser, native or hybrid app), get basic information about them, and perform basic interactions with them. This is useful as a way to learn about Appium or as a way to learn about your app so you can write tests for it.
\n
\n
Download Appium Desktop
\n
You can always pick up the latest release of the Server GUI or the Inspector at our\nRelease page on\nGitHub.
\n
If you're on Windows or macOS, Appium Desktop will automatically provide you\nwith updated versions of the app when they are released. If you encounter\na problem updating, simply delete or uninstall the app and re-download the\nlatest from the link above.
\n
Note that Appium Desktop is not the same thing as Appium. Appium Desktop is\na graphical frontend to Appium with additional tools. Appium Desktop is\nreleased on its own cadence and has its own versioning system. If you are\nreporting an issue with Appium Desktop, always be sure to include both the\nversion of Appium Desktop and the version of the Appium Server which is in use\n(see below).
\n
If you're on macOS, you will need to install Appium Desktop apps by copying the app\nfrom the downloaded DMG file to your own file system (the best place is the\n\"Applications\" folder). Running Appium from in side the attached DMG itself is\nnot supported, and will not work.
\n
Known Issues
\n
\n
Some Windows 10 Users experience a PathTooLongException when installing the EXE. The workaround for this is to update the setting on Windows to enable long paths
\n
\n
Usage Instructions
\n
These instructions assume you are already familiar with Appium and Appium-related concepts. If you\nare new to Appium, please visit appium.io and read our introductory material.\nThey also assume that you have downloaded both the Server GUI and the Inspector apps.
\n
This app provides a convenient way to download and run the Appium automation\nserver, as well as a tool for inspecting elements in Chrome/Safari browser and your Android or iOS application. Its\nvarious capabilities are described in the following sections.
\n
The Appium Desktop Server GUI
\n
Starting a simple server
\n
\n
When you open Appium Desktop, you are greeted with the server start window. The\nbasic option is to start an Appium server with all its defaults and the ability\nto modify the host and port. The start button will also let you know which\nversion of the Appium server you are running, which can be useful when\nreporting issues to the Appium team.
\n
Starting a server with advanced options
\n
\n
By clicking on the 'Advanced' tab, you have the ability to set all the server\nflags that are available in Appium. This is for advanced users and should only\nbe modified after consulting the Appium documentation.
\n
Server presets
\n
\n
If you use the advanced server options, you have the ability to save\na configuration for later use. Simply save the preset on the 'Advanced' tab,\nand you will subsequently be able to recall and start the server with that\nconfiguration from the 'Preset' tab.
\n
The server console output window
\n
Once you start the server, it will launch on the host and port you specified,\nand open a new window displaying the server log output.
\n
\n
This is fairly straightforward and no real interaction is possible, beyond\nusing the button to stop the server. You can also copy-and-paste the logs from\nthis window which is useful in reporting Appium issues.
\n
The Appium Desktop Inspector
\n
The Inspector opens up with a New Session windows. This New Session window allows you to construct\na set of Appium desired capabilities used to launch an Appium session. You can launch a session\nagainst the currently-running Appium CLI or Appium Server GUI server, or you can launch a session\nagainst a variety of other endpoints. Simply include the connection details for any server that you\nwish to connect to.
\n
IMPORTANT: to ensure that the Inspector can talk to your Appium server, any Appium server you\nconnect to from the Inspector may need to be started with the --allow-cors flag, so that\nChrome/Electron's content security policies don't prevent the Inspector from making requests to the\nserver (which may be running on a different host and port). If you get immediate errors when\ntalking to your Appium server, ensure that this setting is configured on your server.
\n
\n
You can add available cloud providers as new tabs.\nWhen you select Select Cloud Providers tab on the view,\nSelect Cloud Providers dialog appears.\nYou can select some of them and click Done, they will appear on\nthe New session window as tabs.
\n
\n
Appium Endpoints
\n
These are the options for launching a session against a non-local Appium server:
\n
\n\n
\n
Endpoint
\n
Description
\n
\n\n\n
\n
Automatic server
\n
Automatically utilizes the currently-running Appium server
\n
\n
\n
Custom Server
\n
Launch a session on an Appium server running on another machine over the network
It should be straightforward to get set up with any of these options. Simply\nenter your details in the input fields provided.
\n
Desired Capabilities
\n
Desired capabilities are how you configure your Appium session. They tell the\nAppium server what kind of platform and app you want to automate. If you are\nunfamiliar with the concept of desired capabilities, or which desired\ncapabilities are required to launch Appium sessions of various types, you\nshould consult the Appium documentation. Additionally, if you're using one of\nthe cloud providers, consult their documentation for possible vendor-specific\ndetails.
\n
Appium Desktop does not restrict your creation of desired capabilities in any\nway, nor will it validate them for you. It simply provides a nice UI for\nentering them in, and saving them for later use. Under the 'Desired\nCapabilities' tab, you can use the form fields and '+' button to enter as many\ndesired capabilities as you need. You will also see a representation of the\nresulting JSON, which is what is actually sent to the Appium server. This can\nbe useful for verifying your capabilities, or for copy-and-pasting when\nreporting issues.
\n
Once you have set your desired capabilities, you might wish to save them so you\ncan run the same type of session later. Simply click the 'Save As...' button to\ngive your capability set a name. You can then access it under the 'Saved\nCapability Sets' tab, for later editing or session launching.
\n
Once your server type and capabilities are set, click 'Start Session' to launch\nthe Appium Desktop Inspector.
\n
Attach to an Existing Session
\n
If you click on the \"Attach to Session...\" tab, you can select an existing\nsession from a list of currently running sessions on your selected server, or you\ncan input a session ID of a currently-running session. That session should be\nrunning on the server details you specified in the server type section above.\nAttaching to an existing session is possible because the Inspector is just an\nAppium client. This could be useful if you want to debug the middle of a running\ntest. When you quit the Inspector window of an existing session, Appium Desktop\nwill not quit the session as it does normally.
\n
The Inspector
\n
The Inspector is a visual representation of the state of your application along\nwith the ability to perform certain interactions in your application through\nAppium.
\n
\n
Appium sessions can take some time to load, especially on cloud services, so\nplease be patient. When the session loads, a screenshot of your app will appear\non the left. You can mouse over various UI elements in your application, and\nsee them highlighted.
\n
In the middle of the Inspector window is your app's hierarchy, represented as\nXML. You can navigate this tree by clicking through it, or by clicking on\nelements in the screenshot view. They will then be highlighted.
\n
When an element is highlighted, its information will appear in the detail view\non the right side of the Inspector. This detail view consists of potential\nactions to take against the element, and a table of the element's properties.\nThese properties are valuable in determining how the element might accessed\nusing a particular Appium locator strategy. With an element selected, you can\nalso 'Tap' the element, or 'Send Keys' to the element (if it is a text field).
\n
When you take such an action with an element, the Inspector will send the\ncommand to Appium, which will execute it. If the action is successful, a new\nscreenshot will be generated and you should see the updated state and XML of\nyour app. If it's not successful, you'll have an opportunity to see the error\nmessage.
\n
The top of the Inspector window contains a small toolbar with icons\nrepresenting the ability to take certain actions in the Inspector:
\n
\n
Back (call driver.back)
\n
Refresh (refresh the source and screenshot)
\n
Start Recording (open the recorder, see the next section for more information on the recorder)
\n
Quit the session (call driver.quit and close the Inspector)
\n
\n
The inspector for Hybrid or Web apps
\n
Appium Desktop can also inspect the Webview of your Hybrid app or inspect elements in the Chrome of Safari browser.\nIt will automatically determine for Android or iOS if a webview is detected and will notify you about this in the right part of the screen.
\n
\n
A select box of all found contexts will be shown and after selecting a context the source will be updated and show the source.\nThe below screenshot shows the HTML source of the Appium Desktop documentation website
\n
.
\n
As of Appium Desktop version 1.18.0 it will automatically enable showing the HTML-source if a Chrome or Safari session is started.
\n
More selector options
\n
XML is not a native programming language for iOS as it is with Android. Appium will automatically translate the iOS-UIHierarchy into XML, but this is a time-consuming process.\nThe XML will be used to provide a XPATH that can be used to find elements. When you use that XPATH selector with iOS during automation, Appium always needs to do the translation which will slow down the test execution (for more info see Appium Pro newsletter 8).
\n
As of Appium Desktop version 1.18.0 it will, if possible, also provide the:
selector options together with a Get Timing button.
\n
.
\n
When you select an iOS element in Appium Desktop and press the Get Timing-button it will provide you the time in milliseconds\nit will take per selector to find the element and will automatically sort them from fast to the slowest.\nIn most cases you will see that XPATH is the slowest locator strategy in comparison to the other options.
\n
.
\n
The Recorder
\n
Appium Desktop comes with a very basic action recorder, that watches for\nactions taken using Appium Desktop and displays language-and-framework-specific\ncode that represents those actions. The code can then be copied-and-pasted into\nthe appropriate Appium client code and used for tests.
\n
NB: the goal of the Recorder is not to produce production-ready test code.\nIt is designed as a tool to help explore the Appium API, and demonstrate how\ncertain automation behaviors correspond to method calls in a particular\nlanguage and Appium library. In sum, it is a learning tool, not a robust code\ngeneration feature, and should be used as such.
\n
When you start recording, the Inspector will show an additional window:
\n
\n
At first, the Recorder will show no code. You will first have to take some\naction, like finding an element in the hierarchy and tapping on it, or sending\nkeystrokes to it. When you do this, code will appear in the recorder window,\ncorresponding to the particular language and framework you have chosen (which\ncan be adjusted in the drop-down menu at the top right of the Recorder):
\n
\n
This code can be copied to your clipboard using the appropriate button at the\ntop right of the Recorder pane. Note that by default what is shown are simply\nlines of code corresponding to the specific actions you have taken while\nrecording---in general you cannot paste these lines into an empty text file and\nrun the code. To run Appium test scripts in code requires that various\ndependencies (like the Appium client libraries) be installed, and that script\nboilerplate (like instantiating a driver and initializing a session) be\npresent. To show this additional code, you can click the \"Show Boilerplate\"\nbutton. With boilerplate code shown, it is possible to copy and paste the code\ninto a new file and run it.
\n
\n
The power of the Recorder will continue to grow as we add more languages,\nframeworks, and actions to Appium Desktop.
\n
Conclusion
\n
This is everything you need to know to use Appium Desktop successfully!\nRemember, Appium Desktop is not a replacement for understanding Appium\nitself---it is simply a convenient tool for working with Appium on your\ndesktop, and an Inspector for exploring your app. Have fun!
\n
Reporting Issues and Requesting Features
\n
Appium Desktop is open source, and we use GitHub for issue tracking. Please\nsimply report issues at our issue\ntracker. We will endeavor to\ndetermine whether the issue you are reporting is related to Appium Desktop or\nAppium Server. If it's not related to Appium Desktop specifically, we will\nclose the issue and ask you to open a general Appium issue at Appium's main\nissue tracker. Please, save\nyourselves and us valuable time by getting clear on whether the issue you're\nexperiencing is related to Appium Desktop specifically or instead is a general\nAppium issue. You can do this by seeing whether the issue reproduces with the\nAppium command line server as well. If it does, direct your report to Appium's\nissue tracker.
\n
Have a feature request? Follow the same process and submit an issue to the\nappropriate tracker! (Either here in this repo if the request is specifically\nfor Appium Desktop, or Appium's main tracker if the request is for Appium more\ngenerally.)
\n
Advanced Topics and Troubleshooting
\n
Connect to local Appium server
\n
Appium Desktop has own Appium CLI. You can launch it via Starting a simple server.\nBut sometimes you need another Appium version which is bundled in the desktop.\nFor example, when you want to use Appium beta.
Connect to the running Appium server as Custom Server as below (by default)\n
\n
Remote Host: localhost
\n
Remote Port: 4723
\n
Remote Path: /wd/hub
\n
\n
\n
Start session
\n\n
Appium can't detect environment variables on Mac
\n
Appium uses environment variables like ANDROID_HOME as well as relying on\nvarious binaries in your PATH and so on. When running from the command line\nin an environment where you have set these variables appropriately, Appium has\nno problem in picking them up. However, Appium Desktop does not run in a shell\nor a command-line environment, and so by default it does not have access to\nenvironment variables you have set in your shell startup script or profile. To\nwork around this, we use the\nshell-env package to pick up\nenvironment variables defined in your shell. This package only looks in certain\ncommon init scripts, however, like ~/.bashrc, ~/.bash_profile, and\n~/.zshrc. If you set your Appium environment variables in some other way, you\nwill need to create one of these default init scripts and set your environment\nvariables there as well, so that Appium Desktop will successfully pick them up.
\n
Warnings about being on a read-only file system
\n
This probably means you tried to launch Appium Desktop from the downloaded disk\nimage (.dmg file). This is not a supported mode of running Appium Desktop. To\ncorrectly install Appium Desktop, copy the application from the disk image to\nyour local filesystem, to somewhere like /Applications. Then, run the app\nfrom that new location.
\n
Cannot open Appium Desktop
\n
It is because of macOS security system.\nPlease read issue#1217 for more details.
\n
Developer Instructions
\n
Want to hack on Appium Desktop? Awesome! Head on over to our Contributing\nDoc for information on how to get a dev environment set up\nand submit changes back to the project.
\n
",
"readmeOriginal": "
Appium Desktop
\n
\n\n
\n
Appium Desktop is a suite of apps for Mac, Windows, and Linux which gives you the power of the Appium automation server in a beautiful and flexible UI. It is a combination of a few Appium-related tools:
\n
\n
A graphical interface for the Appium Server. You can set options, start/stop the server, see logs, etc... You also don't need to use Node/NPM to install Appium, as the Node runtime comes bundled with Appium Desktop.
\n
An Inspector that you can use to look at your app's elements (Safari/Chrome browser, native or hybrid app), get basic information about them, and perform basic interactions with them. This is useful as a way to learn about Appium or as a way to learn about your app so you can write tests for it.
\n
\n
Download Appium Desktop
\n
You can always pick up the latest release of the Server GUI or the Inspector at our\nRelease page on\nGitHub.
\n
If you're on Windows or macOS, Appium Desktop will automatically provide you\nwith updated versions of the app when they are released. If you encounter\na problem updating, simply delete or uninstall the app and re-download the\nlatest from the link above.
\n
Note that Appium Desktop is not the same thing as Appium. Appium Desktop is\na graphical frontend to Appium with additional tools. Appium Desktop is\nreleased on its own cadence and has its own versioning system. If you are\nreporting an issue with Appium Desktop, always be sure to include both the\nversion of Appium Desktop and the version of the Appium Server which is in use\n(see below).
\n
If you're on macOS, you will need to install Appium Desktop apps by copying the app\nfrom the downloaded DMG file to your own file system (the best place is the\n\"Applications\" folder). Running Appium from in side the attached DMG itself is\nnot supported, and will not work.
\n
Known Issues
\n
\n
Some Windows 10 Users experience a PathTooLongException when installing the EXE. The workaround for this is to update the setting on Windows to enable long paths
\n
\n
Usage Instructions
\n
These instructions assume you are already familiar with Appium and Appium-related concepts. If you\nare new to Appium, please visit appium.io and read our introductory material.\nThey also assume that you have downloaded both the Server GUI and the Inspector apps.
\n
This app provides a convenient way to download and run the Appium automation\nserver, as well as a tool for inspecting elements in Chrome/Safari browser and your Android or iOS application. Its\nvarious capabilities are described in the following sections.
\n
The Appium Desktop Server GUI
\n
Starting a simple server
\n
\n
When you open Appium Desktop, you are greeted with the server start window. The\nbasic option is to start an Appium server with all its defaults and the ability\nto modify the host and port. The start button will also let you know which\nversion of the Appium server you are running, which can be useful when\nreporting issues to the Appium team.
\n
Starting a server with advanced options
\n
\n
By clicking on the 'Advanced' tab, you have the ability to set all the server\nflags that are available in Appium. This is for advanced users and should only\nbe modified after consulting the Appium documentation.
\n
Server presets
\n
\n
If you use the advanced server options, you have the ability to save\na configuration for later use. Simply save the preset on the 'Advanced' tab,\nand you will subsequently be able to recall and start the server with that\nconfiguration from the 'Preset' tab.
\n
The server console output window
\n
Once you start the server, it will launch on the host and port you specified,\nand open a new window displaying the server log output.
\n
\n
This is fairly straightforward and no real interaction is possible, beyond\nusing the button to stop the server. You can also copy-and-paste the logs from\nthis window which is useful in reporting Appium issues.
\n
The Appium Desktop Inspector
\n
The Inspector opens up with a New Session windows. This New Session window allows you to construct\na set of Appium desired capabilities used to launch an Appium session. You can launch a session\nagainst the currently-running Appium CLI or Appium Server GUI server, or you can launch a session\nagainst a variety of other endpoints. Simply include the connection details for any server that you\nwish to connect to.
\n
IMPORTANT: to ensure that the Inspector can talk to your Appium server, any Appium server you\nconnect to from the Inspector may need to be started with the --allow-cors flag, so that\nChrome/Electron's content security policies don't prevent the Inspector from making requests to the\nserver (which may be running on a different host and port). If you get immediate errors when\ntalking to your Appium server, ensure that this setting is configured on your server.
\n
\n
You can add available cloud providers as new tabs.\nWhen you select Select Cloud Providers tab on the view,\nSelect Cloud Providers dialog appears.\nYou can select some of them and click Done, they will appear on\nthe New session window as tabs.
\n
\n
Appium Endpoints
\n
These are the options for launching a session against a non-local Appium server:
\n
\n\n
\n
Endpoint
\n
Description
\n
\n\n\n
\n
Automatic server
\n
Automatically utilizes the currently-running Appium server
\n
\n
\n
Custom Server
\n
Launch a session on an Appium server running on another machine over the network
It should be straightforward to get set up with any of these options. Simply\nenter your details in the input fields provided.
\n
Desired Capabilities
\n
Desired capabilities are how you configure your Appium session. They tell the\nAppium server what kind of platform and app you want to automate. If you are\nunfamiliar with the concept of desired capabilities, or which desired\ncapabilities are required to launch Appium sessions of various types, you\nshould consult the Appium documentation. Additionally, if you're using one of\nthe cloud providers, consult their documentation for possible vendor-specific\ndetails.
\n
Appium Desktop does not restrict your creation of desired capabilities in any\nway, nor will it validate them for you. It simply provides a nice UI for\nentering them in, and saving them for later use. Under the 'Desired\nCapabilities' tab, you can use the form fields and '+' button to enter as many\ndesired capabilities as you need. You will also see a representation of the\nresulting JSON, which is what is actually sent to the Appium server. This can\nbe useful for verifying your capabilities, or for copy-and-pasting when\nreporting issues.
\n
Once you have set your desired capabilities, you might wish to save them so you\ncan run the same type of session later. Simply click the 'Save As...' button to\ngive your capability set a name. You can then access it under the 'Saved\nCapability Sets' tab, for later editing or session launching.
\n
Once your server type and capabilities are set, click 'Start Session' to launch\nthe Appium Desktop Inspector.
\n
Attach to an Existing Session
\n
If you click on the \"Attach to Session...\" tab, you can select an existing\nsession from a list of currently running sessions on your selected server, or you\ncan input a session ID of a currently-running session. That session should be\nrunning on the server details you specified in the server type section above.\nAttaching to an existing session is possible because the Inspector is just an\nAppium client. This could be useful if you want to debug the middle of a running\ntest. When you quit the Inspector window of an existing session, Appium Desktop\nwill not quit the session as it does normally.
\n
The Inspector
\n
The Inspector is a visual representation of the state of your application along\nwith the ability to perform certain interactions in your application through\nAppium.
\n
\n
Appium sessions can take some time to load, especially on cloud services, so\nplease be patient. When the session loads, a screenshot of your app will appear\non the left. You can mouse over various UI elements in your application, and\nsee them highlighted.
\n
In the middle of the Inspector window is your app's hierarchy, represented as\nXML. You can navigate this tree by clicking through it, or by clicking on\nelements in the screenshot view. They will then be highlighted.
\n
When an element is highlighted, its information will appear in the detail view\non the right side of the Inspector. This detail view consists of potential\nactions to take against the element, and a table of the element's properties.\nThese properties are valuable in determining how the element might accessed\nusing a particular Appium locator strategy. With an element selected, you can\nalso 'Tap' the element, or 'Send Keys' to the element (if it is a text field).
\n
When you take such an action with an element, the Inspector will send the\ncommand to Appium, which will execute it. If the action is successful, a new\nscreenshot will be generated and you should see the updated state and XML of\nyour app. If it's not successful, you'll have an opportunity to see the error\nmessage.
\n
The top of the Inspector window contains a small toolbar with icons\nrepresenting the ability to take certain actions in the Inspector:
\n
\n
Back (call driver.back)
\n
Refresh (refresh the source and screenshot)
\n
Start Recording (open the recorder, see the next section for more information on the recorder)
\n
Quit the session (call driver.quit and close the Inspector)
\n
\n
The inspector for Hybrid or Web apps
\n
Appium Desktop can also inspect the Webview of your Hybrid app or inspect elements in the Chrome of Safari browser.\nIt will automatically determine for Android or iOS if a webview is detected and will notify you about this in the right part of the screen.
\n
\n
A select box of all found contexts will be shown and after selecting a context the source will be updated and show the source.\nThe below screenshot shows the HTML source of the Appium Desktop documentation website
\n
.
\n
As of Appium Desktop version 1.18.0 it will automatically enable showing the HTML-source if a Chrome or Safari session is started.
\n
More selector options
\n
XML is not a native programming language for iOS as it is with Android. Appium will automatically translate the iOS-UIHierarchy into XML, but this is a time-consuming process.\nThe XML will be used to provide a XPATH that can be used to find elements. When you use that XPATH selector with iOS during automation, Appium always needs to do the translation which will slow down the test execution (for more info see Appium Pro newsletter 8).
\n
As of Appium Desktop version 1.18.0 it will, if possible, also provide the:
selector options together with a Get Timing button.
\n
.
\n
When you select an iOS element in Appium Desktop and press the Get Timing-button it will provide you the time in milliseconds\nit will take per selector to find the element and will automatically sort them from fast to the slowest.\nIn most cases you will see that XPATH is the slowest locator strategy in comparison to the other options.
\n
.
\n
The Recorder
\n
Appium Desktop comes with a very basic action recorder, that watches for\nactions taken using Appium Desktop and displays language-and-framework-specific\ncode that represents those actions. The code can then be copied-and-pasted into\nthe appropriate Appium client code and used for tests.
\n
NB: the goal of the Recorder is not to produce production-ready test code.\nIt is designed as a tool to help explore the Appium API, and demonstrate how\ncertain automation behaviors correspond to method calls in a particular\nlanguage and Appium library. In sum, it is a learning tool, not a robust code\ngeneration feature, and should be used as such.
\n
When you start recording, the Inspector will show an additional window:
\n
\n
At first, the Recorder will show no code. You will first have to take some\naction, like finding an element in the hierarchy and tapping on it, or sending\nkeystrokes to it. When you do this, code will appear in the recorder window,\ncorresponding to the particular language and framework you have chosen (which\ncan be adjusted in the drop-down menu at the top right of the Recorder):
\n
\n
This code can be copied to your clipboard using the appropriate button at the\ntop right of the Recorder pane. Note that by default what is shown are simply\nlines of code corresponding to the specific actions you have taken while\nrecording---in general you cannot paste these lines into an empty text file and\nrun the code. To run Appium test scripts in code requires that various\ndependencies (like the Appium client libraries) be installed, and that script\nboilerplate (like instantiating a driver and initializing a session) be\npresent. To show this additional code, you can click the \"Show Boilerplate\"\nbutton. With boilerplate code shown, it is possible to copy and paste the code\ninto a new file and run it.
\n
\n
The power of the Recorder will continue to grow as we add more languages,\nframeworks, and actions to Appium Desktop.
\n
Conclusion
\n
This is everything you need to know to use Appium Desktop successfully!\nRemember, Appium Desktop is not a replacement for understanding Appium\nitself---it is simply a convenient tool for working with Appium on your\ndesktop, and an Inspector for exploring your app. Have fun!
\n
Reporting Issues and Requesting Features
\n
Appium Desktop is open source, and we use GitHub for issue tracking. Please\nsimply report issues at our issue\ntracker. We will endeavor to\ndetermine whether the issue you are reporting is related to Appium Desktop or\nAppium Server. If it's not related to Appium Desktop specifically, we will\nclose the issue and ask you to open a general Appium issue at Appium's main\nissue tracker. Please, save\nyourselves and us valuable time by getting clear on whether the issue you're\nexperiencing is related to Appium Desktop specifically or instead is a general\nAppium issue. You can do this by seeing whether the issue reproduces with the\nAppium command line server as well. If it does, direct your report to Appium's\nissue tracker.
\n
Have a feature request? Follow the same process and submit an issue to the\nappropriate tracker! (Either here in this repo if the request is specifically\nfor Appium Desktop, or Appium's main tracker if the request is for Appium more\ngenerally.)
\n
Advanced Topics and Troubleshooting
\n
Connect to local Appium server
\n
Appium Desktop has own Appium CLI. You can launch it via Starting a simple server.\nBut sometimes you need another Appium version which is bundled in the desktop.\nFor example, when you want to use Appium beta.
Connect to the running Appium server as Custom Server as below (by default)\n
\n
Remote Host: localhost
\n
Remote Port: 4723
\n
Remote Path: /wd/hub
\n
\n
\n
Start session
\n\n
Appium can't detect environment variables on Mac
\n
Appium uses environment variables like ANDROID_HOME as well as relying on\nvarious binaries in your PATH and so on. When running from the command line\nin an environment where you have set these variables appropriately, Appium has\nno problem in picking them up. However, Appium Desktop does not run in a shell\nor a command-line environment, and so by default it does not have access to\nenvironment variables you have set in your shell startup script or profile. To\nwork around this, we use the\nshell-env package to pick up\nenvironment variables defined in your shell. This package only looks in certain\ncommon init scripts, however, like ~/.bashrc, ~/.bash_profile, and\n~/.zshrc. If you set your Appium environment variables in some other way, you\nwill need to create one of these default init scripts and set your environment\nvariables there as well, so that Appium Desktop will successfully pick them up.
\n
Warnings about being on a read-only file system
\n
This probably means you tried to launch Appium Desktop from the downloaded disk\nimage (.dmg file). This is not a supported mode of running Appium Desktop. To\ncorrectly install Appium Desktop, copy the application from the disk image to\nyour local filesystem, to somewhere like /Applications. Then, run the app\nfrom that new location.
\n
Cannot open Appium Desktop
\n
It is because of macOS security system.\nPlease read issue#1217 for more details.
\n
Developer Instructions
\n
Want to hack on Appium Desktop? Awesome! Head on over to our Contributing\nDoc for information on how to get a dev environment set up\nand submit changes back to the project.
Spotify support is being added in version 0.0.11! If \"spotifyMiniPlayer\" is set to true in your config, an authorization window will pop up. And it should be as simple as any other oAuth situation.
\n
REQUIRES SPOTIFY PREMIUM ACCOUNT
\n
New Commands
\n
\n
'play [song name]' - play any song from spotify
\n
'skip', 'next song' - skip song
\n
'previous' - previous song
\n
'lyrics' - display song lyrics from node-lyrics-api
\n
\n
Spotify Mini Player
\n
If enabled, instead of the app closing when you click away, it will turn into a miniplayer.
Arizona is meant to be a customizable open replacement for desktop assistants like Cortana and Siri. You can use any mp4 as your assistant's avatar. It's meant to be completely customizable to your liking, and because it's all written in HTML and CSS, that's completely easy.
\n
New Features
\n
Themes
\n
Copy the folder of another theme in your 'themes' directory and rename it to whatever you want to call your theme. Then, in config.json, set your theme to the name of the folder you created. You can add whatever css you want to the custom css file.
\n
Background Video
\n
Place a mp4 in the directory of your theme with the name 'bg.mp4'. Then just makes sure \"backgroundVideo\" is set to true in config.json
\n
Python Scripts
\n
Run Python scripts by placing them in your 'scripts' folder and just type the name of the python file to run. (Must have python installed)
\n
Getting Started
\n
Dependencies
\n
Installing
\n
\n
\n
Node js
\n
\n
\n
Clone this repository or install with
\n
\n
\n
npm install arizona\n
\n
\n
Install Dependencies by running the following command in the arizona directory
\n
\n
npm install\n
\n
Executing program
\n
\n
Run this command in the arizona directory
\n
\n
npm start\n
\n
Customizing
\n
See Config.json to change settings like your name, your assistant's name, and more.\nTo Add or remove inputs for conversation, edit the 'inputs.txt' and 'responses.txt'\nEvery line in 'inputs.txt' corresponds to the same line in 'responses.txt'. Separate alternate versions of inputs or responses with a '/'
\n
Commands
\n
All Platforms
\n
\n
'google [query]' - open google in your browser with your query, faster than cortana (example: \"google the shaggy dog\")
\n
Any message that doesn't look like an input from the \"inputs\" file will be googled. So you can type \"gene wilder\" and it will google Gene Wilder
\n
'weather' - display the weather
\n
\n
TO-DO
\n
\n
Voice Control and Response (considering using AWS)
Spotify support is being added in version 0.0.11! If \"spotifyMiniPlayer\" is set to true in your config, an authorization window will pop up. And it should be as simple as any other oAuth situation.
\n
REQUIRES SPOTIFY PREMIUM ACCOUNT
\n
New Commands
\n
\n
'play [song name]' - play any song from spotify
\n
'skip', 'next song' - skip song
\n
'previous' - previous song
\n
'lyrics' - display song lyrics from node-lyrics-api
\n
\n
Spotify Mini Player
\n
If enabled, instead of the app closing when you click away, it will turn into a miniplayer.
Arizona is meant to be a customizable open replacement for desktop assistants like Cortana and Siri. You can use any mp4 as your assistant's avatar. It's meant to be completely customizable to your liking, and because it's all written in HTML and CSS, that's completely easy.
\n
New Features
\n
Themes
\n
Copy the folder of another theme in your 'themes' directory and rename it to whatever you want to call your theme. Then, in config.json, set your theme to the name of the folder you created. You can add whatever css you want to the custom css file.
\n
Background Video
\n
Place a mp4 in the directory of your theme with the name 'bg.mp4'. Then just makes sure \"backgroundVideo\" is set to true in config.json
\n
Python Scripts
\n
Run Python scripts by placing them in your 'scripts' folder and just type the name of the python file to run. (Must have python installed)
\n
Getting Started
\n
Dependencies
\n
Installing
\n
\n
\n
Node js
\n
\n
\n
Clone this repository or install with
\n
\n
\n
npm install arizona\n
\n
\n
Install Dependencies by running the following command in the arizona directory
\n
\n
npm install\n
\n
Executing program
\n
\n
Run this command in the arizona directory
\n
\n
npm start\n
\n
Customizing
\n
See Config.json to change settings like your name, your assistant's name, and more.\nTo Add or remove inputs for conversation, edit the 'inputs.txt' and 'responses.txt'\nEvery line in 'inputs.txt' corresponds to the same line in 'responses.txt'. Separate alternate versions of inputs or responses with a '/'
\n
Commands
\n
All Platforms
\n
\n
'google [query]' - open google in your browser with your query, faster than cortana (example: \"google the shaggy dog\")
\n
Any message that doesn't look like an input from the \"inputs\" file will be googled. So you can type \"gene wilder\" and it will google Gene Wilder
\n
'weather' - display the weather
\n
\n
TO-DO
\n
\n
Voice Control and Response (considering using AWS)
# install dependencies\nnpm install\n\n# serve with hot reload at localhost:9080\nnpm run dev\n\n# build electron application for production\nnpm run build\n\n
\n\n
This project was generated with electron-vue@88c386d using vue-cli. Documentation about the original structure can be found here.
\n
",
"readmeOriginal": "
Asar UI
\n
\n\n\n
\n
\n
UI for Asar, Extract All or drag extract file/directory
# install dependencies\nnpm install\n\n# serve with hot reload at localhost:9080\nnpm run dev\n\n# build electron application for production\nnpm run build\n\n
\n\n
This project was generated with electron-vue@88c386d using vue-cli. Documentation about the original structure can be found here.
Atom is a hackable text editor for the 21st century, built on Electron, and based on everything we love about our favorite editors. We designed it to be deeply customizable, but still approachable using the default configuration.
Follow @AtomEditor on Twitter for important\nannouncements.
\n
This project adheres to the Contributor Covenant code of conduct.\nBy participating, you are expected to uphold this code. Please report unacceptable behavior to atom@github.com.
\n
Documentation
\n
If you want to read about using Atom or developing packages in Atom, the Atom Flight Manual is free and available online. You can find the source to the manual in atom/flight-manual.atom.io.
\n
The API reference for developing packages is also documented on Atom.io.
Atom will automatically update when a new release is available.
\n
Windows
\n
Download the latest Atom installer. AtomSetup.exe is 32-bit. For 64-bit systems, download AtomSetup-x64.exe.
\n
Atom will automatically update when a new release is available.
\n
You can also download atom-windows.zip (32-bit) or atom-x64-windows.zip (64-bit) from the releases page.\nThe .zip version will not automatically update.
\n
Using Chocolatey? Run cinst Atom to install the latest version of Atom.
\n
Linux
\n
Atom is only available for 64-bit Linux systems.
\n
Configure your distribution's package manager to install and update Atom by following the Linux installation instructions in the Flight Manual. You will also find instructions on how to install Atom's official Linux packages without using a package repository, though you will not get automatic updates after installing Atom this way.
\n
Archive extraction
\n
An archive is available for people who don't want to install atom as root.
\n
This version enables you to install multiple Atom versions in parallel. It has been built on Ubuntu 64-bit,\nbut should be compatible with other Linux distributions.
When using the Atom or other GitHub logos, be sure to follow the GitHub logo guidelines.
\n
",
- "readmeOriginal": "
Atom
\n
\n
\n
Atom is a hackable text editor for the 21st century, built on Electron, and based on everything we love about our favorite editors. We designed it to be deeply customizable, but still approachable using the default configuration.
Follow @AtomEditor on Twitter for important\nannouncements.
\n
This project adheres to the Contributor Covenant code of conduct.\nBy participating, you are expected to uphold this code. Please report unacceptable behavior to atom@github.com.
\n
Documentation
\n
If you want to read about using Atom or developing packages in Atom, the Atom Flight Manual is free and available online. You can find the source to the manual in atom/flight-manual.atom.io.
\n
The API reference for developing packages is also documented on Atom.io.
Atom will automatically update when a new release is available.
\n
Windows
\n
Download the latest Atom installer. AtomSetup.exe is 32-bit. For 64-bit systems, download AtomSetup-x64.exe.
\n
Atom will automatically update when a new release is available.
\n
You can also download atom-windows.zip (32-bit) or atom-x64-windows.zip (64-bit) from the releases page.\nThe .zip version will not automatically update.
\n
Using Chocolatey? Run cinst Atom to install the latest version of Atom.
\n
Linux
\n
Atom is only available for 64-bit Linux systems.
\n
Configure your distribution's package manager to install and update Atom by following the Linux installation instructions in the Flight Manual. You will also find instructions on how to install Atom's official Linux packages without using a package repository, though you will not get automatic updates after installing Atom this way.
\n
Archive extraction
\n
An archive is available for people who don't want to install atom as root.
\n
This version enables you to install multiple Atom versions in parallel. It has been built on Ubuntu 64-bit,\nbut should be compatible with other Linux distributions.
This software calculates value-added learning scores accounting for guessing. The software reads in nearly any exam format and exam questions can appear in different locations in the pretest and posttest.
This software calculates value-added learning scores accounting for guessing. The software reads in nearly any exam format and exam questions can appear in different locations in the pretest and posttest.
Spotify support is being added in version 0.0.11! If \"spotifyMiniPlayer\" is set to true in your config, an authorization window will pop up. And it should be as simple as any other oAuth situation.
\n
REQUIRES SPOTIFY PREMIUM ACCOUNT
\n
New Commands
\n
\n
'play [song name]' - play any song from spotify
\n
'skip', 'next song' - skip song
\n
'previous' - previous song
\n
'lyrics' - display song lyrics from node-lyrics-api
\n
\n
Spotify Mini Player
\n
If enabled, instead of the app closing when you click away, it will turn into a miniplayer.
Arizona is meant to be a customizable open replacement for desktop assistants like Cortana and Siri. You can use any mp4 as your assistant's avatar. It's meant to be completely customizable to your liking, and because it's all written in HTML and CSS, that's completely easy.
\n
New Features
\n
Themes
\n
Copy the folder of another theme in your 'themes' directory and rename it to whatever you want to call your theme. Then, in config.json, set your theme to the name of the folder you created. You can add whatever css you want to the custom css file.
\n
Background Video
\n
Place a mp4 in the directory of your theme with the name 'bg.mp4'. Then just makes sure \"backgroundVideo\" is set to true in config.json
\n
Python Scripts
\n
Run Python scripts by placing them in your 'scripts' folder and just type the name of the python file to run. (Must have python installed)
\n
Getting Started
\n
Dependencies
\n
Installing
\n
\n
\n
Node js
\n
\n
\n
Clone this repository or install with
\n
\n
\n
npm install arizona\n
\n
\n
Install Dependencies by running the following command in the arizona directory
\n
\n
npm install\n
\n
Executing program
\n
\n
Run this command in the arizona directory
\n
\n
npm start\n
\n
Customizing
\n
See Config.json to change settings like your name, your assistant's name, and more.\nTo Add or remove inputs for conversation, edit the 'inputs.txt' and 'responses.txt'\nEvery line in 'inputs.txt' corresponds to the same line in 'responses.txt'. Separate alternate versions of inputs or responses with a '/'
\n
Commands
\n
All Platforms
\n
\n
'google [query]' - open google in your browser with your query, faster than cortana (example: \"google the shaggy dog\")
\n
Any message that doesn't look like an input from the \"inputs\" file will be googled. So you can type \"gene wilder\" and it will google Gene Wilder
\n
'weather' - display the weather
\n
\n
TO-DO
\n
\n
Voice Control and Response (considering using AWS)
Spotify support is being added in version 0.0.11! If \"spotifyMiniPlayer\" is set to true in your config, an authorization window will pop up. And it should be as simple as any other oAuth situation.
\n
REQUIRES SPOTIFY PREMIUM ACCOUNT
\n
New Commands
\n
\n
'play [song name]' - play any song from spotify
\n
'skip', 'next song' - skip song
\n
'previous' - previous song
\n
'lyrics' - display song lyrics from node-lyrics-api
\n
\n
Spotify Mini Player
\n
If enabled, instead of the app closing when you click away, it will turn into a miniplayer.
Arizona is meant to be a customizable open replacement for desktop assistants like Cortana and Siri. You can use any mp4 as your assistant's avatar. It's meant to be completely customizable to your liking, and because it's all written in HTML and CSS, that's completely easy.
\n
New Features
\n
Themes
\n
Copy the folder of another theme in your 'themes' directory and rename it to whatever you want to call your theme. Then, in config.json, set your theme to the name of the folder you created. You can add whatever css you want to the custom css file.
\n
Background Video
\n
Place a mp4 in the directory of your theme with the name 'bg.mp4'. Then just makes sure \"backgroundVideo\" is set to true in config.json
\n
Python Scripts
\n
Run Python scripts by placing them in your 'scripts' folder and just type the name of the python file to run. (Must have python installed)
\n
Getting Started
\n
Dependencies
\n
Installing
\n
\n
\n
Node js
\n
\n
\n
Clone this repository or install with
\n
\n
\n
npm install arizona\n
\n
\n
Install Dependencies by running the following command in the arizona directory
\n
\n
npm install\n
\n
Executing program
\n
\n
Run this command in the arizona directory
\n
\n
npm start\n
\n
Customizing
\n
See Config.json to change settings like your name, your assistant's name, and more.\nTo Add or remove inputs for conversation, edit the 'inputs.txt' and 'responses.txt'\nEvery line in 'inputs.txt' corresponds to the same line in 'responses.txt'. Separate alternate versions of inputs or responses with a '/'
\n
Commands
\n
All Platforms
\n
\n
'google [query]' - open google in your browser with your query, faster than cortana (example: \"google the shaggy dog\")
\n
Any message that doesn't look like an input from the \"inputs\" file will be googled. So you can type \"gene wilder\" and it will google Gene Wilder
\n
'weather' - display the weather
\n
\n
TO-DO
\n
\n
Voice Control and Response (considering using AWS)
Standard updates coming on Tuesdays if there is something to update and hotfix updates can come on Tuesdays, Thursdays or Saturdays if there is a problem that can not wait until the next Tuesday.
Standard updates coming on Tuesdays if there is something to update and hotfix updates can come on Tuesdays, Thursdays or Saturdays if there is a problem that can not wait until the next Tuesday.
A beautiful SoundCloud app for your desktop. Using the power of electron we are able to integrate this webapp with native features like touchbar and media key support.
Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.
\n
Support 💪
\n
Auryo is a open source project. It can grow thanks to the sponsors and support by the amazing backers. If you like to donate, please visit 👉my patreon page.
\n
Author
\n
This application has been built by Jonas Snellinckx. It started out as a learning journey back in college-university Oct 2016, to start learning React, Redux and Electron. Since the first release in August 2017, the journey was incredibly educational. Over the next few months, Auryo has matured from a learning side-project into an escalated one. In a good sense.
\n
As of release 2.0.0, Auryo also has been open-sourced. See the list of contributors who participated in this project.
A beautiful SoundCloud app for your desktop. Using the power of electron we are able to integrate this webapp with native features like touchbar and media key support.
Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.
\n
Support 💪
\n
Auryo is a open source project. It can grow thanks to the sponsors and support by the amazing backers. If you like to donate, please visit 👉my patreon page.
\n
Author
\n
This application has been built by Jonas Snellinckx. It started out as a learning journey back in college-university Oct 2016, to start learning React, Redux and Electron. Since the first release in August 2017, the journey was incredibly educational. Over the next few months, Auryo has matured from a learning side-project into an escalated one. In a good sense.
\n
As of release 2.0.0, Auryo also has been open-sourced. See the list of contributors who participated in this project.
Standard updates coming on Tuesdays if there is something to update and hotfix updates can come on Tuesdays, Thursdays or Saturdays if there is a problem that can not wait until the next Tuesday.
Standard updates coming on Tuesdays if there is something to update and hotfix updates can come on Tuesdays, Thursdays or Saturdays if there is a problem that can not wait until the next Tuesday.
This software calculates value-added learning scores accounting for guessing. The software reads in nearly any exam format and exam questions can appear in different locations in the pretest and posttest.
This software calculates value-added learning scores accounting for guessing. The software reads in nearly any exam format and exam questions can appear in different locations in the pretest and posttest.
Atom is a hackable text editor for the 21st century, built on Electron, and based on everything we love about our favorite editors. We designed it to be deeply customizable, but still approachable using the default configuration.
Follow @AtomEditor on Twitter for important\nannouncements.
\n
This project adheres to the Contributor Covenant code of conduct.\nBy participating, you are expected to uphold this code. Please report unacceptable behavior to atom@github.com.
\n
Documentation
\n
If you want to read about using Atom or developing packages in Atom, the Atom Flight Manual is free and available online. You can find the source to the manual in atom/flight-manual.atom.io.
\n
The API reference for developing packages is also documented on Atom.io.
Atom will automatically update when a new release is available.
\n
Windows
\n
Download the latest Atom installer. AtomSetup.exe is 32-bit. For 64-bit systems, download AtomSetup-x64.exe.
\n
Atom will automatically update when a new release is available.
\n
You can also download atom-windows.zip (32-bit) or atom-x64-windows.zip (64-bit) from the releases page.\nThe .zip version will not automatically update.
\n
Using Chocolatey? Run cinst Atom to install the latest version of Atom.
\n
Linux
\n
Atom is only available for 64-bit Linux systems.
\n
Configure your distribution's package manager to install and update Atom by following the Linux installation instructions in the Flight Manual. You will also find instructions on how to install Atom's official Linux packages without using a package repository, though you will not get automatic updates after installing Atom this way.
\n
Archive extraction
\n
An archive is available for people who don't want to install atom as root.
\n
This version enables you to install multiple Atom versions in parallel. It has been built on Ubuntu 64-bit,\nbut should be compatible with other Linux distributions.
When using the Atom or other GitHub logos, be sure to follow the GitHub logo guidelines.
\n
",
+ "readmeOriginal": "
Atom
\n
\n
\n
Atom is a hackable text editor for the 21st century, built on Electron, and based on everything we love about our favorite editors. We designed it to be deeply customizable, but still approachable using the default configuration.
Follow @AtomEditor on Twitter for important\nannouncements.
\n
This project adheres to the Contributor Covenant code of conduct.\nBy participating, you are expected to uphold this code. Please report unacceptable behavior to atom@github.com.
\n
Documentation
\n
If you want to read about using Atom or developing packages in Atom, the Atom Flight Manual is free and available online. You can find the source to the manual in atom/flight-manual.atom.io.
\n
The API reference for developing packages is also documented on Atom.io.
Atom will automatically update when a new release is available.
\n
Windows
\n
Download the latest Atom installer. AtomSetup.exe is 32-bit. For 64-bit systems, download AtomSetup-x64.exe.
\n
Atom will automatically update when a new release is available.
\n
You can also download atom-windows.zip (32-bit) or atom-x64-windows.zip (64-bit) from the releases page.\nThe .zip version will not automatically update.
\n
Using Chocolatey? Run cinst Atom to install the latest version of Atom.
\n
Linux
\n
Atom is only available for 64-bit Linux systems.
\n
Configure your distribution's package manager to install and update Atom by following the Linux installation instructions in the Flight Manual. You will also find instructions on how to install Atom's official Linux packages without using a package repository, though you will not get automatic updates after installing Atom this way.
\n
Archive extraction
\n
An archive is available for people who don't want to install atom as root.
\n
This version enables you to install multiple Atom versions in parallel. It has been built on Ubuntu 64-bit,\nbut should be compatible with other Linux distributions.
This app allows you to use AWS (Amazon Web Services) S3 as backup system for desktop environments.\nLike Dropbox or Google Drive app you can backup your important data on AWS S3.\nThis desktop app allows you to configure 3 different types of backup job (One time, recurring, live) to backup your data in an S3 bucket.
\n
\n
One time: the backup job will be executed only one time as programmed.
\n
Recurring: the backup job will be executed periodically as programmed.
\n
Live: any time a file associated with the backup job changes it will be transferred to the S3 bucket.
\n
\n
This is a cross platform app, built with Electron, so you can use it on Windows, Mac and Linux.
\n
Requirement
\n
This app use the AWS CLI \"sync\" command, this mean that you must install the AWS CLI in order to use this app.
After installation go to settings page and configure the AWS credentials.
\n
In order to use the app you must set an \"AWS access key ID\", an \"AWS secret access key\" and an \"AWS Region\" that you can create through the IAM service in the AWS console.\nThe IAM user needs a programmatic access account with a correct read/write S3 policy attached (e.g AmazonS3FullAccess) and CloudWatch Metrics (e.g CloudWatchReadOnlyAccess).\nYou can use any IAM S3 policy that grant access to the buckets that you want to use with the app.\nHere an example policy: IAM S3 example policy
This start a local development environment with hot reload
\n
You can activate/deactivate \"Developer Tools\" by commenting or not win.webContents.openDevTools(); in main.ts.
\n
To build for production
\n
\n
in a windows terminal window -> npm electron:windows
\n
in a mac terminal window -> npm electron:mac
\n
in a linux terminal window -> npm electron:linux
\n
\n
You will find the app build files in the \"app-builds\" directory.
\n
Don't forget to deactivate the \"Developer Tools\" by commenting win.webContents.openDevTools(); in main.ts.
\n
Included Commands
\n
\n\n
\n
Command
\n
Description
\n
\n\n\n
\n
npm run ng:serve:web
\n
Execute the app in the browser
\n
\n
\n
npm run build
\n
Build the app. Your built files are in the /dist folder.
\n
\n
\n
npm run build:prod
\n
Build the app with Angular aot. Your built files are in the /dist folder.
\n
\n
\n
npm run electron:local
\n
Builds your application and start electron
\n
\n
\n
npm run electron:linux
\n
Builds your application and creates an app consumable on linux system
\n
\n
\n
npm run electron:windows
\n
On a Windows OS, builds your application and creates an app consumable in windows 32/64 bit systems
\n
\n
\n
npm run electron:mac
\n
On a MAC OS, builds your application and generates a .app file of your application that can be run on Mac
\n
\n\n
\n
",
"readmeOriginal": "
\n \n Backup on AWS S3 ? Never been so easy!\n
\n
\n \n \n \n
\n
Introduction
\n
This app allows you to use AWS (Amazon Web Services) S3 as backup system for desktop environments.\nLike Dropbox or Google Drive app you can backup your important data on AWS S3.\nThis desktop app allows you to configure 3 different types of backup job (One time, recurring, live) to backup your data in an S3 bucket.
\n
\n
One time: the backup job will be executed only one time as programmed.
\n
Recurring: the backup job will be executed periodically as programmed.
\n
Live: any time a file associated with the backup job changes it will be transferred to the S3 bucket.
\n
\n
This is a cross platform app, built with Electron, so you can use it on Windows, Mac and Linux.
\n
Requirement
\n
This app use the AWS CLI \"sync\" command, this mean that you must install the AWS CLI in order to use this app.
After installation go to settings page and configure the AWS credentials.
\n
In order to use the app you must set an \"AWS access key ID\", an \"AWS secret access key\" and an \"AWS Region\" that you can create through the IAM service in the AWS console.\nThe IAM user needs a programmatic access account with a correct read/write S3 policy attached (e.g AmazonS3FullAccess) and CloudWatch Metrics (e.g CloudWatchReadOnlyAccess).\nYou can use any IAM S3 policy that grant access to the buckets that you want to use with the app.\nHere an example policy: IAM S3 example policy
autoEdit 2 is a fast text based video editing, desktop app for Mac, Linux and Windows, built with node and electron, and Backbone front end. For making video production faster, easier and more accessible.
\n
Ready to use release
\n
See releases section to download latest packaged version ready to use. And view user manual for overview of the app.
Compiles the js client side files with browserify and starts electron
\n
Note: You'd also need to get Speech to text keys or have the Gentle Open source app running locally check out the user manual for more details, unless you are choosing pocketsphinx as speech to text option.
autoEdit 2 is a fast text based video editing, desktop app for Mac, Linux and Windows, built with node and electron, and Backbone front end. For making video production faster, easier and more accessible.
\n
Ready to use release
\n
See releases section to download latest packaged version ready to use. And view user manual for overview of the app.
Compiles the js client side files with browserify and starts electron
\n
Note: You'd also need to get Speech to text keys or have the Gentle Open source app running locally check out the user manual for more details, unless you are choosing pocketsphinx as speech to text option.
###>Batcave client built with Electron and Angular2.
\n
Experience smooth texting in the dark environment with a classy batcave desktop app electron based on a cool dark theme. Just simple with coloured chat bubbles. Feel free to tell me any suggestions, or let me know about any issues. Enjoy!
Download Batcave desktop application for Windows, MacOS and Linux.
\n
License
\n
MIT
\n
",
"readmeOriginal": "
\n
\n
###>Batcave client built with Electron and Angular2.
\n
Experience smooth texting in the dark environment with a classy batcave desktop app electron based on a cool dark theme. Just simple with coloured chat bubbles. Feel free to tell me any suggestions, or let me know about any issues. Enjoy!
Simple multiplatform desktop app for storing TODOs, ideas or backlog items.\nYou can organize them with boards as a plaintext or markdown. No dependencies, no internet connection required,\nno external accounts. Sleek flow.
New 2.x version introduces a lot of new features including new UI, configurable keybindings, search item feature, emoji, and a lot more! Check it out !
When new version is available just download it, unzip and enjoy. No additional action is required. All your boards and items will be available.
\n
Change log
\n
1.8.0
\n
\n
This is another huge update with number of significant improvements/features added.\nHopefully it will stay for a longer.
\n
\n
Features & improvements
\n
\n
dark theme
\n
search items feature
\n
backup to file feature
\n
new top bar unified acroos OS
\n
modals can be closed by pressing ESC or click outside modal area
\n
scrollbar ui improved
\n
number of keyboard shortcuts added
\n
check for updates on app startup
\n
other minor ui improvements...
\n
\n
Bug fixes
\n
\n
fixed issue which makes impossible to move some item to newly created board
\n
fix bug when specific items can't be edited nor deleted
\n
fixed issue when items list was not fully visible (last item was truncated)
\n
\n
Why I've wrote it ?
\n
When programming I often have a number of ideas related to possible improvements for the future or a cool new project. Most often, it's just one sentence or a couple of words - just a draft of an idea to expand in the future.
\n
I know that, there are hundreds of todo list managers or other notes manager,\nbut this one will finally perfectly fulfill my needs. So far I wrote my thoughts on sticky notes, I tried Evernote, Simplenote...\nThey are fine, but all of them were either bloated with unnecessary features or lacked the desired \"flow\" -\nwhen I open a program I want type down thoughts, hit enter, and get back to my actual work. That's how I write Backlog. No dependencies, no internet connection required, no external accounts etc.
\n
License
\n
It's free and opensource application under MIT license. You can do whatever you want as long as you include the original copyright and license notice in any copy of the software/source
\n
Technical
\n
How ?
\n
This application is built with Electron and web technologies (javascript, css, html) more specifically: Vue.js. UI toolkit is iView
\n
Build Setup
\n
You can build it yourself instead of downloading executable:
\n
# install dependencies\nnpm install\n\n# Compiles and hot-reloads for development\nnpm run serve\n\n# Compiles and minifies for production\nnpm run build\n\n# Run your tests\nnpm run test\n\n# Lints and fixes files\nnpm run lint\n\n# Run your unit tests\nnpm run test:unit
Simple multiplatform desktop app for storing TODOs, ideas or backlog items.\nYou can organize them with boards as a plaintext or markdown. No dependencies, no internet connection required,\nno external accounts. Sleek flow.
New 2.x version introduces a lot of new features including new UI, configurable keybindings, search item feature, emoji, and a lot more! Check it out !
When new version is available just download it, unzip and enjoy. No additional action is required. All your boards and items will be available.
\n
Change log
\n
1.8.0
\n
\n
This is another huge update with number of significant improvements/features added.\nHopefully it will stay for a longer.
\n
\n
Features & improvements
\n
\n
dark theme
\n
search items feature
\n
backup to file feature
\n
new top bar unified acroos OS
\n
modals can be closed by pressing ESC or click outside modal area
\n
scrollbar ui improved
\n
number of keyboard shortcuts added
\n
check for updates on app startup
\n
other minor ui improvements...
\n
\n
Bug fixes
\n
\n
fixed issue which makes impossible to move some item to newly created board
\n
fix bug when specific items can't be edited nor deleted
\n
fixed issue when items list was not fully visible (last item was truncated)
\n
\n
Why I've wrote it ?
\n
When programming I often have a number of ideas related to possible improvements for the future or a cool new project. Most often, it's just one sentence or a couple of words - just a draft of an idea to expand in the future.
\n
I know that, there are hundreds of todo list managers or other notes manager,\nbut this one will finally perfectly fulfill my needs. So far I wrote my thoughts on sticky notes, I tried Evernote, Simplenote...\nThey are fine, but all of them were either bloated with unnecessary features or lacked the desired \"flow\" -\nwhen I open a program I want type down thoughts, hit enter, and get back to my actual work. That's how I write Backlog. No dependencies, no internet connection required, no external accounts etc.
\n
License
\n
It's free and opensource application under MIT license. You can do whatever you want as long as you include the original copyright and license notice in any copy of the software/source
\n
Technical
\n
How ?
\n
This application is built with Electron and web technologies (javascript, css, html) more specifically: Vue.js. UI toolkit is iView
\n
Build Setup
\n
You can build it yourself instead of downloading executable:
\n
# install dependencies\nnpm install\n\n# Compiles and hot-reloads for development\nnpm run serve\n\n# Compiles and minifies for production\nnpm run build\n\n# Run your tests\nnpm run test\n\n# Lints and fixes files\nnpm run lint\n\n# Run your unit tests\nnpm run test:unit
Top feature: It's smooth 🍫, fast 🏎, and you'll actually enjoy using it 🥰
\n
\n
Autocomplete SQL query editor with syntax highlighting
\n
Tabbed interface, so you can multitask
\n
Sort and filter table data to find just what you need
\n
Sensible keyboard-shortcuts
\n
Save queries for later
\n
Query run-history, so you can find that one query you got working 3 days ago
\n
Default dark theme
\n
\n
One of our frustrations with other open-source SQL editors and database managers is that they take a 'kitchen sink' approach to features, adding so many features that the UI becomes cluttered and hard to navigate. We wanted a good looking, open source SQL workbench that's powerful, but also easy to use. We couldn't find one, so we created it!
\n
\n
Beekeeper Studio supports connecting to the following databases:
Want to write some code and improve Beekeeper Studio? Getting set-up is easy on Mac, Linux, or Windows.
\n
/beekeeper-studio.git beekeeper-studio\ncd beekeeper-studio/\nyarn install # installs dependencies\n\n# Now you can start the app:\nyarn run electron:serve ## the app will now start\n\">
# First: Install NodeJS 12+, NPM, and Yarn\n# ...\n\n# 1. Fork the Beekeeper Studio Repo (click fork button at top right of this screen)\n# 2. Check out your fork:\ngit clone git@github.com:<your-username>/beekeeper-studio.git beekeeper-studio\ncd beekeeper-studio/\nyarn install # installs dependencies\n\n# Now you can start the app:\nyarn run electron:serve ## the app will now start
\n
Where to make changes?
\n
This repo is now a monorepo, we have several places with code, but only really a couple of important entry points.
\n
All app code lives in apps/studio, some shared code lives in shared/src. This is shared with other apps.
\n
Beekeeper Studio has two entry points:
\n
\n
background.js - this is the electron-side code that controls native things like showing windows.
\n
main.js - this is the entry point for the Vue.js app. You can follow the Vue component breadcrumbs from App.vue to find the screen you need.
\n
\n
Generally we have two 'screens':
\n
\n
ConnectionInterface - connecting to a DB
\n
CoreInterface - interacting with a database
\n
\n
How to submit a change?
\n
\n
Push your changes to your repository and open a Pull Request from our github page (this page)
\n
Make sure to write some notes about what your change does! A gif is always welcome for visual changes.
\n
\n
Maintainer notes (casual readers can ignore this stuff)
\n
Release Process
\n\n
Up the version number in package.json
\n
Replace build/release-notes.md with the latest release notes. Follow the format that is there.
\n\n
\n
run git log <last-tag>..HEAD --oneline | grep 'Merge pull' to find PRs merged
\n
\n\n
Commit
\n
Push to master
\n
Create a tag git tag v<version>. It must start with a 'v'
\n
git push origin <tagname>
\n\n
\n
Now wait for the build/publish action to complete on Github
\n
\n\n
Push the new release live
\n\n
\n
Go to the new 'draft' release on the releases tab of github, edit the notes, publish
\n
Log into snapcraft.io, drag the uploaded release into the 'stable' channel for each architecture.
\n
\n
This should also publish the latest docs
\n
Post Release:
\n\n
Copy release notes to a blog post, post on website
\n
Tweet link
\n
Share on LinkedIn
\n
Send to mailing list on SendInBlue
\n\n
Big Thanks
\n
Beekeeper Studio wouldn't exist without Sqlectron-core, the core database libraries from the Sqlectron project. Beekeeper Studio started as an experimental fork of that repository. A big thanks to @maxcnunes and the rest of the Sqlectron community.
\n
",
- "readmeOriginal": "
Beekeeper Studio
\n
Beekeeper Studio is a cross-platform SQL editor and database manager available for Linux, Mac, and Windows.
\n
Beekeeper Studio is MIT licensed so it is free (libre) and free (gratis).
Top feature: It's smooth 🍫, fast 🏎, and you'll actually enjoy using it 🥰
\n
\n
Autocomplete SQL query editor with syntax highlighting
\n
Tabbed interface, so you can multitask
\n
Sort and filter table data to find just what you need
\n
Sensible keyboard-shortcuts
\n
Save queries for later
\n
Query run-history, so you can find that one query you got working 3 days ago
\n
Default dark theme
\n
\n
One of our frustrations with other open-source SQL editors and database managers is that they take a 'kitchen sink' approach to features, adding so many features that the UI becomes cluttered and hard to navigate. We wanted a good looking, open source SQL workbench that's powerful, but also easy to use. We couldn't find one, so we created it!
\n
\n
Beekeeper Studio supports connecting to the following databases:
Want to write some code and improve Beekeeper Studio? Getting set-up is easy on Mac, Linux, or Windows.
\n
# First: Install NodeJS 12+, NPM, and Yarn\n# ...\n\n# 1. Fork the Beekeeper Studio Repo (click fork button at top right of this screen)\n# 2. Check out your fork:\ngit clone git@github.com:<your-username>/beekeeper-studio.git beekeeper-studio\ncd beekeeper-studio/\nyarn install # installs dependencies\n\n# Now you can start the app:\nyarn run electron:serve ## the app will now start
\n
Where to make changes?
\n
This repo is now a monorepo, we have several places with code, but only really a couple of important entry points.
\n
All app code lives in apps/studio, some shared code lives in shared/src. This is shared with other apps.
\n
Beekeeper Studio has two entry points:
\n
\n
background.js - this is the electron-side code that controls native things like showing windows.
\n
main.js - this is the entry point for the Vue.js app. You can follow the Vue component breadcrumbs from App.vue to find the screen you need.
\n
\n
Generally we have two 'screens':
\n
\n
ConnectionInterface - connecting to a DB
\n
CoreInterface - interacting with a database
\n
\n
How to submit a change?
\n
\n
Push your changes to your repository and open a Pull Request from our github page (this page)
\n
Make sure to write some notes about what your change does! A gif is always welcome for visual changes.
\n
\n
Maintainer notes (casual readers can ignore this stuff)
\n
Release Process
\n\n
Up the version number in package.json
\n
Replace build/release-notes.md with the latest release notes. Follow the format that is there.
\n\n
\n
run git log <last-tag>..HEAD --oneline | grep 'Merge pull' to find PRs merged
\n
\n\n
Commit
\n
Push to master
\n
Create a tag git tag v<version>. It must start with a 'v'
\n
git push origin <tagname>
\n\n
\n
Now wait for the build/publish action to complete on Github
\n
\n\n
Push the new release live
\n\n
\n
Go to the new 'draft' release on the releases tab of github, edit the notes, publish
\n
Log into snapcraft.io, drag the uploaded release into the 'stable' channel for each architecture.
\n
\n
This should also publish the latest docs
\n
Post Release:
\n\n
Copy release notes to a blog post, post on website
\n
Tweet link
\n
Share on LinkedIn
\n
Send to mailing list on SendInBlue
\n\n
Big Thanks
\n
Beekeeper Studio wouldn't exist without Sqlectron-core, the core database libraries from the Sqlectron project. Beekeeper Studio started as an experimental fork of that repository. A big thanks to @maxcnunes and the rest of the Sqlectron community.
autoEdit 2 is a fast text based video editing, desktop app for Mac, Linux and Windows, built with node and electron, and Backbone front end. For making video production faster, easier and more accessible.
\n
Ready to use release
\n
See releases section to download latest packaged version ready to use. And view user manual for overview of the app.
Compiles the js client side files with browserify and starts electron
\n
Note: You'd also need to get Speech to text keys or have the Gentle Open source app running locally check out the user manual for more details, unless you are choosing pocketsphinx as speech to text option.
autoEdit 2 is a fast text based video editing, desktop app for Mac, Linux and Windows, built with node and electron, and Backbone front end. For making video production faster, easier and more accessible.
\n
Ready to use release
\n
See releases section to download latest packaged version ready to use. And view user manual for overview of the app.
Compiles the js client side files with browserify and starts electron
\n
Note: You'd also need to get Speech to text keys or have the Gentle Open source app running locally check out the user manual for more details, unless you are choosing pocketsphinx as speech to text option.
bibisco is an open source application for writing novels.
\n
bibisco is a personal project, made with love.
\n
We love books and we want to help writers to write beautiful novels.
\n
With bibisco you can organize chapters and scenes, manage revisions, export novel in pdf, docx, or txt and write with a fully featured text editor.
\n
You can create a novel structure, define premise, fabula, narrative strands and settings: geographic, temporal and social context.
\n
And, most of all, with bibisco you can know everything about your characters. Because your novel works only if its characters are believable, that is when you understand their human nature's complexity.
\n
bibisco has 2 versions: Community Edition and Supporters Edition; this is the repository of bibisco Community Edition.
\n
Official website and blog
\n
You can find all information regarding bibisco novel writing software from the official website and from official blog.
bibisco is an open source application for writing novels.
\n
bibisco is a personal project, made with love.
\n
We love books and we want to help writers to write beautiful novels.
\n
With bibisco you can organize chapters and scenes, manage revisions, export novel in pdf, docx, or txt and write with a fully featured text editor.
\n
You can create a novel structure, define premise, fabula, narrative strands and settings: geographic, temporal and social context.
\n
And, most of all, with bibisco you can know everything about your characters. Because your novel works only if its characters are believable, that is when you understand their human nature's complexity.
\n
bibisco has 2 versions: Community Edition and Supporters Edition; this is the repository of bibisco Community Edition.
\n
Official website and blog
\n
You can find all information regarding bibisco novel writing software from the official website and from official blog.
git clone https://github.com/kyaroru/bear-sweeper.git\ncd bear-sweeper\nnpm i
\n
Start & Run in Browser
\n
npm start
\n
Start & Run Electron App
\n
npm run start-app
\n
Build & Deploy
\n
npm run mas-dev (for MacOS - development version for Mac App Store) --- CERT & PROVISIONING NEEDED\nnpm run mas (for MacOS - distribute via Mac App Store) --- CERT & PROVISIONING NEEDED\nnpm run dmg (for MacOS - distribute outside Mac App Store)\nnpm run appx (for Windows - distribute via Windows Store) --- PUBLISHER ACCOUNT NEEDED\nnpm run win (for Window - distribute outside Windows store)
\n
Available on Mac/Windows
\n
\n
\n
",
"readmeOriginal": "
BearSweeper
\n
\n
Welcome, this game was originally built using React Native & now porting to Electron + ReactJS
git clone https://github.com/kyaroru/bear-sweeper.git\ncd bear-sweeper\nnpm i
\n
Start & Run in Browser
\n
npm start
\n
Start & Run Electron App
\n
npm run start-app
\n
Build & Deploy
\n
npm run mas-dev (for MacOS - development version for Mac App Store) --- CERT & PROVISIONING NEEDED\nnpm run mas (for MacOS - distribute via Mac App Store) --- CERT & PROVISIONING NEEDED\nnpm run dmg (for MacOS - distribute outside Mac App Store)\nnpm run appx (for Windows - distribute via Windows Store) --- PUBLISHER ACCOUNT NEEDED\nnpm run win (for Window - distribute outside Windows store)
Top feature: It's smooth 🍫, fast 🏎, and you'll actually enjoy using it 🥰
\n
\n
Autocomplete SQL query editor with syntax highlighting
\n
Tabbed interface, so you can multitask
\n
Sort and filter table data to find just what you need
\n
Sensible keyboard-shortcuts
\n
Save queries for later
\n
Query run-history, so you can find that one query you got working 3 days ago
\n
Default dark theme
\n
\n
One of our frustrations with other open-source SQL editors and database managers is that they take a 'kitchen sink' approach to features, adding so many features that the UI becomes cluttered and hard to navigate. We wanted a good looking, open source SQL workbench that's powerful, but also easy to use. We couldn't find one, so we created it!
\n
\n
Beekeeper Studio supports connecting to the following databases:
Want to write some code and improve Beekeeper Studio? Getting set-up is easy on Mac, Linux, or Windows.
\n
/beekeeper-studio.git beekeeper-studio\ncd beekeeper-studio/\nyarn install # installs dependencies\n\n# Now you can start the app:\nyarn run electron:serve ## the app will now start\n\">
# First: Install NodeJS 12+, NPM, and Yarn\n# ...\n\n# 1. Fork the Beekeeper Studio Repo (click fork button at top right of this screen)\n# 2. Check out your fork:\ngit clone git@github.com:<your-username>/beekeeper-studio.git beekeeper-studio\ncd beekeeper-studio/\nyarn install # installs dependencies\n\n# Now you can start the app:\nyarn run electron:serve ## the app will now start
\n
Where to make changes?
\n
This repo is now a monorepo, we have several places with code, but only really a couple of important entry points.
\n
All app code lives in apps/studio, some shared code lives in shared/src. This is shared with other apps.
\n
Beekeeper Studio has two entry points:
\n
\n
background.js - this is the electron-side code that controls native things like showing windows.
\n
main.js - this is the entry point for the Vue.js app. You can follow the Vue component breadcrumbs from App.vue to find the screen you need.
\n
\n
Generally we have two 'screens':
\n
\n
ConnectionInterface - connecting to a DB
\n
CoreInterface - interacting with a database
\n
\n
How to submit a change?
\n
\n
Push your changes to your repository and open a Pull Request from our github page (this page)
\n
Make sure to write some notes about what your change does! A gif is always welcome for visual changes.
\n
\n
Maintainer notes (casual readers can ignore this stuff)
\n
Release Process
\n\n
Up the version number in package.json
\n
Replace build/release-notes.md with the latest release notes. Follow the format that is there.
\n\n
\n
run git log <last-tag>..HEAD --oneline | grep 'Merge pull' to find PRs merged
\n
\n\n
Commit
\n
Push to master
\n
Create a tag git tag v<version>. It must start with a 'v'
\n
git push origin <tagname>
\n\n
\n
Now wait for the build/publish action to complete on Github
\n
\n\n
Push the new release live
\n\n
\n
Go to the new 'draft' release on the releases tab of github, edit the notes, publish
\n
Log into snapcraft.io, drag the uploaded release into the 'stable' channel for each architecture.
\n
\n
This should also publish the latest docs
\n
Post Release:
\n\n
Copy release notes to a blog post, post on website
\n
Tweet link
\n
Share on LinkedIn
\n
Send to mailing list on SendInBlue
\n\n
Big Thanks
\n
Beekeeper Studio wouldn't exist without Sqlectron-core, the core database libraries from the Sqlectron project. Beekeeper Studio started as an experimental fork of that repository. A big thanks to @maxcnunes and the rest of the Sqlectron community.
\n
",
+ "readmeOriginal": "
Beekeeper Studio
\n
Beekeeper Studio is a cross-platform SQL editor and database manager available for Linux, Mac, and Windows.
\n
Beekeeper Studio is MIT licensed so it is free (libre) and free (gratis).
Top feature: It's smooth 🍫, fast 🏎, and you'll actually enjoy using it 🥰
\n
\n
Autocomplete SQL query editor with syntax highlighting
\n
Tabbed interface, so you can multitask
\n
Sort and filter table data to find just what you need
\n
Sensible keyboard-shortcuts
\n
Save queries for later
\n
Query run-history, so you can find that one query you got working 3 days ago
\n
Default dark theme
\n
\n
One of our frustrations with other open-source SQL editors and database managers is that they take a 'kitchen sink' approach to features, adding so many features that the UI becomes cluttered and hard to navigate. We wanted a good looking, open source SQL workbench that's powerful, but also easy to use. We couldn't find one, so we created it!
\n
\n
Beekeeper Studio supports connecting to the following databases:
Want to write some code and improve Beekeeper Studio? Getting set-up is easy on Mac, Linux, or Windows.
\n
# First: Install NodeJS 12+, NPM, and Yarn\n# ...\n\n# 1. Fork the Beekeeper Studio Repo (click fork button at top right of this screen)\n# 2. Check out your fork:\ngit clone git@github.com:<your-username>/beekeeper-studio.git beekeeper-studio\ncd beekeeper-studio/\nyarn install # installs dependencies\n\n# Now you can start the app:\nyarn run electron:serve ## the app will now start
\n
Where to make changes?
\n
This repo is now a monorepo, we have several places with code, but only really a couple of important entry points.
\n
All app code lives in apps/studio, some shared code lives in shared/src. This is shared with other apps.
\n
Beekeeper Studio has two entry points:
\n
\n
background.js - this is the electron-side code that controls native things like showing windows.
\n
main.js - this is the entry point for the Vue.js app. You can follow the Vue component breadcrumbs from App.vue to find the screen you need.
\n
\n
Generally we have two 'screens':
\n
\n
ConnectionInterface - connecting to a DB
\n
CoreInterface - interacting with a database
\n
\n
How to submit a change?
\n
\n
Push your changes to your repository and open a Pull Request from our github page (this page)
\n
Make sure to write some notes about what your change does! A gif is always welcome for visual changes.
\n
\n
Maintainer notes (casual readers can ignore this stuff)
\n
Release Process
\n\n
Up the version number in package.json
\n
Replace build/release-notes.md with the latest release notes. Follow the format that is there.
\n\n
\n
run git log <last-tag>..HEAD --oneline | grep 'Merge pull' to find PRs merged
\n
\n\n
Commit
\n
Push to master
\n
Create a tag git tag v<version>. It must start with a 'v'
\n
git push origin <tagname>
\n\n
\n
Now wait for the build/publish action to complete on Github
\n
\n\n
Push the new release live
\n\n
\n
Go to the new 'draft' release on the releases tab of github, edit the notes, publish
\n
Log into snapcraft.io, drag the uploaded release into the 'stable' channel for each architecture.
\n
\n
This should also publish the latest docs
\n
Post Release:
\n\n
Copy release notes to a blog post, post on website
\n
Tweet link
\n
Share on LinkedIn
\n
Send to mailing list on SendInBlue
\n\n
Big Thanks
\n
Beekeeper Studio wouldn't exist without Sqlectron-core, the core database libraries from the Sqlectron project. Beekeeper Studio started as an experimental fork of that repository. A big thanks to @maxcnunes and the rest of the Sqlectron community.
Beaker is an experimental peer-to-peer Web browser. It adds new APIs for building hostless applications while remaining compatible with the rest of the Web. Visit the website.
\n
Please feel free to open usability issues. Join us at #beakerbrowser on Freenode.
\n
Sponsors
\n
Sponsors support this project by contributing $100 a month or more. Become a sponsor
\n
\n\n\n\n\n\n\n\n\n
\n
Backers
\n
Backers support this project by contributing $2 to $99 a month. Become a backer
In Windows, you'll need to install Python 2.7, Visual Studio 2015 or 2017, and Git. (You might try windows-build-tools.) Then run:
\n
npm config set python c:/python27\nnpm config set msvs_version 2017\nnpm install -g node-gyp\nnpm install -g gulp
\n
To build:
\n
git clone https://github.com/beakerbrowser/beaker.git\ncd beaker/scripts\nnpm install # don't worry about v8 api errors building native modules - rebuild will fix\nnpm run rebuild # needed after each install. see https://github.com/electron/electron/issues/5851\nnpm start
\n
If you pull latest from the repo and get weird module errors, do:
\n
npm run burnthemall
\n
This invokes the mad king, who will torch your node_modules/, and do the full install/rebuild process for you.\n(We chose that command name when GoT was still cool.)\nnpm start should work afterward.
\n
If you're doing development, npm run watch to have assets build automatically.
DEBUG: which log systems to output? A comma-separated string. Can be beaker, dat, bittorrent-dht, dns-discovery, hypercore-protocol. Specify * for all.
\n
BEAKER_OPEN_URL: open the given URL on load, rather than the previous session or default tab.
\n
BEAKER_USER_DATA_PATH: override the user-data path, therefore changing where data is read/written. Useful for testing. For default value see userData in the electron docs.
\n
BEAKER_DAT_QUOTA_DEFAULT_BYTES_ALLOWED: override the default max-quota for bytes allowed to be written by a dat site. Useful for testing. Default value is '500mb'. This can be a Number or a String. Check bytes.parse for supported units and abbreviations.
\n
\n
Vulnerability disclosure
\n
See SECURITY.md for reporting security issues and vulnerabilities.
\n
Known issues
\n
tmux
\n
Launching from tmux is known to cause issues with GUI apps in macOS. On Beaker, it may cause the application to hang during startup.
\n
Contributors
\n
This project exists thanks to all the people who contribute. [Contribute].\n
\n
License
\n
MIT License (MIT)
\n
Copyright (c) 2018 Blue Link Labs
\n
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
\n
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
\n
THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
\n
",
"readmeOriginal": "
Beaker Browser
\n
\n
\n
Beaker is an experimental peer-to-peer Web browser. It adds new APIs for building hostless applications while remaining compatible with the rest of the Web. Visit the website.
\n
Please feel free to open usability issues. Join us at #beakerbrowser on Freenode.
\n
Sponsors
\n
Sponsors support this project by contributing $100 a month or more. Become a sponsor
\n
\n\n\n\n\n\n\n\n\n
\n
Backers
\n
Backers support this project by contributing $2 to $99 a month. Become a backer
In Windows, you'll need to install Python 2.7, Visual Studio 2015 or 2017, and Git. (You might try windows-build-tools.) Then run:
\n
npm config set python c:/python27\nnpm config set msvs_version 2017\nnpm install -g node-gyp\nnpm install -g gulp
\n
To build:
\n
git clone https://github.com/beakerbrowser/beaker.git\ncd beaker/scripts\nnpm install # don't worry about v8 api errors building native modules - rebuild will fix\nnpm run rebuild # needed after each install. see https://github.com/electron/electron/issues/5851\nnpm start
\n
If you pull latest from the repo and get weird module errors, do:
\n
npm run burnthemall
\n
This invokes the mad king, who will torch your node_modules/, and do the full install/rebuild process for you.\n(We chose that command name when GoT was still cool.)\nnpm start should work afterward.
\n
If you're doing development, npm run watch to have assets build automatically.
DEBUG: which log systems to output? A comma-separated string. Can be beaker, dat, bittorrent-dht, dns-discovery, hypercore-protocol. Specify * for all.
\n
BEAKER_OPEN_URL: open the given URL on load, rather than the previous session or default tab.
\n
BEAKER_USER_DATA_PATH: override the user-data path, therefore changing where data is read/written. Useful for testing. For default value see userData in the electron docs.
\n
BEAKER_DAT_QUOTA_DEFAULT_BYTES_ALLOWED: override the default max-quota for bytes allowed to be written by a dat site. Useful for testing. Default value is '500mb'. This can be a Number or a String. Check bytes.parse for supported units and abbreviations.
\n
\n
Vulnerability disclosure
\n
See SECURITY.md for reporting security issues and vulnerabilities.
\n
Known issues
\n
tmux
\n
Launching from tmux is known to cause issues with GUI apps in macOS. On Beaker, it may cause the application to hang during startup.
\n
Contributors
\n
This project exists thanks to all the people who contribute. [Contribute].\n
\n
License
\n
MIT License (MIT)
\n
Copyright (c) 2018 Blue Link Labs
\n
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
\n
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
\n
THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
bibisco is an open source application for writing novels.
\n
bibisco is a personal project, made with love.
\n
We love books and we want to help writers to write beautiful novels.
\n
With bibisco you can organize chapters and scenes, manage revisions, export novel in pdf, docx, or txt and write with a fully featured text editor.
\n
You can create a novel structure, define premise, fabula, narrative strands and settings: geographic, temporal and social context.
\n
And, most of all, with bibisco you can know everything about your characters. Because your novel works only if its characters are believable, that is when you understand their human nature's complexity.
\n
bibisco has 2 versions: Community Edition and Supporters Edition; this is the repository of bibisco Community Edition.
\n
Official website and blog
\n
You can find all information regarding bibisco novel writing software from the official website and from official blog.
bibisco is an open source application for writing novels.
\n
bibisco is a personal project, made with love.
\n
We love books and we want to help writers to write beautiful novels.
\n
With bibisco you can organize chapters and scenes, manage revisions, export novel in pdf, docx, or txt and write with a fully featured text editor.
\n
You can create a novel structure, define premise, fabula, narrative strands and settings: geographic, temporal and social context.
\n
And, most of all, with bibisco you can know everything about your characters. Because your novel works only if its characters are believable, that is when you understand their human nature's complexity.
\n
bibisco has 2 versions: Community Edition and Supporters Edition; this is the repository of bibisco Community Edition.
\n
Official website and blog
\n
You can find all information regarding bibisco novel writing software from the official website and from official blog.
So, I decided to take a crack at learning React and building an application that I found deeply missing in Linux: a Desktop Recipe Manager (I know there are some, but they don't match my needs...)
\n
I you want to contribute, please send me a mail or a pidgeon 😁
\n
\n
Screenshots
\n
\n
Dark and light themes - Grid view
\n
\n \n
\n
\n
Image list view
\n
\n \n
\n
\n
Table view
\n
\n \n
\n
\n
Print view
\n
\n \n
\n
\n
Edit view
\n
\n \n
\n
\n
Preferences screen - Storage tab
\n
\n \n
\n
\n
Preferences screen - Theme tab
\n
\n \n
\n
Features
\n
\n
Cross platform
\n
Localized (english, french, german and italian)
\n
Custom Themes (a light one and two dark ones for now)
\n
Content search
\n
Tags
\n
Categories
\n
Ratings
\n
Favorites
\n
Source URL
\n
Table view with column sorting
\n
Change the ingredients amounts when adjusting the servings (ready to print view)
\n
Print current recipe
\n
Choose your storage directory (including Sync Services)
\n
Backups and Restore backups
\n
Unit Converter
\n
Recipe Websites scraper (63 supported websites in 4 languages)
Visit the Releases Page to find the installer you need.
\n
Building from source
\n
# clone the project\ngit clone https://github.com/fredserva/birdskitchen.git\n\n# change directory to the project folder\ncd birdskitchen\n\n# install dependencies\nyarn\n\n# run the app in development mode\nyarn dev
\n
Contributing
\n
To add support for your favorite language, or submit new features, feel free to open an issue or contact me directly.\nContributions are very welcomed!
So, I decided to take a crack at learning React and building an application that I found deeply missing in Linux: a Desktop Recipe Manager (I know there are some, but they don't match my needs...)
\n
I you want to contribute, please send me a mail or a pidgeon 😁
\n
\n
Screenshots
\n
\n
Dark and light themes - Grid view
\n
\n \n
\n
\n
Image list view
\n
\n \n
\n
\n
Table view
\n
\n \n
\n
\n
Print view
\n
\n \n
\n
\n
Edit view
\n
\n \n
\n
\n
Preferences screen - Storage tab
\n
\n \n
\n
\n
Preferences screen - Theme tab
\n
\n \n
\n
Features
\n
\n
Cross platform
\n
Localized (english, french, german and italian)
\n
Custom Themes (a light one and two dark ones for now)
\n
Content search
\n
Tags
\n
Categories
\n
Ratings
\n
Favorites
\n
Source URL
\n
Table view with column sorting
\n
Change the ingredients amounts when adjusting the servings (ready to print view)
\n
Print current recipe
\n
Choose your storage directory (including Sync Services)
\n
Backups and Restore backups
\n
Unit Converter
\n
Recipe Websites scraper (63 supported websites in 4 languages)
Visit the Releases Page to find the installer you need.
\n
Building from source
\n
# clone the project\ngit clone https://github.com/fredserva/birdskitchen.git\n\n# change directory to the project folder\ncd birdskitchen\n\n# install dependencies\nyarn\n\n# run the app in development mode\nyarn dev
\n
Contributing
\n
To add support for your favorite language, or submit new features, feel free to open an issue or contact me directly.\nContributions are very welcomed!
npm run build // build unpacked dir. Useful to test\nnpm run pack:windows // build for Windows\nnpm run pack:mac // build for Mac\nnpm run pack:linux // build for Linux\nnpm run dist:all // build for Windows, Mac and Linux\n
npm run build // build unpacked dir. Useful to test\nnpm run pack:windows // build for Windows\nnpm run pack:mac // build for Mac\nnpm run pack:linux // build for Linux\nnpm run dist:all // build for Windows, Mac and Linux\n
En la versión actual soportamos las siguientes placas:
\n
\n
Arduino UNO
\n
Freaduino UNO
\n
BQ ZUM
\n
\n
Y los siguientes robots:
\n
\n
ZOWI
\n
\n
¿Utilizas otra placa o robot y quieres que la añadamos en Bitbloq? Escríbenos a soporte.bitbloq@bq.com e intentaremos hablar con el fabricante para que nos permita introducirlo en Bitbloq.\nPor supuesto es un proyecto Open Source y también aceptamos contribuciones de cualquier persona siempre que sean correctas.
\n
Actualmente Bitbloq offline funciona en las siguientes plataformas:
\n
\n
Linux (Ubuntu 12.04 y superior, Fedora 21, Debian 8)
\n
Mac OS X 10.9 o superior
\n
Windows 7 y posterior, ambos 32 y 64 (la versión ARM de Windows no está soportada por ahora).
\n
\n
Puedes encontrar los instaladores de la aplicación aquí:
Es una aplicación portable, no requiere instalación ni permisos de administrador para ejecutarse, pero tu placa es posible que requiera drivers, hemos añadido algunos en la carpeta drivers de la aplicación. ¡ Acuérdate de instalarlos !
\n
\n
\n
Acuérdate de descomprimir el fichero que te descargas en una carpeta en la que luego el usuario que lo utilice tenga permisos, por ejemplo, en windows no la descomprimas directamente en \"c:\", o en la carpeta de \"c:/Archivos de programa\", ejemplos válidos son la carpeta \"Documentos\" del usuario o en el escritorio.
\n
\n
\n
¿No te detecta la placa y está conectada el ordenador? Revisa este documento y si sigues teniendo incidencias, no dudes en escríbirnos a soporte.bitbloq@bq.com.
\n
\n
\n
Recuerda que al ser una aplicación offline, no tendrás todas las ventajas ni novedades de la web. Te recomendamos que la uses solo cuando no tienes conexión estable a internet.
\n
\n
Bitbloq Offline
\n
[en_GB]
\n
THIS PROJECT IS DISCONTINUED AND WILL NO RECEIVE FURTHER SUPPORT
The current version supports the following boards:
\n
\n
Arduino UNO
\n
Freaduino UNO
\n
BQ ZUM
\n
\n
And the following robots:
\n
\n
ZOWI
\n
\n
Do you have a board or robot that is not in Bitbloq? Email us to support.bitbloq.en@bq.com, and we will reach the manufacturer to introduce it on Bitbloq.\nBitbloq is an Open Source project so we will accept contributions adding new boards / robots if they are correct.
\n
In this platforms:
\n
\n
Linux (Ubuntu 12.04 and later, Fedora 21, Debian 8)
\n
Mac OS X 10.9 or greater
\n
Windows 7 and later, both 32 and 64 (ARM version os Windows is not suported for now).
This will generate a /dist/{os} folder with the app ready to be launched.
\n
App Structure
\n
app\n├── fonts // App fonts\n├── images // App images\n│ ├── boards // Images for boards\n│ ├── components // Images for components\n│ ├── icons // Icons for svgstore\n│ └── robots // Images for robots\n├── res // Common resources\n│ ├── locales // Language translations\n│ ├── menus // JSON files for generating menus\n│ └── web2board // web2board nested app\n├── scripts // Angular scripts\n│ ├── controllers // Angular controllers\n│ ├── directives // Angular directives\n│ ├── factories // Angular factories\n│ └── services // Angular services\n├── styles // App styles\n│ ├── components // Styles for components\n│ ├── vendor // Vendor styles\n│ └── views // Styles for views\n└── views // All views\n│ ├── components // Views for components\n│ └── view.html // App normal view\n└── main.js // Electron config\n
\n
Developing
\n
You can set your own config in main.js file.
\n
Grunt tasks
\n
grunt svgstore // Generates an svg sprite from icons folder.\ngrunt sass // Compiles scss files to a single main.css file.\ngrunt watch // Watches yout changes and reloads the app.\n
\n
",
"readmeOriginal": "
Bitbloq Offline
\n
[es_ES]
\n
ESTE PROYECTO ESTÁ DISCONTINUADO Y NO RECIBIRÁ SOPORTE
En la versión actual soportamos las siguientes placas:
\n
\n
Arduino UNO
\n
Freaduino UNO
\n
BQ ZUM
\n
\n
Y los siguientes robots:
\n
\n
ZOWI
\n
\n
¿Utilizas otra placa o robot y quieres que la añadamos en Bitbloq? Escríbenos a soporte.bitbloq@bq.com e intentaremos hablar con el fabricante para que nos permita introducirlo en Bitbloq.\nPor supuesto es un proyecto Open Source y también aceptamos contribuciones de cualquier persona siempre que sean correctas.
\n
Actualmente Bitbloq offline funciona en las siguientes plataformas:
\n
\n
Linux (Ubuntu 12.04 y superior, Fedora 21, Debian 8)
\n
Mac OS X 10.9 o superior
\n
Windows 7 y posterior, ambos 32 y 64 (la versión ARM de Windows no está soportada por ahora).
\n
\n
Puedes encontrar los instaladores de la aplicación aquí:
Es una aplicación portable, no requiere instalación ni permisos de administrador para ejecutarse, pero tu placa es posible que requiera drivers, hemos añadido algunos en la carpeta drivers de la aplicación. ¡ Acuérdate de instalarlos !
\n
\n
\n
Acuérdate de descomprimir el fichero que te descargas en una carpeta en la que luego el usuario que lo utilice tenga permisos, por ejemplo, en windows no la descomprimas directamente en \"c:\", o en la carpeta de \"c:/Archivos de programa\", ejemplos válidos son la carpeta \"Documentos\" del usuario o en el escritorio.
\n
\n
\n
¿No te detecta la placa y está conectada el ordenador? Revisa este documento y si sigues teniendo incidencias, no dudes en escríbirnos a soporte.bitbloq@bq.com.
\n
\n
\n
Recuerda que al ser una aplicación offline, no tendrás todas las ventajas ni novedades de la web. Te recomendamos que la uses solo cuando no tienes conexión estable a internet.
\n
\n
Bitbloq Offline
\n
[en_GB]
\n
THIS PROJECT IS DISCONTINUED AND WILL NO RECEIVE FURTHER SUPPORT
The current version supports the following boards:
\n
\n
Arduino UNO
\n
Freaduino UNO
\n
BQ ZUM
\n
\n
And the following robots:
\n
\n
ZOWI
\n
\n
Do you have a board or robot that is not in Bitbloq? Email us to support.bitbloq.en@bq.com, and we will reach the manufacturer to introduce it on Bitbloq.\nBitbloq is an Open Source project so we will accept contributions adding new boards / robots if they are correct.
\n
In this platforms:
\n
\n
Linux (Ubuntu 12.04 and later, Fedora 21, Debian 8)
\n
Mac OS X 10.9 or greater
\n
Windows 7 and later, both 32 and 64 (ARM version os Windows is not suported for now).
This will generate a /dist/{os} folder with the app ready to be launched.
\n
App Structure
\n
app\n├── fonts // App fonts\n├── images // App images\n│ ├── boards // Images for boards\n│ ├── components // Images for components\n│ ├── icons // Icons for svgstore\n│ └── robots // Images for robots\n├── res // Common resources\n│ ├── locales // Language translations\n│ ├── menus // JSON files for generating menus\n│ └── web2board // web2board nested app\n├── scripts // Angular scripts\n│ ├── controllers // Angular controllers\n│ ├── directives // Angular directives\n│ ├── factories // Angular factories\n│ └── services // Angular services\n├── styles // App styles\n│ ├── components // Styles for components\n│ ├── vendor // Vendor styles\n│ └── views // Styles for views\n└── views // All views\n│ ├── components // Views for components\n│ └── view.html // App normal view\n└── main.js // Electron config\n
\n
Developing
\n
You can set your own config in main.js file.
\n
Grunt tasks
\n
grunt svgstore // Generates an svg sprite from icons folder.\ngrunt sass // Compiles scss files to a single main.css file.\ngrunt watch // Watches yout changes and reloads the app.\n
This is a light wallet that connects to a BitShares API provided by the witness_node executable.
\n
It stores all keys locally in the browser, never exposing your keys to anyone as it signs transactions locally before transmitting them to the API server which then broadcasts them to the blockchain network. The wallet is encrypted with a password of your choosing and encrypted in a browser database.
\n
Getting started
\n
BitShares-UI depends node Node.js, and version 8+ is required.
\n
On Ubuntu and OSX, the easiest way to install Node is to use the Node Version Manager.
\n
To install NVM for Linux/OSX, simply copy paste the following in a terminal:
\n
curl -o- https://raw.githubusercontent.com/creationix/nvm/v0.30.2/install.sh | bash\nnvm install v9\nnvm use v9\n
\n
Once you have Node installed, you can clone the repo:
Before launching the GUI you will need to install the npm packages:
\n
npm install\n
\n
Running the dev server
\n
The dev server uses Express in combination with Webpack.
\n
Once all the packages have been installed you can start the development server by running:
\n
npm start\n
\n
Once the compilation is done the GUI will be available in your browser at: localhost:8080 or 127.0.0.1:8080. Hot Reloading is enabled so the browser will live update as you edit the source files.
\n
Testnet
\n
By default bitshares-ui connects to the live BitShares network, but it's very easy to switch it to the testnet run by Xeroc. To do so, open the UI in a browser, go to Settings, then under Access, select the Public Testnet Server in the dropdown menu. You should also change the faucet if you need to create an account, the testnet faucet address is https://testnet.bitshares.eu.
\n
The UI will reload and connect to the testnet, where you can use the faucet to create an account and receive an initial sum of test BTS.
\n
\n
Production
\n
If you'd like to host your own wallet somewhere, you should create a production build and host it using NGINX or Apache. In order to create a prod bundle, simply run the following command:
\n
npm run build\n
\n
This will create a bundle in the ./build/dist folder that can be hosted with the web server of your choice.
\n
Installable wallets
\n
We use Electron to provide installable wallets, available for Windows, OSX and Linux Debian platforms such as Ubuntu. First, make sure your local python version is 2.7.x, as a dependency requires this.
\n
On Linux you will need to install the following packages to handle icon generation:
For building, each architecture has it's own script that you can use to build your native binary:
\n
Linux\nnpm run package-deb \nWindows\nnpm run package-win \nMac\nnpm run package-mac
\n
This will compile the UI with some special modifications for use with Electron, generate installable binaries with Electron and copy the result to the root build/binaries folder.
\n
Docker
\n
Clone this repository, run docker-compose up and visit localhost:8080
This repository has a Code of Conduct that should be followed by everyone.\nPlease read CODE_OF_CONDUCT.md
\n
Please keep comments constructive and clean
\n
BrowserStack
\n
The BitShares UI is integrated with BrowserStack (https://www.browserstack.com) to allow manual compatibility testing across devices and browser versions. In the future we will switch to a automated Selenium testing framework.\n
\n
Release Branches
\n
Development is processed through two week milestones.\nThere are three branches that forms the current release process.
\n
Develop
\n
All PRs should be pushed to the develop branch. At the end of each milestone this branch is pushed to staging.\nNew commits are automatically deployed to this branch and published for review.
This is a light wallet that connects to a BitShares API provided by the witness_node executable.
\n
It stores all keys locally in the browser, never exposing your keys to anyone as it signs transactions locally before transmitting them to the API server which then broadcasts them to the blockchain network. The wallet is encrypted with a password of your choosing and encrypted in a browser database.
\n
Getting started
\n
BitShares-UI depends node Node.js, and version 8+ is required.
\n
On Ubuntu and OSX, the easiest way to install Node is to use the Node Version Manager.
\n
To install NVM for Linux/OSX, simply copy paste the following in a terminal:
\n
curl -o- https://raw.githubusercontent.com/creationix/nvm/v0.30.2/install.sh | bash\nnvm install v9\nnvm use v9\n
\n
Once you have Node installed, you can clone the repo:
Before launching the GUI you will need to install the npm packages:
\n
npm install\n
\n
Running the dev server
\n
The dev server uses Express in combination with Webpack.
\n
Once all the packages have been installed you can start the development server by running:
\n
npm start\n
\n
Once the compilation is done the GUI will be available in your browser at: localhost:8080 or 127.0.0.1:8080. Hot Reloading is enabled so the browser will live update as you edit the source files.
\n
Testnet
\n
By default bitshares-ui connects to the live BitShares network, but it's very easy to switch it to the testnet run by Xeroc. To do so, open the UI in a browser, go to Settings, then under Access, select the Public Testnet Server in the dropdown menu. You should also change the faucet if you need to create an account, the testnet faucet address is https://testnet.bitshares.eu.
\n
The UI will reload and connect to the testnet, where you can use the faucet to create an account and receive an initial sum of test BTS.
\n
\n
Production
\n
If you'd like to host your own wallet somewhere, you should create a production build and host it using NGINX or Apache. In order to create a prod bundle, simply run the following command:
\n
npm run build\n
\n
This will create a bundle in the ./build/dist folder that can be hosted with the web server of your choice.
\n
Installable wallets
\n
We use Electron to provide installable wallets, available for Windows, OSX and Linux Debian platforms such as Ubuntu. First, make sure your local python version is 2.7.x, as a dependency requires this.
\n
On Linux you will need to install the following packages to handle icon generation:
For building, each architecture has it's own script that you can use to build your native binary:
\n
Linux\nnpm run package-deb \nWindows\nnpm run package-win \nMac\nnpm run package-mac
\n
This will compile the UI with some special modifications for use with Electron, generate installable binaries with Electron and copy the result to the root build/binaries folder.
\n
Docker
\n
Clone this repository, run docker-compose up and visit localhost:8080
This repository has a Code of Conduct that should be followed by everyone.\nPlease read CODE_OF_CONDUCT.md
\n
Please keep comments constructive and clean
\n
BrowserStack
\n
The BitShares UI is integrated with BrowserStack (https://www.browserstack.com) to allow manual compatibility testing across devices and browser versions. In the future we will switch to a automated Selenium testing framework.\n
\n
Release Branches
\n
Development is processed through two week milestones.\nThere are three branches that forms the current release process.
\n
Develop
\n
All PRs should be pushed to the develop branch. At the end of each milestone this branch is pushed to staging.\nNew commits are automatically deployed to this branch and published for review.
Blockbench is a free, modern model editor for boxy models and pixel art textures.\nModels can be exported for Minecraft Java and Bedrock Edition as well as most game engines and other 3D applications.
\n
Blockbench features a modern and intuitive UI, plugin support and innovative features. It is the industry standard for creating custom 3D models for the Minecraft Marketplace.
To launch Blockbench from source, you can clone the repository, navigate to the correct branch and launch the program in development mode using the instructions below. If you just want to use the latest version, please download the app from the website.
The Blockbench source-code is licensed under the GPL license version 3. See LICENSE.MD.
\n
Modifications to the source code can be made under the terms of that license.
\n
Blockbench plugins (external scripts) and themes (theme files to customize the design) that interact with the Blockbench API are an exception. Plugins and themes can be created and/or published as open source, proprietary or paid software.
\n
All assets created with Blockbench (models, textures, animations, screenshots etc.) are your own!
\n
\n
",
"readmeOriginal": "
Blockbench
\n
Blockbench is a free, modern model editor for boxy models and pixel art textures.\nModels can be exported for Minecraft Java and Bedrock Edition as well as most game engines and other 3D applications.
\n
Blockbench features a modern and intuitive UI, plugin support and innovative features. It is the industry standard for creating custom 3D models for the Minecraft Marketplace.
To launch Blockbench from source, you can clone the repository, navigate to the correct branch and launch the program in development mode using the instructions below. If you just want to use the latest version, please download the app from the website.
The Blockbench source-code is licensed under the GPL license version 3. See LICENSE.MD.
\n
Modifications to the source code can be made under the terms of that license.
\n
Blockbench plugins (external scripts) and themes (theme files to customize the design) that interact with the Blockbench API are an exception. Plugins and themes can be created and/or published as open source, proprietary or paid software.
\n
All assets created with Blockbench (models, textures, animations, screenshots etc.) are your own!
BlinkMindDesktop is an open source mind-map and outliner app.
\n
BlinkMindDesktop is an MIT licensed open source project, and the latest version will always be downloadable for free from the GitHub release page. BlinkMindDesktop is still in development.
\n
BlinkMindDesktop uses the open source mind-map library BlinkMind for mind-map rendering.
Set topic style include border, text color, font, background and links.
\n
\n
\n
Customize theme
\n
✔️
\n
Theme editor, import theme, export theme.
\n
\n
\n
Shortcuts
\n
✔️
\n
Shortcuts to make more efficient.
\n
\n
\n
Drag and drop
\n
✔️
\n
Support drag one topic and then drop to another topic to reorganize the mind map.
\n
\n
\n
Open and save file
\n
✔️
\n
Save and open .bmind file, double click file to open.
\n
\n
\n
Export topic to image
\n
✔️
\n
Export topic to png/jpg/svg.
\n
\n
\n
Insert image to topic
\n
✔️
\n
Every topic can insert unlimited images.
\n
\n
\n
Paste rich text to topic
\n
✔️
\n
You can paste rich text from browser/microsoft word/apple pages or anything else to BlinkMind without losing format.
\n
\n
\n
Rich text editor for topic notes
\n
✔️
\n
Rich text editor for topic notes.
\n
\n
\n
Focus mode
\n
✔️
\n
Select any topic node as the editor root and only show that branch.
\n
\n
\n
Outliner mode
\n
✔️
\n
Seamlessly switch between mind map and outliner, some outliner's shortcuts are different from mindmap mode.
\n
\n
\n
Search
\n
✔️
\n
Search topic content and navigate to it.
\n
\n
\n
Tags
\n
✔️
\n
Topics can add tags and you can navigate from tags.
\n
\n
\n
Copy topics and paste
\n
on the way
\n
Copy multi topics including all the infomation(content,notes,tags and all attachment) and paste to another location(same document or another document).
\n
\n
\n
Topic reference
\n
on the way
\n
Topics can reference each other and navigate conveniently.
\n
\n
\n
Link curve between any two topics
\n
on the way
\n
Link curve between any two topics
\n
\n
\n
Markdown editor
\n
planing
\n
When editing topic notes, you can choose use rich html editor or markdown editor, for users who familiar and like markdown grammar. Markdown editor will support latex and mermaid.
\n
\n
\n
Manual layout diagram
\n
planing
\n
Manual layout diagram
\n
\n
\n
Cloud Storage
\n
planing
\n
Save and open file from clound storage(icloud/onedrive/google drive).
\nThanks for JetBrains supporting us the free JetBrains Open Source license(s).
\n
",
"readmeOriginal": "
BlinkMindDesktop
\n
BlinkMindDesktop is an open source mind-map and outliner app.
\n
BlinkMindDesktop is an MIT licensed open source project, and the latest version will always be downloadable for free from the GitHub release page. BlinkMindDesktop is still in development.
\n
BlinkMindDesktop uses the open source mind-map library BlinkMind for mind-map rendering.
Set topic style include border, text color, font, background and links.
\n
\n
\n
Customize theme
\n
✔️
\n
Theme editor, import theme, export theme.
\n
\n
\n
Shortcuts
\n
✔️
\n
Shortcuts to make more efficient.
\n
\n
\n
Drag and drop
\n
✔️
\n
Support drag one topic and then drop to another topic to reorganize the mind map.
\n
\n
\n
Open and save file
\n
✔️
\n
Save and open .bmind file, double click file to open.
\n
\n
\n
Export topic to image
\n
✔️
\n
Export topic to png/jpg/svg.
\n
\n
\n
Insert image to topic
\n
✔️
\n
Every topic can insert unlimited images.
\n
\n
\n
Paste rich text to topic
\n
✔️
\n
You can paste rich text from browser/microsoft word/apple pages or anything else to BlinkMind without losing format.
\n
\n
\n
Rich text editor for topic notes
\n
✔️
\n
Rich text editor for topic notes.
\n
\n
\n
Focus mode
\n
✔️
\n
Select any topic node as the editor root and only show that branch.
\n
\n
\n
Outliner mode
\n
✔️
\n
Seamlessly switch between mind map and outliner, some outliner's shortcuts are different from mindmap mode.
\n
\n
\n
Search
\n
✔️
\n
Search topic content and navigate to it.
\n
\n
\n
Tags
\n
✔️
\n
Topics can add tags and you can navigate from tags.
\n
\n
\n
Copy topics and paste
\n
on the way
\n
Copy multi topics including all the infomation(content,notes,tags and all attachment) and paste to another location(same document or another document).
\n
\n
\n
Topic reference
\n
on the way
\n
Topics can reference each other and navigate conveniently.
\n
\n
\n
Link curve between any two topics
\n
on the way
\n
Link curve between any two topics
\n
\n
\n
Markdown editor
\n
planing
\n
When editing topic notes, you can choose use rich html editor or markdown editor, for users who familiar and like markdown grammar. Markdown editor will support latex and mermaid.
\n
\n
\n
Manual layout diagram
\n
planing
\n
Manual layout diagram
\n
\n
\n
Cloud Storage
\n
planing
\n
Save and open file from clound storage(icloud/onedrive/google drive).
Boost Changer is made to control the frequencies of Intel CPUs. It can also manage the processor's energy consumption through Energy-Performance Preference.
\n
In generall this app does not need root rights but when you hit the Turn Off or On button a popup window will ask you about your root password.
\n
why?
\n
\n
In your Kernel there is a file called /sys/devices/system/cpu/intel_pstate/no_turbo.
\n
\n
\n
To turn off or on your turbo boost you have to change this file and that is what this app does.
\n
\n
\n
In your Kernel there is a file called /sys/devices/system/cpu/intel_pstate/max_perf_pct.
\n
\n
\n
when you change the energy performance in Boost Changer you have to change this file and that is what this app does.
\n
\n
📌 This app will only work on a real machine. 📌
\n
What it isn't
\n
This is just a GUI application and it is not meant to replace\nTLP, powertop or\nany other power management / energy consumption service. It is meant just to\nprovide quick access to sysfs settings related to Intel Processors and\nin fact it can run on top of TLP.
# Download the app\nwget https://github.com/nbebaw/boostchanger/releases/download/v4.3.0/boostchanger-4.3.0.AppImage\n\n# Make the app executable \nchmod +x boostchanger-4.3.0.AppImage\n\n# Run the app\n./boostchanger-4.3.0.AppImage
\n
Installation only for Developer
\n
You can help me to improve this app
\n
# Clone this repo\ngit clone https://github.com/nbebaw/boostchanger.git\n\n# Install dependencies\nnpm install\n\n# Run the App\nnpm run
\n
Common Issue for AppImage
\n
The SUID sandbox helper binary was found, but is not configured correctly. Rather than run without sandboxing ...
Boost Changer is made to control the frequencies of Intel CPUs. It can also manage the processor's energy consumption through Energy-Performance Preference.
\n
In generall this app does not need root rights but when you hit the Turn Off or On button a popup window will ask you about your root password.
\n
why?
\n
\n
In your Kernel there is a file called /sys/devices/system/cpu/intel_pstate/no_turbo.
\n
\n
\n
To turn off or on your turbo boost you have to change this file and that is what this app does.
\n
\n
\n
In your Kernel there is a file called /sys/devices/system/cpu/intel_pstate/max_perf_pct.
\n
\n
\n
when you change the energy performance in Boost Changer you have to change this file and that is what this app does.
\n
\n
📌 This app will only work on a real machine. 📌
\n
What it isn't
\n
This is just a GUI application and it is not meant to replace\nTLP, powertop or\nany other power management / energy consumption service. It is meant just to\nprovide quick access to sysfs settings related to Intel Processors and\nin fact it can run on top of TLP.
# Download the app\nwget https://github.com/nbebaw/boostchanger/releases/download/v4.3.0/boostchanger-4.3.0.AppImage\n\n# Make the app executable \nchmod +x boostchanger-4.3.0.AppImage\n\n# Run the app\n./boostchanger-4.3.0.AppImage
\n
Installation only for Developer
\n
You can help me to improve this app
\n
# Clone this repo\ngit clone https://github.com/nbebaw/boostchanger.git\n\n# Install dependencies\nnpm install\n\n# Run the App\nnpm run
\n
Common Issue for AppImage
\n
The SUID sandbox helper binary was found, but is not configured correctly. Rather than run without sandboxing ...
Thank you to all the people who have contributed to Boostnote!
\n
\n
Supporting Boostnote
\n
Boostnote is an open source project. It's an independent project with its ongoing development made possible thanks to the support by our amazing backers.
\n
Issues on Boostnote can be funded by anyone and the money will be distributed to contributors and maintainers. If you use Boostnote please consider becoming a backer:
Thank you to all the people who have contributed to Boostnote!
\n
\n
Supporting Boostnote
\n
Boostnote is an open source project. It's an independent project with its ongoing development made possible thanks to the support by our amazing backers.
\n
Issues on Boostnote can be funded by anyone and the money will be distributed to contributors and maintainers. If you use Boostnote please consider becoming a backer:
Boost Changer is made to control the frequencies of Intel CPUs. It can also manage the processor's energy consumption through Energy-Performance Preference.
\n
In generall this app does not need root rights but when you hit the Turn Off or On button a popup window will ask you about your root password.
\n
why?
\n
\n
In your Kernel there is a file called /sys/devices/system/cpu/intel_pstate/no_turbo.
\n
\n
\n
To turn off or on your turbo boost you have to change this file and that is what this app does.
\n
\n
\n
In your Kernel there is a file called /sys/devices/system/cpu/intel_pstate/max_perf_pct.
\n
\n
\n
when you change the energy performance in Boost Changer you have to change this file and that is what this app does.
\n
\n
📌 This app will only work on a real machine. 📌
\n
What it isn't
\n
This is just a GUI application and it is not meant to replace\nTLP, powertop or\nany other power management / energy consumption service. It is meant just to\nprovide quick access to sysfs settings related to Intel Processors and\nin fact it can run on top of TLP.
# Download the app\nwget https://github.com/nbebaw/boostchanger/releases/download/v4.3.0/boostchanger-4.3.0.AppImage\n\n# Make the app executable \nchmod +x boostchanger-4.3.0.AppImage\n\n# Run the app\n./boostchanger-4.3.0.AppImage
\n
Installation only for Developer
\n
You can help me to improve this app
\n
# Clone this repo\ngit clone https://github.com/nbebaw/boostchanger.git\n\n# Install dependencies\nnpm install\n\n# Run the App\nnpm run
\n
Common Issue for AppImage
\n
The SUID sandbox helper binary was found, but is not configured correctly. Rather than run without sandboxing ...
Boost Changer is made to control the frequencies of Intel CPUs. It can also manage the processor's energy consumption through Energy-Performance Preference.
\n
In generall this app does not need root rights but when you hit the Turn Off or On button a popup window will ask you about your root password.
\n
why?
\n
\n
In your Kernel there is a file called /sys/devices/system/cpu/intel_pstate/no_turbo.
\n
\n
\n
To turn off or on your turbo boost you have to change this file and that is what this app does.
\n
\n
\n
In your Kernel there is a file called /sys/devices/system/cpu/intel_pstate/max_perf_pct.
\n
\n
\n
when you change the energy performance in Boost Changer you have to change this file and that is what this app does.
\n
\n
📌 This app will only work on a real machine. 📌
\n
What it isn't
\n
This is just a GUI application and it is not meant to replace\nTLP, powertop or\nany other power management / energy consumption service. It is meant just to\nprovide quick access to sysfs settings related to Intel Processors and\nin fact it can run on top of TLP.
# Download the app\nwget https://github.com/nbebaw/boostchanger/releases/download/v4.3.0/boostchanger-4.3.0.AppImage\n\n# Make the app executable \nchmod +x boostchanger-4.3.0.AppImage\n\n# Run the app\n./boostchanger-4.3.0.AppImage
\n
Installation only for Developer
\n
You can help me to improve this app
\n
# Clone this repo\ngit clone https://github.com/nbebaw/boostchanger.git\n\n# Install dependencies\nnpm install\n\n# Run the App\nnpm run
\n
Common Issue for AppImage
\n
The SUID sandbox helper binary was found, but is not configured correctly. Rather than run without sandboxing ...
BrowserDispatcher.app decides which browser to use when you click on a link outside of your web browser.\nBased on your settings, it will display a prompt allowing you to select from a list of browsers or automatically select a browser to open a link with.
\n
\n
Downloads
\n
To download the latest release, see releases page (macOS only).
\n
Note: the application is not signed by Apple Developer ID.\nBy default, Mac OS will not open an app from an unidentified developer.
\n
In the Finder, locate BrowserDispatcher.app and Control-click the app icon, then choose Open from the shortcut menu.\nMake BrowserDispatcher.app default web browser. You can use the app menu Preferences > Make default browser or go to System Preferences > General > Default web browser.
\n
The application is an agent app, that is, menu bar app that does not appear in the Dock or Force Quit window.
\n
Running from source
\n
You'll need certain packages installed before you can build and run Browser Dispatcher locally.
See also the list of contributors who participated in this project.
\n
License
\n
This project is licensed under the MIT License - see the LICENSE file for details.
\n
",
"readmeOriginal": "
\n
Browser Dispatcher
\n
BrowserDispatcher.app decides which browser to use when you click on a link outside of your web browser.\nBased on your settings, it will display a prompt allowing you to select from a list of browsers or automatically select a browser to open a link with.
\n
\n
Downloads
\n
To download the latest release, see releases page (macOS only).
\n
Note: the application is not signed by Apple Developer ID.\nBy default, Mac OS will not open an app from an unidentified developer.
\n
In the Finder, locate BrowserDispatcher.app and Control-click the app icon, then choose Open from the shortcut menu.\nMake BrowserDispatcher.app default web browser. You can use the app menu Preferences > Make default browser or go to System Preferences > General > Default web browser.
\n
The application is an agent app, that is, menu bar app that does not appear in the Dock or Force Quit window.
\n
Running from source
\n
You'll need certain packages installed before you can build and run Browser Dispatcher locally.
If you enjoy using Browserosaurus, please consider supporting its continued\ndevelopment.
\n
Browserosaurus is an open-source (MIT license), Electron-based browser prompter\nfor macOS. It works by setting itself as the default browser; any clicked links\nin non-browser apps are now sent to Browserosaurus where it’ll present you with\na menu of all your installed browsers. You may now decide which browser you’d\nlike to continue opening the link with.
To build an icns file (app icon) from src/shared/static/icon/icon.png, simply\nrun npm run icns.
\n
Publishing
\n
App is published on GitHub, the following command will prompt to bump version\nnumber, package, notarize, and make installers:
\n
npm run release\n
\n
The dmg and zip files can then be added to a GitHub release.
\n
",
"readmeOriginal": "
\n
Browserosaurus
\n
If you enjoy using Browserosaurus, please consider supporting its continued\ndevelopment.
\n
Browserosaurus is an open-source (MIT license), Electron-based browser prompter\nfor macOS. It works by setting itself as the default browser; any clicked links\nin non-browser apps are now sent to Browserosaurus where it’ll present you with\na menu of all your installed browsers. You may now decide which browser you’d\nlike to continue opening the link with.
A simple electron app designed to help tracking your income and expenses.\nIt is written with electron and OpenUI5.
\n
Any feature requests or bug reports are welcome, do not hesitate 😀
\n
Download
\n
Download the latest version from here.\nCurrently only macOS and Windows are supported.
\n
Get the mobile webapp here.\nAndroid & iOS are supported.
\n
Features
\n
\n
manage your income and expenses in a safe environment
\n
all data (except for the transactions created via the app & your categories) is stored locally on your device.
\n
compare different months and years to gain insight into your spending behaviour
\n
see in which areas you spend most of your money and in which you have the highest incomes.
\n
track them anywhere using the responsive mobile app
\n
enjoy the dark side with the new dark mode
\n
support for popular currencies
\n
\n
Mobile app sync
\n
With the new app sync, you can now create transactions while not having access to the desktop app. Once you open the desktop app again, you can sign-in and synchronize your transactions. The mobile webapp is available here. Don't forget to add it to your home screen 😄
\n
Getting started
\n
The app helps in several ways to track and manage your income and expenses.\nThis begins with the initial setup:
\n
\n
Here you have to decide wether to start fresh or from a previously exported BudgetP save file. These save files can be created at any time manually.
\n
The next step is adding some transactions. Here BudgetP differentiates between income and expenses. Both are saved as a transaction:
\n
\n
After having saved your transactions, the charts start to fill themselves from the entered data. BudgetP currently offers two break downs, by category and over time:
\n
\n
\n
You can gain further insight by filtering your list using the search. You can enter free text oder search against any of the categories you have created. Besides that you can check on a monthly or yearly level and using the charts compare the results with the previous year or month.
\n
If you want to backup your saved transactions, you can hit the export button on the top right. It is going to promt you to select a location for your save file. After the export the save file can then be loaded again, when initially opening the app for the first time (i.e. on a new computer). In the future it is algo going to be possible to alyway save to an external file, so you can easily share it between devices with a service like OneDrive or Google Drive.
\n
\n
Contributing
\n
Local Development
\n\n
Link the kellojo.m library:\ncd lib/kellojo.m sudo npm link cd .. cd .. npm link kellojo.m
\n
Install the development dependencies\nnpm install -only=dev
\n\n
",
"readmeOriginal": "
Budget-Book
\n
A simple electron app designed to help tracking your income and expenses.\nIt is written with electron and OpenUI5.
\n
Any feature requests or bug reports are welcome, do not hesitate 😀
\n
Download
\n
Download the latest version from here.\nCurrently only macOS and Windows are supported.
\n
Get the mobile webapp here.\nAndroid & iOS are supported.
\n
Features
\n
\n
manage your income and expenses in a safe environment
\n
all data (except for the transactions created via the app & your categories) is stored locally on your device.
\n
compare different months and years to gain insight into your spending behaviour
\n
see in which areas you spend most of your money and in which you have the highest incomes.
\n
track them anywhere using the responsive mobile app
\n
enjoy the dark side with the new dark mode
\n
support for popular currencies
\n
\n
Mobile app sync
\n
With the new app sync, you can now create transactions while not having access to the desktop app. Once you open the desktop app again, you can sign-in and synchronize your transactions. The mobile webapp is available here. Don't forget to add it to your home screen 😄
\n
Getting started
\n
The app helps in several ways to track and manage your income and expenses.\nThis begins with the initial setup:
\n
\n
Here you have to decide wether to start fresh or from a previously exported BudgetP save file. These save files can be created at any time manually.
\n
The next step is adding some transactions. Here BudgetP differentiates between income and expenses. Both are saved as a transaction:
\n
\n
After having saved your transactions, the charts start to fill themselves from the entered data. BudgetP currently offers two break downs, by category and over time:
\n
\n
\n
You can gain further insight by filtering your list using the search. You can enter free text oder search against any of the categories you have created. Besides that you can check on a monthly or yearly level and using the charts compare the results with the previous year or month.
\n
If you want to backup your saved transactions, you can hit the export button on the top right. It is going to promt you to select a location for your save file. After the export the save file can then be loaded again, when initially opening the app for the first time (i.e. on a new computer). In the future it is algo going to be possible to alyway save to an external file, so you can easily share it between devices with a service like OneDrive or Google Drive.
\n
\n
Contributing
\n
Local Development
\n\n
Link the kellojo.m library:\ncd lib/kellojo.m sudo npm link cd .. cd .. npm link kellojo.m
\n
Install the development dependencies\nnpm install -only=dev
Buka is a modern software that helps you manage your ebook at ease. With a simple, clean and straight-forward user interface, Buka aims to gather your ebooks for a reading experience without hassles. Buka currently support .PDF format with configurations that helps user focus more on the content.
Run sudo dpkg --install Buka_1.0.0_amd64.deb on the downloaded package.
\n
Launch Buka using the installed Buka command.
\n\n
\n
Of course you can always open .deb package with a package manager like Synaptic, Gnome Software or Gdebi then start the app instead of using command line options.
Run sudo dpkg -r Buka or sudo apt remove --purge buka
\n
\n
Screenshots
\n
\n
\n
\n
\n
\n
Contributors
\n
Code Contributors
\n
This project exists thanks to all the people who contribute. [Contribute].\n
\n
Financial Contributors
\n
Become a financial contributor and help us sustain our community. [Contribute]
\n
Individuals
\n
\n
Organizations
\n
Support this project with your organization. Your logo will show up here with a link to your website. [Contribute]
\n
\n\n\n\n\n\n\n\n\n
\n
",
"readmeOriginal": "
\n \n
\n
\n Buka - EBook Management\n
\n
\n \n
\n\n
About Buka
\n
Buka is a modern software that helps you manage your ebook at ease. With a simple, clean and straight-forward user interface, Buka aims to gather your ebooks for a reading experience without hassles. Buka currently support .PDF format with configurations that helps user focus more on the content.
Run sudo dpkg --install Buka_1.0.0_amd64.deb on the downloaded package.
\n
Launch Buka using the installed Buka command.
\n\n
\n
Of course you can always open .deb package with a package manager like Synaptic, Gnome Software or Gdebi then start the app instead of using command line options.
There is also a Nightly build which is built automatically every night and contains the latest experimental changes and features. Only use this if you want to test new features and are okay with potential errors.
Replace the $AURHELPER section with your AUR helper command.
\n
$AURHELPER -S bunq-desktop-bin
\n
Features
\n
\n
View all your accounts and payments
\n
Send new payments to other users
\n
Accept and decline requests
\n
Create and view bunq.me requests
\n
Custom categories to group events
\n
View and manage your cards
\n
Statistics page
\n
Encrypted storage on your device
\n
Available on Windows, Linux and Mac
\n
\n
Keybinds
\n
\n
CTRL/CMD + Q : Closes the application
\n
CTRL/CMD + U : Runs the background sync process
\n
CTRL/CMD + H : Toggles the account balance visibility
\n
CTRL/CMD + T : Toggles between the light and dark theme
\n
CTRL/CMD + D : Dashboard
\n
CTRL/CMD + P : Payment page
\n
CTRL/CMD + R : Request page
\n
ALT + C : Cards page
\n
ALT + S : Settings page
\n
\n
Translations
\n
The app is developed in English but translations in Dutch and German are available.\nIf you spot errors, possible improvements or want to help us translate the desktop app to a different language let us know or suggest a change on Crowdin!
\n
Security
\n
All sensitive data is encrypted with the password that is entered on startup. You can choose to skip this step which will encrypt the data with a default password so that you will be logged in without asking you for a password.
\n
The bunqDesktop settings, custom categories and category rules are not stored using encryption. This data is stored separately so it can be synced more easily across multiple devices.
\n
Check out the settings page to see where this information is stored and to change this location if you'd like to move it. You can easily use services like Google Drive, iCloud Drive, Dropbox and other software to sync the settings file to always have the same categories and settings across your devices.
\n
Privacy
\n
At no point is your API key, session information or other data directly sent to other servers or systems. All requests to the bunq API are done directly from the bunqDesktop client to the bunq servers.
\n
We use Google Analytics with minimal settings (Source code) to check\nwhich version of the application is used and other basic information like system language, OS version and country.\nYour IP address is anonymized using IP Anonymization in Analytics.\nGoogle Analytics can be disabled on the settings page whenever you want.
\n
Development
\n
We use yarn for package management and the following global packages:
There is also a Nightly build which is built automatically every night and contains the latest experimental changes and features. Only use this if you want to test new features and are okay with potential errors.
Replace the $AURHELPER section with your AUR helper command.
\n
$AURHELPER -S bunq-desktop-bin
\n
Features
\n
\n
View all your accounts and payments
\n
Send new payments to other users
\n
Accept and decline requests
\n
Create and view bunq.me requests
\n
Custom categories to group events
\n
View and manage your cards
\n
Statistics page
\n
Encrypted storage on your device
\n
Available on Windows, Linux and Mac
\n
\n
Keybinds
\n
\n
CTRL/CMD + Q : Closes the application
\n
CTRL/CMD + U : Runs the background sync process
\n
CTRL/CMD + H : Toggles the account balance visibility
\n
CTRL/CMD + T : Toggles between the light and dark theme
\n
CTRL/CMD + D : Dashboard
\n
CTRL/CMD + P : Payment page
\n
CTRL/CMD + R : Request page
\n
ALT + C : Cards page
\n
ALT + S : Settings page
\n
\n
Translations
\n
The app is developed in English but translations in Dutch and German are available.\nIf you spot errors, possible improvements or want to help us translate the desktop app to a different language let us know or suggest a change on Crowdin!
\n
Security
\n
All sensitive data is encrypted with the password that is entered on startup. You can choose to skip this step which will encrypt the data with a default password so that you will be logged in without asking you for a password.
\n
The bunqDesktop settings, custom categories and category rules are not stored using encryption. This data is stored separately so it can be synced more easily across multiple devices.
\n
Check out the settings page to see where this information is stored and to change this location if you'd like to move it. You can easily use services like Google Drive, iCloud Drive, Dropbox and other software to sync the settings file to always have the same categories and settings across your devices.
\n
Privacy
\n
At no point is your API key, session information or other data directly sent to other servers or systems. All requests to the bunq API are done directly from the bunqDesktop client to the bunq servers.
\n
We use Google Analytics with minimal settings (Source code) to check\nwhich version of the application is used and other basic information like system language, OS version and country.\nYour IP address is anonymized using IP Anonymization in Analytics.\nGoogle Analytics can be disabled on the settings page whenever you want.
\n
Development
\n
We use yarn for package management and the following global packages:
Brim is an open source desktop application for security and network\nspecialists. Brim makes it easy to search and analyze data from:
\n
\n
packet captures, like those created by Wireshark, and
\n
structured logs, especially from the Zeek network analysis framework.
\n
\n
Brim is especially useful to security and network operators that need to handle large packet captures,\nespecially those that are cumbersome for Wireshark, tshark, or other packet analyzers.
\n
\n
Brim is built from open source components, including:
Please browse the wiki to review common problems and helpful tips before opening an issue.
\n
Development and contributing
\n
We'd love your help! Please see the contributing guide for\ndevelopment information like building and testing Brim.
\n
Join the Community
\n
Join our Public Slack workspace for announcements, Q&A, and to trade tips!
\n
",
"readmeOriginal": "
\n
Brim
\n
Brim is an open source desktop application for security and network\nspecialists. Brim makes it easy to search and analyze data from:
\n
\n
packet captures, like those created by Wireshark, and
\n
structured logs, especially from the Zeek network analysis framework.
\n
\n
Brim is especially useful to security and network operators that need to handle large packet captures,\nespecially those that are cumbersome for Wireshark, tshark, or other packet analyzers.
\n
\n
Brim is built from open source components, including:
Buttercup is a free, open-source and cross-platform password manager, built on NodeJS with Typescript. It uses strong industry-standard encryption to protect your passwords and credentials (among other data you store in Buttercup vaults) at rest, within vault files (.bcup). Vaults can be loaded from and saved to a number of sources, such as the local filesystem, Dropbox, Google Drive or any WebDAV-enabled service (like ownCloud or Nextcloud ¹).
\n
Why you need a password manager
\n
Password management is a crucial tool when you have any online presence. It's vital that all of your accounts online use strong and unique passwords so that they're much more difficult to break in to. Even if one of your accounts are breached, having unique passwords means that the likelihood of the attacker gaining further access to your accounts portfolio is greatly reduced.
\n
Without a password manager, such as Buttercup, it would be very tedious to manage different passwords for each service. If you remember your passwords it's a good sign that they're not strong enough. Ideally you should memorise a primary password for your vault, and not know any of the account-specific passwords off the top of your head.
\n
Precautions
\n
Buttercup securely encrypts your data in protected files, but this security is only as strong as the weakest component - and this is very often the primary password used to lock and unlock your vault. Follow these basic guidelines to ensure that your vault is safe even if exposed:
\n
\n
Choose a unique password that is not used elsewhere
\n
Use a highly-varied set of different characters - such as alpha-numeric, symbols and spaces
\n
Use a long password - the longer the better
\n
Don't include words or names in the password
\n
Never share your password with anyone
\n
\n
It is very important to note that no one associated with Buttercup will ever request your personal vault or its primary password. Do not share it or any of its related details with anyone. Developers or contributors working with Buttercup may request example vaults created via your system to try and reproduce issues, but please ensure to never use your real password or store actual credentails within such vaults.
\n
Versions
\n
The current stable version is 2. We recommend upgrading if you're still on v1, as it is no longer being actively maintained. You can still browse the v1 source and documentation here.
\n
Operating Systems
\n
Buttercup Desktop is officially supported on:
\n
\n
Most linux distributions (x64), such as Ubuntu
\n
MacOS (x64, non-ARM)
\n
Windows 10 (x64)
\n
\n
Arch Linux
\n
Buttercup is also available for Arch via the AUR. This release channel is maintained by our community.
\n
Some Arch users have reported the occasional segfault - if you experience this please try this solution before creating an issue.
\n
32bit builds (x86)
\n
There are some 32bit builds available, but please note that these are not officially supported. Issues, bug reports and questions regarding 32bit binaries are not allowed and will be closed without notice. PRs to fix 32bit support are permitted.
\n
Portability
\n
Buttercup provides a portable Windows version. Look for the release with the name Buttercup-win-x64-2.0.0-portable.exe where 2.0.0 is the version and x64 is the architecture.
\n
Although not explicitly portable, both the Mac zip and Linux AppImage formats are more or less standalone. They still write to the standard config/log destinations, however.
\n
To make the most of the portable version, some enviroment variables are required:
\n
\n\n
\n
Enviroment Variables
\n
Description
\n
\n\n\n
\n
BUTTERCUP_HOME_DIR
\n
If provided buttercup will use this path for saving configrations , user settings or even temprorary files
\n
\n
\n
BUTTERCUP_CONFIG_DIR
\n
Stores user settings, not allways needed but can be used to change config location or will default to BUTTERCUP_HOME_DIR Optional: Only activates if BUTTERCUP_HOME_DIR is provided
\n
\n
\n
BUTTERCUP_TEMP_DIR
\n
Same as BUTTERCUP_CONFIG_DIR but stores temprory filesOptional: Only activates if BUTTERCUP_HOME_DIR is provided
\n
\n\n
\n
Sample ButtercupLauncher.bat for Windows portable executable
\n
\n
This example stores user settings and cache on the portable folder, but stores temprory files on the host PC.
Linux: ~/.local/state/Buttercup-nodejs or $XDG_STATE_HOME/Buttercup-nodejs
\n
Mac: ~/Library/Logs/Buttercup-nodejs
\n
Windows: %LOCALAPPDATA%\\Buttercup-nodejs\\Log
\n
\n
Note that logs for portable Windows applications will be written to the same directory that the executable resides in.
\n
Published Applications
\n
You can view the current releases on the Buttercup Desktop releases page. Under each release are some assets - the various binaries and installers for each platform Buttercup supports. When installing or downloading, make sure to pick the right operating system and architecture for your machine.
\n
Note that at this time, Buttercup only supports x64 (64 bit) machines.
\n
Linux
\n
We provide an AppImage build for Linux, because it is the most desirable format for us to release. AppImages support auto-updating, a crucial feature (we feel) for a security application. The other build types do not.
\n
Important: Buttercup uses Electron to build its desktop application, which relies on AppImageLauncher for correct integration of AppImages into the host OS. Features like Google Drive authentication and correct .desktop icon use is only performed when integrating via AppImageLauncher. We highly recommend that you install it.
\n
We won't be supporting formats like Snapcraft, deb or rpm images as they do not align with our requirements. Issues requesting these formats will be closed immediately. Discussion on topics like this should be started on other social channels.
\n
Development
\n
To begin developing features or bug-fixes for Buttercup Desktop, make sure that you first have Node v14 installed with a current version of NPM.
\n
Once cloned, make sure to install all dependencies: npm install. After that, open 2 terminals and run npm run start:renderer in one and npm run start:main in the other.
\n
Contributing
\n
There are a number of ways you can contribute to Buttercup!
\n
Features & Bug fixes
\n
We welcome pull-requests and issues that serve to better Buttercup as a platform. Please remain respecful (this is free & open source after all) with your ideas and observations, and always consider opening an issue before starting on a substantial pull request.
\n
Translations
\n
Buttercup relies on the community for translating its interfaces into languages besides English. We use British English (en_GB) as the base language, and translate into all others that our contributors are kind enough to provide.
\n
To add support for a language, make sure to add the translations for our vault UI first. After that, you can follow these instructions to add another language to the desktop application:
\n
\n
Copy the source/shared/i18n/translations/en.json file to the language code you're providing (eg. fi.json for Finnish).
\n
Edit the source/shared/i18n/translations/index.ts file and:\n
\n
Import the new JSON file: import fi from \"./fi.json\";.
\n
Export the imported constant inside the default export already in that file.
\n
\n
\n
\n
Contributions
\n
This project exists thanks to all the people who contribute. [Contribute].\n
Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [Become a sponsor]
\n
\n\n\n\n\n\n\n\n\n
\n
Notes and Caveats
\n
\n
¹ External services like Nextcloud and ownCloud must be configured correctly to support access via the web (using WebDAV). CORS must permit access from any source.
\n
² Buttercup (including MadDev Oy) is not affiliated with any of the companies represented in screenshots or preview images.
\n
\n
",
"readmeOriginal": "
Buttercup Desktop
\n
\n
Buttercup for Desktop - Mac, Linux and Windows
\n
\n
\n
²
\n
About
\n
Buttercup is a free, open-source and cross-platform password manager, built on NodeJS with Typescript. It uses strong industry-standard encryption to protect your passwords and credentials (among other data you store in Buttercup vaults) at rest, within vault files (.bcup). Vaults can be loaded from and saved to a number of sources, such as the local filesystem, Dropbox, Google Drive or any WebDAV-enabled service (like ownCloud or Nextcloud ¹).
\n
Why you need a password manager
\n
Password management is a crucial tool when you have any online presence. It's vital that all of your accounts online use strong and unique passwords so that they're much more difficult to break in to. Even if one of your accounts are breached, having unique passwords means that the likelihood of the attacker gaining further access to your accounts portfolio is greatly reduced.
\n
Without a password manager, such as Buttercup, it would be very tedious to manage different passwords for each service. If you remember your passwords it's a good sign that they're not strong enough. Ideally you should memorise a primary password for your vault, and not know any of the account-specific passwords off the top of your head.
\n
Precautions
\n
Buttercup securely encrypts your data in protected files, but this security is only as strong as the weakest component - and this is very often the primary password used to lock and unlock your vault. Follow these basic guidelines to ensure that your vault is safe even if exposed:
\n
\n
Choose a unique password that is not used elsewhere
\n
Use a highly-varied set of different characters - such as alpha-numeric, symbols and spaces
\n
Use a long password - the longer the better
\n
Don't include words or names in the password
\n
Never share your password with anyone
\n
\n
It is very important to note that no one associated with Buttercup will ever request your personal vault or its primary password. Do not share it or any of its related details with anyone. Developers or contributors working with Buttercup may request example vaults created via your system to try and reproduce issues, but please ensure to never use your real password or store actual credentails within such vaults.
\n
Versions
\n
The current stable version is 2. We recommend upgrading if you're still on v1, as it is no longer being actively maintained. You can still browse the v1 source and documentation here.
\n
Operating Systems
\n
Buttercup Desktop is officially supported on:
\n
\n
Most linux distributions (x64), such as Ubuntu
\n
MacOS (x64, non-ARM)
\n
Windows 10 (x64)
\n
\n
Arch Linux
\n
Buttercup is also available for Arch via the AUR. This release channel is maintained by our community.
\n
Some Arch users have reported the occasional segfault - if you experience this please try this solution before creating an issue.
\n
32bit builds (x86)
\n
There are some 32bit builds available, but please note that these are not officially supported. Issues, bug reports and questions regarding 32bit binaries are not allowed and will be closed without notice. PRs to fix 32bit support are permitted.
\n
Portability
\n
Buttercup provides a portable Windows version. Look for the release with the name Buttercup-win-x64-2.0.0-portable.exe where 2.0.0 is the version and x64 is the architecture.
\n
Although not explicitly portable, both the Mac zip and Linux AppImage formats are more or less standalone. They still write to the standard config/log destinations, however.
\n
To make the most of the portable version, some enviroment variables are required:
\n
\n\n
\n
Enviroment Variables
\n
Description
\n
\n\n\n
\n
BUTTERCUP_HOME_DIR
\n
If provided buttercup will use this path for saving configrations , user settings or even temprorary files
\n
\n
\n
BUTTERCUP_CONFIG_DIR
\n
Stores user settings, not allways needed but can be used to change config location or will default to BUTTERCUP_HOME_DIR Optional: Only activates if BUTTERCUP_HOME_DIR is provided
\n
\n
\n
BUTTERCUP_TEMP_DIR
\n
Same as BUTTERCUP_CONFIG_DIR but stores temprory filesOptional: Only activates if BUTTERCUP_HOME_DIR is provided
\n
\n\n
\n
Sample ButtercupLauncher.bat for Windows portable executable
\n
\n
This example stores user settings and cache on the portable folder, but stores temprory files on the host PC.
Linux: ~/.local/state/Buttercup-nodejs or $XDG_STATE_HOME/Buttercup-nodejs
\n
Mac: ~/Library/Logs/Buttercup-nodejs
\n
Windows: %LOCALAPPDATA%\\Buttercup-nodejs\\Log
\n
\n
Note that logs for portable Windows applications will be written to the same directory that the executable resides in.
\n
Published Applications
\n
You can view the current releases on the Buttercup Desktop releases page. Under each release are some assets - the various binaries and installers for each platform Buttercup supports. When installing or downloading, make sure to pick the right operating system and architecture for your machine.
\n
Note that at this time, Buttercup only supports x64 (64 bit) machines.
\n
Linux
\n
We provide an AppImage build for Linux, because it is the most desirable format for us to release. AppImages support auto-updating, a crucial feature (we feel) for a security application. The other build types do not.
\n
Important: Buttercup uses Electron to build its desktop application, which relies on AppImageLauncher for correct integration of AppImages into the host OS. Features like Google Drive authentication and correct .desktop icon use is only performed when integrating via AppImageLauncher. We highly recommend that you install it.
\n
We won't be supporting formats like Snapcraft, deb or rpm images as they do not align with our requirements. Issues requesting these formats will be closed immediately. Discussion on topics like this should be started on other social channels.
\n
Development
\n
To begin developing features or bug-fixes for Buttercup Desktop, make sure that you first have Node v14 installed with a current version of NPM.
\n
Once cloned, make sure to install all dependencies: npm install. After that, open 2 terminals and run npm run start:renderer in one and npm run start:main in the other.
\n
Contributing
\n
There are a number of ways you can contribute to Buttercup!
\n
Features & Bug fixes
\n
We welcome pull-requests and issues that serve to better Buttercup as a platform. Please remain respecful (this is free & open source after all) with your ideas and observations, and always consider opening an issue before starting on a substantial pull request.
\n
Translations
\n
Buttercup relies on the community for translating its interfaces into languages besides English. We use British English (en_GB) as the base language, and translate into all others that our contributors are kind enough to provide.
\n
To add support for a language, make sure to add the translations for our vault UI first. After that, you can follow these instructions to add another language to the desktop application:
\n
\n
Copy the source/shared/i18n/translations/en.json file to the language code you're providing (eg. fi.json for Finnish).
\n
Edit the source/shared/i18n/translations/index.ts file and:\n
\n
Import the new JSON file: import fi from \"./fi.json\";.
\n
Export the imported constant inside the default export already in that file.
\n
\n
\n
\n
Contributions
\n
This project exists thanks to all the people who contribute. [Contribute].\n
Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [Become a sponsor]
\n
\n\n\n\n\n\n\n\n\n
\n
Notes and Caveats
\n
\n
¹ External services like Nextcloud and ownCloud must be configured correctly to support access via the web (using WebDAV). CORS must permit access from any source.
\n
² Buttercup (including MadDev Oy) is not affiliated with any of the companies represented in screenshots or preview images.
There is also a Nightly build which is built automatically every night and contains the latest experimental changes and features. Only use this if you want to test new features and are okay with potential errors.
Replace the $AURHELPER section with your AUR helper command.
\n
$AURHELPER -S bunq-desktop-bin
\n
Features
\n
\n
View all your accounts and payments
\n
Send new payments to other users
\n
Accept and decline requests
\n
Create and view bunq.me requests
\n
Custom categories to group events
\n
View and manage your cards
\n
Statistics page
\n
Encrypted storage on your device
\n
Available on Windows, Linux and Mac
\n
\n
Keybinds
\n
\n
CTRL/CMD + Q : Closes the application
\n
CTRL/CMD + U : Runs the background sync process
\n
CTRL/CMD + H : Toggles the account balance visibility
\n
CTRL/CMD + T : Toggles between the light and dark theme
\n
CTRL/CMD + D : Dashboard
\n
CTRL/CMD + P : Payment page
\n
CTRL/CMD + R : Request page
\n
ALT + C : Cards page
\n
ALT + S : Settings page
\n
\n
Translations
\n
The app is developed in English but translations in Dutch and German are available.\nIf you spot errors, possible improvements or want to help us translate the desktop app to a different language let us know or suggest a change on Crowdin!
\n
Security
\n
All sensitive data is encrypted with the password that is entered on startup. You can choose to skip this step which will encrypt the data with a default password so that you will be logged in without asking you for a password.
\n
The bunqDesktop settings, custom categories and category rules are not stored using encryption. This data is stored separately so it can be synced more easily across multiple devices.
\n
Check out the settings page to see where this information is stored and to change this location if you'd like to move it. You can easily use services like Google Drive, iCloud Drive, Dropbox and other software to sync the settings file to always have the same categories and settings across your devices.
\n
Privacy
\n
At no point is your API key, session information or other data directly sent to other servers or systems. All requests to the bunq API are done directly from the bunqDesktop client to the bunq servers.
\n
We use Google Analytics with minimal settings (Source code) to check\nwhich version of the application is used and other basic information like system language, OS version and country.\nYour IP address is anonymized using IP Anonymization in Analytics.\nGoogle Analytics can be disabled on the settings page whenever you want.
\n
Development
\n
We use yarn for package management and the following global packages:
There is also a Nightly build which is built automatically every night and contains the latest experimental changes and features. Only use this if you want to test new features and are okay with potential errors.
Replace the $AURHELPER section with your AUR helper command.
\n
$AURHELPER -S bunq-desktop-bin
\n
Features
\n
\n
View all your accounts and payments
\n
Send new payments to other users
\n
Accept and decline requests
\n
Create and view bunq.me requests
\n
Custom categories to group events
\n
View and manage your cards
\n
Statistics page
\n
Encrypted storage on your device
\n
Available on Windows, Linux and Mac
\n
\n
Keybinds
\n
\n
CTRL/CMD + Q : Closes the application
\n
CTRL/CMD + U : Runs the background sync process
\n
CTRL/CMD + H : Toggles the account balance visibility
\n
CTRL/CMD + T : Toggles between the light and dark theme
\n
CTRL/CMD + D : Dashboard
\n
CTRL/CMD + P : Payment page
\n
CTRL/CMD + R : Request page
\n
ALT + C : Cards page
\n
ALT + S : Settings page
\n
\n
Translations
\n
The app is developed in English but translations in Dutch and German are available.\nIf you spot errors, possible improvements or want to help us translate the desktop app to a different language let us know or suggest a change on Crowdin!
\n
Security
\n
All sensitive data is encrypted with the password that is entered on startup. You can choose to skip this step which will encrypt the data with a default password so that you will be logged in without asking you for a password.
\n
The bunqDesktop settings, custom categories and category rules are not stored using encryption. This data is stored separately so it can be synced more easily across multiple devices.
\n
Check out the settings page to see where this information is stored and to change this location if you'd like to move it. You can easily use services like Google Drive, iCloud Drive, Dropbox and other software to sync the settings file to always have the same categories and settings across your devices.
\n
Privacy
\n
At no point is your API key, session information or other data directly sent to other servers or systems. All requests to the bunq API are done directly from the bunqDesktop client to the bunq servers.
\n
We use Google Analytics with minimal settings (Source code) to check\nwhich version of the application is used and other basic information like system language, OS version and country.\nYour IP address is anonymized using IP Anonymization in Analytics.\nGoogle Analytics can be disabled on the settings page whenever you want.
\n
Development
\n
We use yarn for package management and the following global packages:
I'm in need of someone to pass the mantle to. I'd love for this project to keep going, but I'm not currently able to give this the attention it deserves. I'm willing to help out and ease the transition to whoever wants to take it over.
\n
Introduction
\n
When using Canvas, I found that constantly downloading new files, updated files and then organizing those files was a huge pain. This program aims to work by having Google Drive like functionality with Canvas so that you never have to worry about being up to date or how you have organized things, because they will be organized on your computer just as they are organized on Canvas.
Clone this repository and run yarn. Once it's done installing the modules, run yarn run dev
\n
Building this code
\n
yarn run build:mac
\n
yarn run build:win
\n
Note
\n
Releases are being code signed so your personal build will not work with the built in autoupdating.
\n
Contributing
\n
I'd appreciate any help that anyone would like to give and have included draw.io diagrams in the diagrams folder to help facilitate understanding of the overall flow.
\n
TODO
\n
\n
Toggle courses to sync
\n
Increase initial download speed
\n
Handle situations more gracefully where an update has occurred both locally and remotely
\n
Allow more granular control of what to sync(Treeview)
I'm in need of someone to pass the mantle to. I'd love for this project to keep going, but I'm not currently able to give this the attention it deserves. I'm willing to help out and ease the transition to whoever wants to take it over.
\n
Introduction
\n
When using Canvas, I found that constantly downloading new files, updated files and then organizing those files was a huge pain. This program aims to work by having Google Drive like functionality with Canvas so that you never have to worry about being up to date or how you have organized things, because they will be organized on your computer just as they are organized on Canvas.
Clone this repository and run yarn. Once it's done installing the modules, run yarn run dev
\n
Building this code
\n
yarn run build:mac
\n
yarn run build:win
\n
Note
\n
Releases are being code signed so your personal build will not work with the built in autoupdating.
\n
Contributing
\n
I'd appreciate any help that anyone would like to give and have included draw.io diagrams in the diagrams folder to help facilitate understanding of the overall flow.
\n
TODO
\n
\n
Toggle courses to sync
\n
Increase initial download speed
\n
Handle situations more gracefully where an update has occurred both locally and remotely
\n
Allow more granular control of what to sync(Treeview)
Build the app in a Posix environment. On Windows that is Git Bash or WSL. Make sure you have installed all the necessary tools to install and compile Node.js C++ addons.
\n
# checkout a tag\ngit checkout v1.1.0\n\n# install dependencies\nnpm install\n\n# execute all checks (lint, test and build)\nnpm run all\n\n# build the application to ./dist\nnpm run build
\n
Development Setup
\n
Spin up the application for development, all strings attached:
Build the app in a Posix environment. On Windows that is Git Bash or WSL. Make sure you have installed all the necessary tools to install and compile Node.js C++ addons.
\n
# checkout a tag\ngit checkout v1.1.0\n\n# install dependencies\nnpm install\n\n# execute all checks (lint, test and build)\nnpm run all\n\n# build the application to ./dist\nnpm run build
\n
Development Setup
\n
Spin up the application for development, all strings attached:
Caption takes the effort out of finding and setting up the right subtitles. A simple design, drag & drop search, and automatic downloading & renaming let you just start watching. Caption is multi-platform, open-source, and built entirely on web technology.
Caption is completely open-source. We've tried to make it as easy as possible to\ncontribute. If you'd like to help out by adding features, working on bug fixes,\nor assisting in other parts of development, here's how to get started:
Clone it to your\nlocal device: git clone git@github.com:gielcobben/caption.git
\n
Install the dependencies: npm install
\n
Run the app by starting electron, building the code and watch for changes:\nnpm start\n
To build for production (should not generally be used):
\n
\n
Build the actual app for all platforms (Mac, Windows and Linux): npm run dist
\n\n \n
📦 Sources
\n
Caption currently uses 2 sources to gather subtitles. We're continuously adding\nsources, but the app's open-source nature also allows you to add your own when\ndesired. This can be done in\nCaption Core.
Caption takes the effort out of finding and setting up the right subtitles. A simple design, drag & drop search, and automatic downloading & renaming let you just start watching. Caption is multi-platform, open-source, and built entirely on web technology.
Caption is completely open-source. We've tried to make it as easy as possible to\ncontribute. If you'd like to help out by adding features, working on bug fixes,\nor assisting in other parts of development, here's how to get started:
Clone it to your\nlocal device: git clone git@github.com:gielcobben/caption.git
\n
Install the dependencies: npm install
\n
Run the app by starting electron, building the code and watch for changes:\nnpm start\n
To build for production (should not generally be used):
\n
\n
Build the actual app for all platforms (Mac, Windows and Linux): npm run dist
\n\n \n
📦 Sources
\n
Caption currently uses 2 sources to gather subtitles. We're continuously adding\nsources, but the app's open-source nature also allows you to add your own when\ndesired. This can be done in\nCaption Core.
Take decisions based on visual feedback. Graphs are the core feature of CashCash. First, you see and then you check the numbers.
\n
🔍 Filter
\n
One filter for all. Change it and see the graphs, tables and budgets adapting accordingly.
\n
⚖️ Budget
\n
Define your monthly target on all your expenses and incomes.
\n
🤖 Automate
\n
Create rules that will automatically assign transactions to the right accounts.
\n
🏦 Keep your secrets
\n
Your financial data stays on your computer. What you do with your money is nobody else business.\nYou can also export the database to save a copy at a place of your choice.
\n
Available features in CashCash
\n
\n
Charts
\n
Double-entry bookkeeping
\n
Multicurrency support
\n
Tree structure accounts
\n
Unlimited transactions
\n
Unlimited accounts
\n
Filters
\n
Database export
\n
Database import
\n
Automation rules
\n
Bulk transactions update
\n
Budget
\n
XLS, XLSX, ODS and CSV import
\n
\n
Contribution
\n
Please make sure to read the Contributing Guide before making a pull request.
\n
",
"readmeOriginal": "
\n
Cashcash is the accounting app for visual people.
\n
👀 Visualize
\n
Take decisions based on visual feedback. Graphs are the core feature of CashCash. First, you see and then you check the numbers.
\n
🔍 Filter
\n
One filter for all. Change it and see the graphs, tables and budgets adapting accordingly.
\n
⚖️ Budget
\n
Define your monthly target on all your expenses and incomes.
\n
🤖 Automate
\n
Create rules that will automatically assign transactions to the right accounts.
\n
🏦 Keep your secrets
\n
Your financial data stays on your computer. What you do with your money is nobody else business.\nYou can also export the database to save a copy at a place of your choice.
\n
Available features in CashCash
\n
\n
Charts
\n
Double-entry bookkeeping
\n
Multicurrency support
\n
Tree structure accounts
\n
Unlimited transactions
\n
Unlimited accounts
\n
Filters
\n
Database export
\n
Database import
\n
Automation rules
\n
Bulk transactions update
\n
Budget
\n
XLS, XLSX, ODS and CSV import
\n
\n
Contribution
\n
Please make sure to read the Contributing Guide before making a pull request.
I'm in need of someone to pass the mantle to. I'd love for this project to keep going, but I'm not currently able to give this the attention it deserves. I'm willing to help out and ease the transition to whoever wants to take it over.
\n
Introduction
\n
When using Canvas, I found that constantly downloading new files, updated files and then organizing those files was a huge pain. This program aims to work by having Google Drive like functionality with Canvas so that you never have to worry about being up to date or how you have organized things, because they will be organized on your computer just as they are organized on Canvas.
Clone this repository and run yarn. Once it's done installing the modules, run yarn run dev
\n
Building this code
\n
yarn run build:mac
\n
yarn run build:win
\n
Note
\n
Releases are being code signed so your personal build will not work with the built in autoupdating.
\n
Contributing
\n
I'd appreciate any help that anyone would like to give and have included draw.io diagrams in the diagrams folder to help facilitate understanding of the overall flow.
\n
TODO
\n
\n
Toggle courses to sync
\n
Increase initial download speed
\n
Handle situations more gracefully where an update has occurred both locally and remotely
\n
Allow more granular control of what to sync(Treeview)
I'm in need of someone to pass the mantle to. I'd love for this project to keep going, but I'm not currently able to give this the attention it deserves. I'm willing to help out and ease the transition to whoever wants to take it over.
\n
Introduction
\n
When using Canvas, I found that constantly downloading new files, updated files and then organizing those files was a huge pain. This program aims to work by having Google Drive like functionality with Canvas so that you never have to worry about being up to date or how you have organized things, because they will be organized on your computer just as they are organized on Canvas.
Clone this repository and run yarn. Once it's done installing the modules, run yarn run dev
\n
Building this code
\n
yarn run build:mac
\n
yarn run build:win
\n
Note
\n
Releases are being code signed so your personal build will not work with the built in autoupdating.
\n
Contributing
\n
I'd appreciate any help that anyone would like to give and have included draw.io diagrams in the diagrams folder to help facilitate understanding of the overall flow.
\n
TODO
\n
\n
Toggle courses to sync
\n
Increase initial download speed
\n
Handle situations more gracefully where an update has occurred both locally and remotely
\n
Allow more granular control of what to sync(Treeview)
Caption takes the effort out of finding and setting up the right subtitles. A simple design, drag & drop search, and automatic downloading & renaming let you just start watching. Caption is multi-platform, open-source, and built entirely on web technology.
Caption is completely open-source. We've tried to make it as easy as possible to\ncontribute. If you'd like to help out by adding features, working on bug fixes,\nor assisting in other parts of development, here's how to get started:
Clone it to your\nlocal device: git clone git@github.com:gielcobben/caption.git
\n
Install the dependencies: npm install
\n
Run the app by starting electron, building the code and watch for changes:\nnpm start\n
To build for production (should not generally be used):
\n
\n
Build the actual app for all platforms (Mac, Windows and Linux): npm run dist
\n\n \n
📦 Sources
\n
Caption currently uses 2 sources to gather subtitles. We're continuously adding\nsources, but the app's open-source nature also allows you to add your own when\ndesired. This can be done in\nCaption Core.
Caption takes the effort out of finding and setting up the right subtitles. A simple design, drag & drop search, and automatic downloading & renaming let you just start watching. Caption is multi-platform, open-source, and built entirely on web technology.
Caption is completely open-source. We've tried to make it as easy as possible to\ncontribute. If you'd like to help out by adding features, working on bug fixes,\nor assisting in other parts of development, here's how to get started:
Clone it to your\nlocal device: git clone git@github.com:gielcobben/caption.git
\n
Install the dependencies: npm install
\n
Run the app by starting electron, building the code and watch for changes:\nnpm start\n
To build for production (should not generally be used):
\n
\n
Build the actual app for all platforms (Mac, Windows and Linux): npm run dist
\n\n \n
📦 Sources
\n
Caption currently uses 2 sources to gather subtitles. We're continuously adding\nsources, but the app's open-source nature also allows you to add your own when\ndesired. This can be done in\nCaption Core.
In order to use this source code you need to have Node.js, Git and Bower installed globally. After that you have to follow the steps below.
\n
# Clone this repository\ngit clone https://github.com/florianfe/Cells\n# Go into the repository\ncd Cells\n# Install npm dependencies\nnpm install\n# Install bower dependencies\nbower install\n# Run the app in test mode\nnpm start\n# build application for release\nnpm run-script dist
In order to use this source code you need to have Node.js, Git and Bower installed globally. After that you have to follow the steps below.
\n
# Clone this repository\ngit clone https://github.com/florianfe/Cells\n# Go into the repository\ncd Cells\n# Install npm dependencies\nnpm install\n# Install bower dependencies\nbower install\n# Run the app in test mode\nnpm start\n# build application for release\nnpm run-script dist
Checksum is an simple application that help you verifying the checksum of a file, make sure the file was is the correct file and wasn't corrupted during download.
\n
🏭 Features
\n
Current version: 0.1.0
\n
\n
Support 46 hash functions.
\n
\n
\n
🛣️ Roadmap
\n
Next version: 0.2.0
\n
\n
Add history.
\n
Check multiple files at once.
\n
\n
📥 Download
\n
Download the latest version from the releases page.\nAvailable for Windows & Linux.
# Clone this project:\ngit clone https://github.com/mnismt/checksum.git\n\n# Install dependencies\nyarn # or npm install\n\n# Run (with hot reload)\nyarn dev # or npm run dev\n\n# Build for production\nyarn build # or npm run build\n
Checksum is an simple application that help you verifying the checksum of a file, make sure the file was is the correct file and wasn't corrupted during download.
\n
🏭 Features
\n
Current version: 0.1.0
\n
\n
Support 46 hash functions.
\n
\n
\n
🛣️ Roadmap
\n
Next version: 0.2.0
\n
\n
Add history.
\n
Check multiple files at once.
\n
\n
📥 Download
\n
Download the latest version from the releases page.\nAvailable for Windows & Linux.
# Clone this project:\ngit clone https://github.com/mnismt/checksum.git\n\n# Install dependencies\nyarn # or npm install\n\n# Run (with hot reload)\nyarn dev # or npm run dev\n\n# Build for production\nyarn build # or npm run build\n
In order to use this source code you need to have Node.js, Git and Bower installed globally. After that you have to follow the steps below.
\n
# Clone this repository\ngit clone https://github.com/florianfe/Cells\n# Go into the repository\ncd Cells\n# Install npm dependencies\nnpm install\n# Install bower dependencies\nbower install\n# Run the app in test mode\nnpm start\n# build application for release\nnpm run-script dist
In order to use this source code you need to have Node.js, Git and Bower installed globally. After that you have to follow the steps below.
\n
# Clone this repository\ngit clone https://github.com/florianfe/Cells\n# Go into the repository\ncd Cells\n# Install npm dependencies\nnpm install\n# Install bower dependencies\nbower install\n# Run the app in test mode\nnpm start\n# build application for release\nnpm run-script dist
Open-source Pomodoro timer made in Electron that faithfully replicates the original technique, made in procrastination by Jordan Peters (Rollersteaam).
Drag clock numbers to set in place the set timings, and hear each click along the way. By initiating every session with a physical act, focus and flow is created through the visual and audio cues as your session has an increased sense of purpose. You may also choose to set target focuses for a block of work to determine your specific tasks. Timer completion cues and drones, as well as an optional ticking of a timer each play their part in making a pretty 'alive' timer.
\n
Latest: Version 1.1.0
\n
This version is a major quality-of-life adjustment to Chronobreak as I've used it personally over the last 6 months, as well as reading some feedback online about the app itself.
\n
General
\n
\n
A new logo has now been added (Credits to redmusic)
\n
The timer will now automatically pop up (or at least try to) on completion of a phase.
\n
The timer will now change UI when it's active.
\n
A chime will now play when a timer has been activated.
\n
The appearance of the right-click tray menu has been changed so it's more difficult to accidently discard a pomodoro.
\n
Work phase completion song has been changed because of how annoying it was before.
\n
Tick tock sound is now turned off by default. No need to turn it off each time you launch Chronobreak.
\n
Updated showcase gif to show new changes.
\n
\n
Issues
\n
\n
Pomodoro completion music has been turned down a good amount (8db) and remastered to account for the weird bass distortion.
\n
Corrected text about how much work was accomplished in a session.
\n
Changed some text on 'Small Break' phase to offer more helpful suggestions.
\n
\n
Installation
\n
Go to the Releases tab and download the latest version's .zip archive. Unzip it and run the 'Chronobreak' shortcut.
\n
Want to contribute?
\n
I would absolutely love for you to iterate on my design and improve it.
\n
By forking this project, you get your own copy of the latest version's files where you can make changes. You can then choose to make a pull request to merge those new changes. When I verify them, they'll be added officially to this project and you'll be shown as a Contributor, as well as being credited by me.
Open-source Pomodoro timer made in Electron that faithfully replicates the original technique, made in procrastination by Jordan Peters (Rollersteaam).
Drag clock numbers to set in place the set timings, and hear each click along the way. By initiating every session with a physical act, focus and flow is created through the visual and audio cues as your session has an increased sense of purpose. You may also choose to set target focuses for a block of work to determine your specific tasks. Timer completion cues and drones, as well as an optional ticking of a timer each play their part in making a pretty 'alive' timer.
\n
Latest: Version 1.1.0
\n
This version is a major quality-of-life adjustment to Chronobreak as I've used it personally over the last 6 months, as well as reading some feedback online about the app itself.
\n
General
\n
\n
A new logo has now been added (Credits to redmusic)
\n
The timer will now automatically pop up (or at least try to) on completion of a phase.
\n
The timer will now change UI when it's active.
\n
A chime will now play when a timer has been activated.
\n
The appearance of the right-click tray menu has been changed so it's more difficult to accidently discard a pomodoro.
\n
Work phase completion song has been changed because of how annoying it was before.
\n
Tick tock sound is now turned off by default. No need to turn it off each time you launch Chronobreak.
\n
Updated showcase gif to show new changes.
\n
\n
Issues
\n
\n
Pomodoro completion music has been turned down a good amount (8db) and remastered to account for the weird bass distortion.
\n
Corrected text about how much work was accomplished in a session.
\n
Changed some text on 'Small Break' phase to offer more helpful suggestions.
\n
\n
Installation
\n
Go to the Releases tab and download the latest version's .zip archive. Unzip it and run the 'Chronobreak' shortcut.
\n
Want to contribute?
\n
I would absolutely love for you to iterate on my design and improve it.
\n
By forking this project, you get your own copy of the latest version's files where you can make changes. You can then choose to make a pull request to merge those new changes. When I verify them, they'll be added officially to this project and you'll be shown as a Contributor, as well as being credited by me.
We always welcome suggestions and Pull Requests! This program is written in NodeJS and packaged with Electron. This means that anyone with experience in JavaScript, Node, HTML, CSS, and C++ can contribute just fine! With Node, C++ users can contribute as well, due to Node supporting C++ modules!\n
\n
If you have a suggestion, and do not know any of the required languages, you can reach us on Discord
\n
How to get the latest version of CemUI
\n
The latest official builds can be found in the GitHub Releases section. These are stable builds.
\n
To get the latest developer version of CemUI right now, you may build and run from source. These are more likely to be unstable.
\n
To get the latest developer version, follow these steps:
Enter the source code directory via a command prompt (cd C:/Path/To/CemUI)
\n
Run npm i to install all depends
\n
Run npm i electron -g to globally install Electron
\n
Run electron . in the source code directory. This will start the developer version of CemUI.
\n\n
This is the only official place that you can download CemUI, any other places hosting CemUI are doing it without our permission.
\n
Themes
\n
CemUI ships with 2 default themes, Fluent and Flux. Fluent is the original CemUI 2.0 design theme. Flux is our uniform theme following our own custom design specs, based on a mix of several existing specs.
\n
Custom Themes
\n
CemUI supports loading 3rd party themes. Themes can be loaded from %appdata%/CemUI/app_data/themes. Each theme must have an index.html file, config.json file and a thumbnail.jpg file. config.json stores the basic settings for the theme. It is an object with these properties:
Given that this project is still very early in development, bugs will probably be common, and vary from person to person. If you find a bug, we ask that you follow this format for reporting the bug on the Issue Tracker on the repo:
\n
\n
\n
A detailed name describing the bug (no \"A bug happened\" type titles!)
\n
\n
\n
A detailed description of the bug
\n
\n
\n
Exact steps to reproduce
\n
\n
\n
A screenshot/video of the bug/error message
\n
\n
\n
List games affected (if applicable)
\n
\n
\n
If possible, a video or gif showing the exact steps to reproduce (There are many free video recorders out there. It doesn't matter how you record it, as long as it's recorded)
\n
\n
\n
And above all: stay calm. Currently there are only 2 developers working on this project, and for one this is the first NodeJS app they have worked on. Also given the nature of how Electron packages apps, bugs may not occur on our end but will on yours. Please be patient while we attempt to fix the issue.
We always welcome suggestions and Pull Requests! This program is written in NodeJS and packaged with Electron. This means that anyone with experience in JavaScript, Node, HTML, CSS, and C++ can contribute just fine! With Node, C++ users can contribute as well, due to Node supporting C++ modules!\n
\n
If you have a suggestion, and do not know any of the required languages, you can reach us on Discord
\n
How to get the latest version of CemUI
\n
The latest official builds can be found in the GitHub Releases section. These are stable builds.
\n
To get the latest developer version of CemUI right now, you may build and run from source. These are more likely to be unstable.
\n
To get the latest developer version, follow these steps:
Enter the source code directory via a command prompt (cd C:/Path/To/CemUI)
\n
Run npm i to install all depends
\n
Run npm i electron -g to globally install Electron
\n
Run electron . in the source code directory. This will start the developer version of CemUI.
\n\n
This is the only official place that you can download CemUI, any other places hosting CemUI are doing it without our permission.
\n
Themes
\n
CemUI ships with 2 default themes, Fluent and Flux. Fluent is the original CemUI 2.0 design theme. Flux is our uniform theme following our own custom design specs, based on a mix of several existing specs.
\n
Custom Themes
\n
CemUI supports loading 3rd party themes. Themes can be loaded from %appdata%/CemUI/app_data/themes. Each theme must have an index.html file, config.json file and a thumbnail.jpg file. config.json stores the basic settings for the theme. It is an object with these properties:
Given that this project is still very early in development, bugs will probably be common, and vary from person to person. If you find a bug, we ask that you follow this format for reporting the bug on the Issue Tracker on the repo:
\n
\n
\n
A detailed name describing the bug (no \"A bug happened\" type titles!)
\n
\n
\n
A detailed description of the bug
\n
\n
\n
Exact steps to reproduce
\n
\n
\n
A screenshot/video of the bug/error message
\n
\n
\n
List games affected (if applicable)
\n
\n
\n
If possible, a video or gif showing the exact steps to reproduce (There are many free video recorders out there. It doesn't matter how you record it, as long as it's recorded)
\n
\n
\n
And above all: stay calm. Currently there are only 2 developers working on this project, and for one this is the first NodeJS app they have worked on. Also given the nature of how Electron packages apps, bugs may not occur on our end but will on yours. Please be patient while we attempt to fix the issue.
Desktop client for JIRA. Track time, upload automatic and manual worklogs without a hassle.\nCross-platform. Open-sourced.
\n
Your working tool kit. Open a tracker, browse tasks, pick what you want to work on and start\ntracking. Move it to \"Done\" when you've finished. Without leaving an app.
\n
\n
Features
\n
Simple to manage your tasks
\n
Chronos is also minimalistic JIRA client, where you can perform most needed actions like changing\nissue’s status or checking it’s details.
\n
Customizable worklogs
\n
Besides native JIRA worklogs information we provide a lot of data like screenshots,\nactivities, types and comments. You also can add worklogs manually.
\n
Secured and open-sourced
\n
Code of the project is in public access and hosted on Github.
\n
Free
\n
It’s free. If you think our product rocks or just want to support us, check out\nChronos Timesheets.
\n
Chronos timesheets
\n
JIRA plugin to view worklogs. Watch what your team is busy with, calculate salaries, view\nscreenshots and activity levels. Rich and flexible.
We're small team of developers. We make web, mobile and\ndesktop apps. We're hardworking and passionate about our products.\nIf you want to collaborate or hire us, contact at it@web-pal.com
\n
See also the list of contributors who participated in this project.
\n
License
\n
This project is licensed under the MIT License - see the LICENSE.md file for details
\n
",
"readmeOriginal": "
\n
\n
Chronos timetracker
\n
Desktop client for JIRA. Track time, upload automatic and manual worklogs without a hassle.\nCross-platform. Open-sourced.
\n
Your working tool kit. Open a tracker, browse tasks, pick what you want to work on and start\ntracking. Move it to \"Done\" when you've finished. Without leaving an app.
\n
\n
Features
\n
Simple to manage your tasks
\n
Chronos is also minimalistic JIRA client, where you can perform most needed actions like changing\nissue’s status or checking it’s details.
\n
Customizable worklogs
\n
Besides native JIRA worklogs information we provide a lot of data like screenshots,\nactivities, types and comments. You also can add worklogs manually.
\n
Secured and open-sourced
\n
Code of the project is in public access and hosted on Github.
\n
Free
\n
It’s free. If you think our product rocks or just want to support us, check out\nChronos Timesheets.
\n
Chronos timesheets
\n
JIRA plugin to view worklogs. Watch what your team is busy with, calculate salaries, view\nscreenshots and activity levels. Rich and flexible.
We're small team of developers. We make web, mobile and\ndesktop apps. We're hardworking and passionate about our products.\nIf you want to collaborate or hire us, contact at it@web-pal.com
\n
See also the list of contributors who participated in this project.
\n
License
\n
This project is licensed under the MIT License - see the LICENSE.md file for details
If you found this project helpful or you learned something from the source code and want to thank me, consider buying me a cup of ☕
\n
\n
\n
🐛 Bugs or Requests
\n
If you encounter any problems feel free to open an issue. If you feel the library is missing a feature, please raise a ticket on GitHub and I'll look into it. Pull request are also welcome.
If you found this project helpful or you learned something from the source code and want to thank me, consider buying me a cup of ☕
\n
\n
\n
🐛 Bugs or Requests
\n
If you encounter any problems feel free to open an issue. If you feel the library is missing a feature, please raise a ticket on GitHub and I'll look into it. Pull request are also welcome.
We always welcome suggestions and Pull Requests! This program is written in NodeJS and packaged with Electron. This means that anyone with experience in JavaScript, Node, HTML, CSS, and C++ can contribute just fine! With Node, C++ users can contribute as well, due to Node supporting C++ modules!\n
\n
If you have a suggestion, and do not know any of the required languages, you can reach us on Discord
\n
How to get the latest version of CemUI
\n
The latest official builds can be found in the GitHub Releases section. These are stable builds.
\n
To get the latest developer version of CemUI right now, you may build and run from source. These are more likely to be unstable.
\n
To get the latest developer version, follow these steps:
Enter the source code directory via a command prompt (cd C:/Path/To/CemUI)
\n
Run npm i to install all depends
\n
Run npm i electron -g to globally install Electron
\n
Run electron . in the source code directory. This will start the developer version of CemUI.
\n\n
This is the only official place that you can download CemUI, any other places hosting CemUI are doing it without our permission.
\n
Themes
\n
CemUI ships with 2 default themes, Fluent and Flux. Fluent is the original CemUI 2.0 design theme. Flux is our uniform theme following our own custom design specs, based on a mix of several existing specs.
\n
Custom Themes
\n
CemUI supports loading 3rd party themes. Themes can be loaded from %appdata%/CemUI/app_data/themes. Each theme must have an index.html file, config.json file and a thumbnail.jpg file. config.json stores the basic settings for the theme. It is an object with these properties:
Given that this project is still very early in development, bugs will probably be common, and vary from person to person. If you find a bug, we ask that you follow this format for reporting the bug on the Issue Tracker on the repo:
\n
\n
\n
A detailed name describing the bug (no \"A bug happened\" type titles!)
\n
\n
\n
A detailed description of the bug
\n
\n
\n
Exact steps to reproduce
\n
\n
\n
A screenshot/video of the bug/error message
\n
\n
\n
List games affected (if applicable)
\n
\n
\n
If possible, a video or gif showing the exact steps to reproduce (There are many free video recorders out there. It doesn't matter how you record it, as long as it's recorded)
\n
\n
\n
And above all: stay calm. Currently there are only 2 developers working on this project, and for one this is the first NodeJS app they have worked on. Also given the nature of how Electron packages apps, bugs may not occur on our end but will on yours. Please be patient while we attempt to fix the issue.
We always welcome suggestions and Pull Requests! This program is written in NodeJS and packaged with Electron. This means that anyone with experience in JavaScript, Node, HTML, CSS, and C++ can contribute just fine! With Node, C++ users can contribute as well, due to Node supporting C++ modules!\n
\n
If you have a suggestion, and do not know any of the required languages, you can reach us on Discord
\n
How to get the latest version of CemUI
\n
The latest official builds can be found in the GitHub Releases section. These are stable builds.
\n
To get the latest developer version of CemUI right now, you may build and run from source. These are more likely to be unstable.
\n
To get the latest developer version, follow these steps:
Enter the source code directory via a command prompt (cd C:/Path/To/CemUI)
\n
Run npm i to install all depends
\n
Run npm i electron -g to globally install Electron
\n
Run electron . in the source code directory. This will start the developer version of CemUI.
\n\n
This is the only official place that you can download CemUI, any other places hosting CemUI are doing it without our permission.
\n
Themes
\n
CemUI ships with 2 default themes, Fluent and Flux. Fluent is the original CemUI 2.0 design theme. Flux is our uniform theme following our own custom design specs, based on a mix of several existing specs.
\n
Custom Themes
\n
CemUI supports loading 3rd party themes. Themes can be loaded from %appdata%/CemUI/app_data/themes. Each theme must have an index.html file, config.json file and a thumbnail.jpg file. config.json stores the basic settings for the theme. It is an object with these properties:
Given that this project is still very early in development, bugs will probably be common, and vary from person to person. If you find a bug, we ask that you follow this format for reporting the bug on the Issue Tracker on the repo:
\n
\n
\n
A detailed name describing the bug (no \"A bug happened\" type titles!)
\n
\n
\n
A detailed description of the bug
\n
\n
\n
Exact steps to reproduce
\n
\n
\n
A screenshot/video of the bug/error message
\n
\n
\n
List games affected (if applicable)
\n
\n
\n
If possible, a video or gif showing the exact steps to reproduce (There are many free video recorders out there. It doesn't matter how you record it, as long as it's recorded)
\n
\n
\n
And above all: stay calm. Currently there are only 2 developers working on this project, and for one this is the first NodeJS app they have worked on. Also given the nature of how Electron packages apps, bugs may not occur on our end but will on yours. Please be patient while we attempt to fix the issue.
AssertionError: Current node version is not supported for development on npm postinstall.\nAfter yarn postinstall script checks node version. If you see this error you have to check node and npm version in package.jsondevEngines section and install proper ones.
\n
\n
\n
Uncaught Error: Module version mismatch. Exepcted 50, got ...\nThis error means that node modules with native extensions build with wrong node version (your local node version != node version, included to electron). To fix this issue run cd ./app && yarn run rebuild
\n
\n\n
Change Theme
\n
Use shortcut ctrl+space to open app window and type Cerebro Settings. There you will be able to change the Theme (Currently Light and Dark Themes are supported out of the box)
\n
\n
Config file path
\n
Windows: %APPDATA%/Cerebro/config.json
\n
Linux: $XDG_CONFIG_HOME/Cerebro/config.json or ~/.config/Cerebro/config.json
AssertionError: Current node version is not supported for development on npm postinstall.\nAfter yarn postinstall script checks node version. If you see this error you have to check node and npm version in package.jsondevEngines section and install proper ones.
\n
\n
\n
Uncaught Error: Module version mismatch. Exepcted 50, got ...\nThis error means that node modules with native extensions build with wrong node version (your local node version != node version, included to electron). To fix this issue run cd ./app && yarn run rebuild
\n
\n\n
Change Theme
\n
Use shortcut ctrl+space to open app window and type Cerebro Settings. There you will be able to change the Theme (Currently Light and Dark Themes are supported out of the box)
\n
\n
Config file path
\n
Windows: %APPDATA%/Cerebro/config.json
\n
Linux: $XDG_CONFIG_HOME/Cerebro/config.json or ~/.config/Cerebro/config.json
If you found this project helpful or you learned something from the source code and want to thank me, consider buying me a cup of ☕
\n
\n
\n
🐛 Bugs or Requests
\n
If you encounter any problems feel free to open an issue. If you feel the library is missing a feature, please raise a ticket on GitHub and I'll look into it. Pull request are also welcome.
If you found this project helpful or you learned something from the source code and want to thank me, consider buying me a cup of ☕
\n
\n
\n
🐛 Bugs or Requests
\n
If you encounter any problems feel free to open an issue. If you feel the library is missing a feature, please raise a ticket on GitHub and I'll look into it. Pull request are also welcome.
After cloning the repo, Install the dependencies and start the application.
\n
$ cd clippy\n$ npm install\n$ npm run start
\n
The npm run start command has been modified to start the electron app and then start the react application after the electron app has been launched.\nYou might need to refresh the electron application by Ctrl+R once the react application is started.
\n
",
"readmeOriginal": "
Clippy
\n
\n
Clippy is a desktop application that helps keep track of your clipboard history.
After cloning the repo, Install the dependencies and start the application.
\n
$ cd clippy\n$ npm install\n$ npm run start
\n
The npm run start command has been modified to start the electron app and then start the react application after the electron app has been launched.\nYou might need to refresh the electron application by Ctrl+R once the react application is started.
This powers the Neutron (Electron)-based apps you install from WebCatalog.
\n\n
Development
\n
This repository only contains the source code of the Neutron - the core that powers the apps created with WebCatalog. If you'd like to contribute to the WebCatalog app, check out https://github.com/webcatalog/webcatalog-app.
\n
# clone the project:\ngit clone https://github.com/webcatalog/neutron.git\ncd neutron
\n
For the app to be fully functional, set these environment variables:
# install the dependencies\nyarn\n\n# Run development mode\nyarn electron-dev\n\n# Package template app as zip file\nyarn dist
\n
",
"readmeOriginal": "
Neutron
\n
\n\n
\n
macOS (x64)
\n
Linux (x64)
\n
Windows (x64)
\n
\n\n\n
\n
\n
\n
\n
\n\n
\n
\n\n
\n
macOS (arm64)
\n
Linux (arm64)
\n
Windows (arm64)
\n
\n\n\n
\n
\n
\n
\n
\n\n
\n
This powers the Neutron (Electron)-based apps you install from WebCatalog.
\n\n
Development
\n
This repository only contains the source code of the Neutron - the core that powers the apps created with WebCatalog. If you'd like to contribute to the WebCatalog app, check out https://github.com/webcatalog/webcatalog-app.
\n
# clone the project:\ngit clone https://github.com/webcatalog/neutron.git\ncd neutron
\n
For the app to be fully functional, set these environment variables:
The aim of this project is to make us more efficient by offering a pretty cool tool : a kind of notepad for our code 😃📝
\n
Demo
\n
\n
\n
\n
Download
\n
Go the the download section of our website to download Code Notes on your OS.
\n
Contributing
\n
For the moment, the project is pretty young. But if we work together to build the \"bloc-notes\" we dream, we can build pretty things for sure ! \nSo, feel free to contribute. Follow this guide🤓
\n
Build Setup
\n
# install dependencies\nnpm install\n\n# serve with hot reload at localhost:9080\nnpm run dev\n\n# build electron application for production\nnpm run build\n\n# run unit & end-to-end tests\nnpm test\n\n# lint all JS/Vue component files in `src/`\nnpm run eslint
The aim of this project is to make us more efficient by offering a pretty cool tool : a kind of notepad for our code 😃📝
\n
Demo
\n
\n
\n
\n
Download
\n
Go the the download section of our website to download Code Notes on your OS.
\n
Contributing
\n
For the moment, the project is pretty young. But if we work together to build the \"bloc-notes\" we dream, we can build pretty things for sure ! \nSo, feel free to contribute. Follow this guide🤓
\n
Build Setup
\n
# install dependencies\nnpm install\n\n# serve with hot reload at localhost:9080\nnpm run dev\n\n# build electron application for production\nnpm run build\n\n# run unit & end-to-end tests\nnpm test\n\n# lint all JS/Vue component files in `src/`\nnpm run eslint
Cocos Creator is the new generation of game development tool in Cocos family, it brings a complete set of 3D features and provides an intuitive, low cost and collaboration friendly workflow to game developers.
\n
Cocos Creator inherited many good qualities and cool features from its previous versions, such as cross-platform support including instant gaming platforms like WeChat mini game, asset management, powerful animation editing, etc. Furthermore, Cocos Creator has pushed our technology to a whole new level. Our GFX implementation is designed to adapt to the latest graphic backend APIs, it already supports WebGL 2 and can be seamlessly fall back to WebGL 1, it will support Vulkan and Metal in the native build. The material system is built on our own effect format which uses GLSL 300 and can be easily adapted to lower version on low end devices. Developers can produce high performance, extremely expressive shaders with good compatibility. Along with physical based camera and lighting, high level game graphic can be easily achieved. Our pure GPU driven skeleton animation also make sure your game runs as smooth as possible. Besides all these exciting features, Cocos Creator have builtin physics support, terrain editing support, visual effect editing, ui system, TypeScript support, instant preview etc.
\n
\n
This repo is the engine part of Cocos Creator, it's mainly written in TypeScript and support users to use TypeScript or ES6 to write game logics. The engine itself is mostly self-contained, with full-fledged runtime modules including lighting, material, particle, animation, physical, UI, terrain, sound, resource and scene-graph management, etc. It supports both native and web platforms, including Windows, Mac, iOS, Android, Web. What's more exciting is that it supports rapidly expanding instant gaming platforms like WeChat Mini Game and Facebook Instant Games.
\n
The engine is naturally integrated within Cocos Creator, designed to only be the essential runtime library and not to be used independently.
Cocos Creator is the new generation of game development tool in Cocos family, it brings a complete set of 3D features and provides an intuitive, low cost and collaboration friendly workflow to game developers.
\n
Cocos Creator inherited many good qualities and cool features from its previous versions, such as cross-platform support including instant gaming platforms like WeChat mini game, asset management, powerful animation editing, etc. Furthermore, Cocos Creator has pushed our technology to a whole new level. Our GFX implementation is designed to adapt to the latest graphic backend APIs, it already supports WebGL 2 and can be seamlessly fall back to WebGL 1, it will support Vulkan and Metal in the native build. The material system is built on our own effect format which uses GLSL 300 and can be easily adapted to lower version on low end devices. Developers can produce high performance, extremely expressive shaders with good compatibility. Along with physical based camera and lighting, high level game graphic can be easily achieved. Our pure GPU driven skeleton animation also make sure your game runs as smooth as possible. Besides all these exciting features, Cocos Creator have builtin physics support, terrain editing support, visual effect editing, ui system, TypeScript support, instant preview etc.
\n
\n
This repo is the engine part of Cocos Creator, it's mainly written in TypeScript and support users to use TypeScript or ES6 to write game logics. The engine itself is mostly self-contained, with full-fledged runtime modules including lighting, material, particle, animation, physical, UI, terrain, sound, resource and scene-graph management, etc. It supports both native and web platforms, including Windows, Mac, iOS, Android, Web. What's more exciting is that it supports rapidly expanding instant gaming platforms like WeChat Mini Game and Facebook Instant Games.
\n
The engine is naturally integrated within Cocos Creator, designed to only be the essential runtime library and not to be used independently.
Colon is a flexible text editor and lightweight hybrid IDE, built on Electron, and based on everything we love about our favorite editors. We are trying to designe it to be fully customizable and easy to use.
\n
New Features! 🌟
\n
\n
✅ Full Featured Editor
\n
✅ Syntax Highlighting Over 100+ Languages
\n
✅ Autocompletion
\n
✅ Code Folding
\n
✅ Bracket and Tag Matching
\n
✅ 7+ Themes
\n
✅ Autocompletion
\n
✅ Tab Management
\n
✅ Auto Save
\n
✅ Templates For Specific File Extension
\n
✅ Project Management
\n
✅ Console (for variour programming languages over 10+)
\n
✅ Real Time Preview for Markup Languages (HTML, MD)
\n
✅ Discord-rpc Support
\n
✅ Real Time Code Sharing
\n
✅ Easy UI
\n
\n
What Colon IDE Does ? 🌟
\n
Colon IDE provide you facility to execute over 10+ programming languages code simultaneously, You don't need to change compilers for different file. Colon automatically detects compiler for your file.
\n
Libraries 🌟
\n
Colon uses a number of API's and libraries to work properly:
\n
\n
✅ [NodeJs] - evented I/O for the backend
\n
✅ [codemirror] - full featured text editor
\n
✅ [localtunnel] - library to tunnel localhost
\n
✅ [socket.io] - for bidirectional communication
\n
✅ [discord-rpc] - for discord-rpc support
\n
\n
Installation 🌟
\n
\n
Installers are available on website here.\nElectron requires Node.js to run.
\n
\n
$ cd colon-ide\n$ npm install\n$ electron . or npm start
\n
License
\n
\n
",
"readmeOriginal": "
\n
Colon IDE
\n
What is Colon IDE ?
\n
Colon is a flexible text editor and lightweight hybrid IDE, built on Electron, and based on everything we love about our favorite editors. We are trying to designe it to be fully customizable and easy to use.
\n
New Features! 🌟
\n
\n
✅ Full Featured Editor
\n
✅ Syntax Highlighting Over 100+ Languages
\n
✅ Autocompletion
\n
✅ Code Folding
\n
✅ Bracket and Tag Matching
\n
✅ 7+ Themes
\n
✅ Autocompletion
\n
✅ Tab Management
\n
✅ Auto Save
\n
✅ Templates For Specific File Extension
\n
✅ Project Management
\n
✅ Console (for variour programming languages over 10+)
\n
✅ Real Time Preview for Markup Languages (HTML, MD)
\n
✅ Discord-rpc Support
\n
✅ Real Time Code Sharing
\n
✅ Easy UI
\n
\n
What Colon IDE Does ? 🌟
\n
Colon IDE provide you facility to execute over 10+ programming languages code simultaneously, You don't need to change compilers for different file. Colon automatically detects compiler for your file.
\n
Libraries 🌟
\n
Colon uses a number of API's and libraries to work properly:
\n
\n
✅ [NodeJs] - evented I/O for the backend
\n
✅ [codemirror] - full featured text editor
\n
✅ [localtunnel] - library to tunnel localhost
\n
✅ [socket.io] - for bidirectional communication
\n
✅ [discord-rpc] - for discord-rpc support
\n
\n
Installation 🌟
\n
\n
Installers are available on website here.\nElectron requires Node.js to run.
\n
\n
$ cd colon-ide\n$ npm install\n$ electron . or npm start
The Commandeer Developer IDE - Manage 30+ of the best Cloud Services
\n
\n
Available on Mac, Windows, and Linux
\n
\n
\n
Commandeer is a tool built by developers for developers that solves three things in the cloud. First, we are focused on the deployment of your IAC. Secondly, we enable you to ‘Test your Plumbing’. Lastly, Commandeer provides you the ability to easily view your data. (Manage AWS, Algolia, Slack, Twilio, SendGrid, Serverless, LocalStack, Ansible, Docker and more from your desktop)
The code base for the Commandeer App is closed-source. To make a great product, we feel that is is better to only serve out a final, polished product with every release. If you look at our Release History you will notice that we have very few minor revisions, which are usually quick patches after a major release. This is because we have a hyper-focus on quality within all our tooling, but especially with our Desktop App, as it is a tool specifically meant to help you with your day to day work.
\n
Docker Compose
\n
This is the docker compose file to install Ansible runner, LocalStack, Portainer, Serverless, and Terraform.
\n
Tank Demo
\n
A demo application for help in creating a service to run in Commandeer
The Commandeer Developer IDE - Manage 30+ of the best Cloud Services
\n
\n
Available on Mac, Windows, and Linux
\n
\n
\n
Commandeer is a tool built by developers for developers that solves three things in the cloud. First, we are focused on the deployment of your IAC. Secondly, we enable you to ‘Test your Plumbing’. Lastly, Commandeer provides you the ability to easily view your data. (Manage AWS, Algolia, Slack, Twilio, SendGrid, Serverless, LocalStack, Ansible, Docker and more from your desktop)
The code base for the Commandeer App is closed-source. To make a great product, we feel that is is better to only serve out a final, polished product with every release. If you look at our Release History you will notice that we have very few minor revisions, which are usually quick patches after a major release. This is because we have a hyper-focus on quality within all our tooling, but especially with our Desktop App, as it is a tool specifically meant to help you with your day to day work.
\n
Docker Compose
\n
This is the docker compose file to install Ansible runner, LocalStack, Portainer, Serverless, and Terraform.
\n
Tank Demo
\n
A demo application for help in creating a service to run in Commandeer
You'll need Node.js (which comes with npm) installed on your computer in order to build this application.
\n
Clone method
\n
# Clone the repository\ngit clone https://github.com/tonton-pixel/color-ramp-formulator\n# Go into the repository\ncd color-ramp-formulator\n# Install dependencies\nnpm install\n# Run the application\nnpm start
\n
Note: to use the clone method, the core tool git must also be installed.
\n
Download method
\n
If you don't wish to clone, you can download the source code, unZip it, then directly run the following commands from a Terminal opened at the resulting color-ramp-formulator-master folder location:
\n
# Install dependencies\nnpm install\n# Run the application\nnpm start
\n
Packaging
\n
Several scripts are also defined in the package.json file to build OS-specific bundles of the application, using the simple yet powerful Electron Packager Node module. \nFor instance, running the following command (once the dependencies are installed) will create a Color Ramp Formulator.app version for macOS:
\n
# Build macOS (Darwin) application\nnpm run build-darwin
You'll need Node.js (which comes with npm) installed on your computer in order to build this application.
\n
Clone method
\n
# Clone the repository\ngit clone https://github.com/tonton-pixel/color-ramp-formulator\n# Go into the repository\ncd color-ramp-formulator\n# Install dependencies\nnpm install\n# Run the application\nnpm start
\n
Note: to use the clone method, the core tool git must also be installed.
\n
Download method
\n
If you don't wish to clone, you can download the source code, unZip it, then directly run the following commands from a Terminal opened at the resulting color-ramp-formulator-master folder location:
\n
# Install dependencies\nnpm install\n# Run the application\nnpm start
\n
Packaging
\n
Several scripts are also defined in the package.json file to build OS-specific bundles of the application, using the simple yet powerful Electron Packager Node module. \nFor instance, running the following command (once the dependencies are installed) will create a Color Ramp Formulator.app version for macOS:
\n
# Build macOS (Darwin) application\nnpm run build-darwin
With Pin, you can bring Colorpicker to the foreground. This makes it convenient to work quickly with different\napplications at the same time.
\n\n
Picker
\n
\n
The Picker allows you to quickly retrieve a color anywhere on the screen. Whether it's on your browser, Photoshop, or\nwhatever.
\n\n
Colorsbook
\n
\n
Colorsbook is a full-fledged application. It allows you to store your colors, categorize them, and easily retrieve them.\nIt is destined to mature over time.\nCool tip: you can save color from colorpicker with CMD+S or CTRL+S!
\n\n
Shading
\n
\n
With the shades, you can find the perfect color you need. You have a chromatic bar, a natural color bar and a shadow\nbar.
\n\n
Opacity [WIP]
\n
\n
This feature is a bit special. It allows you to render the application transparent. This can be useful to see the\nappearance of a transparent color.
\n\n
Focus Mode
\n
\n
Need to compare a color or clean up the interface? This feature is for you, this will hide the sliders and make the menu\nmore transparent.
\n\n
Magic Color [WIP]
\n
This functionality is still under development. Currently, it allows you to display the first color that is in your\nclipboard. This works with hexadecimal and RGB codes
\n\n
Random
\n
A traditional feature, it allows you to display a color randomly.
\n\n
Settings
\n
\n
The settings menu allows you to customize your Colorpicker, I let you discover it yourself :)!
To build C/C++ modules to the correct Electron version, use:
\n
\n
yarn rebuild
\n
\n
To build a new version:
\n
\n
# You can build nightly & release only for your current OS.\n# i.e. you can't build a OSX version if you use a Windows\n\n# build a nightly version\nyarn nightly\n\n# build a release version\nyarn release
With Pin, you can bring Colorpicker to the foreground. This makes it convenient to work quickly with different\napplications at the same time.
\n\n
Picker
\n
\n
The Picker allows you to quickly retrieve a color anywhere on the screen. Whether it's on your browser, Photoshop, or\nwhatever.
\n\n
Colorsbook
\n
\n
Colorsbook is a full-fledged application. It allows you to store your colors, categorize them, and easily retrieve them.\nIt is destined to mature over time.\nCool tip: you can save color from colorpicker with CMD+S or CTRL+S!
\n\n
Shading
\n
\n
With the shades, you can find the perfect color you need. You have a chromatic bar, a natural color bar and a shadow\nbar.
\n\n
Opacity [WIP]
\n
\n
This feature is a bit special. It allows you to render the application transparent. This can be useful to see the\nappearance of a transparent color.
\n\n
Focus Mode
\n
\n
Need to compare a color or clean up the interface? This feature is for you, this will hide the sliders and make the menu\nmore transparent.
\n\n
Magic Color [WIP]
\n
This functionality is still under development. Currently, it allows you to display the first color that is in your\nclipboard. This works with hexadecimal and RGB codes
\n\n
Random
\n
A traditional feature, it allows you to display a color randomly.
\n\n
Settings
\n
\n
The settings menu allows you to customize your Colorpicker, I let you discover it yourself :)!
To build C/C++ modules to the correct Electron version, use:
\n
\n
yarn rebuild
\n
\n
To build a new version:
\n
\n
# You can build nightly & release only for your current OS.\n# i.e. you can't build a OSX version if you use a Windows\n\n# build a nightly version\nyarn nightly\n\n# build a release version\nyarn release
A cross platform tool to read & query JSON aka CLEF log files created by Serilog
\n
\n
\n
Download
\n
Releases are available on this GitHub Repository along on the Windows Store
\n
Windows
\n
\n
MacOS
\n
The metrics for the MacOS usage was too little & I don't currently build/release any other Apple apps, so my Apple Developer subscription lapsed. I assumed the application would still be available to download but that I would not be able to push any new updates. However it seems Apple just removes the listing :(
\n
For now I recommend you build it manually. In future I may do auto-updates via GitHub releases instead of app stores.
dotnet publish --runtime osx-x64 --output bin/dist/osx --configuration release -p:PublishSingleFile=true generates a self contained application for our WebAPI
\n
dotnet publish --runtime win-x64 --output bin/dist/win --configuration release -p:PublishSingleFile=true same but creates the Windows version
\n
Change terminal directory to LogViewer.Client folder
\n
Install TypeScript if missing npm install -g typescript
\n
npm install
\n
tsc --watch This will compile the TypeScript files & continue to watch them
\n
Open a new terminal in LogViewer.Client
\n
npm run start Will run the Electron app for development with Chrome DevTools open/launched
\n
\n
\n
Note: If you npm run start before you have compiled the TypeScript files then Electron will complain about not finding the entry point file. Additionally if you have also not run dotnet publish then the underlying WebAPI which we communicate with will not be running.
\n
\n
3rd Party Libraries 💖💖
\n
This package uses the following libraries:
\n
\n
Serilog.Formatting.Compact.Reader
\n
Serilog.Filters.Expressions
\n
Serilog.Sinks.File
\n
\n
",
"readmeOriginal": "
Compact Log Format Viewer 🔍📈
\n
A cross platform tool to read & query JSON aka CLEF log files created by Serilog
\n
\n
\n
Download
\n
Releases are available on this GitHub Repository along on the Windows Store
\n
Windows
\n
\n
MacOS
\n
The metrics for the MacOS usage was too little & I don't currently build/release any other Apple apps, so my Apple Developer subscription lapsed. I assumed the application would still be available to download but that I would not be able to push any new updates. However it seems Apple just removes the listing :(
\n
For now I recommend you build it manually. In future I may do auto-updates via GitHub releases instead of app stores.
dotnet publish --runtime osx-x64 --output bin/dist/osx --configuration release -p:PublishSingleFile=true generates a self contained application for our WebAPI
\n
dotnet publish --runtime win-x64 --output bin/dist/win --configuration release -p:PublishSingleFile=true same but creates the Windows version
\n
Change terminal directory to LogViewer.Client folder
\n
Install TypeScript if missing npm install -g typescript
\n
npm install
\n
tsc --watch This will compile the TypeScript files & continue to watch them
\n
Open a new terminal in LogViewer.Client
\n
npm run start Will run the Electron app for development with Chrome DevTools open/launched
\n
\n
\n
Note: If you npm run start before you have compiled the TypeScript files then Electron will complain about not finding the entry point file. Additionally if you have also not run dotnet publish then the underlying WebAPI which we communicate with will not be running.
This little app for OSX help you to manager your Docker containers.
\n
\n \n \n \n \n \n
\n\n\n
You must have Docker launched to make work this app.\nIt uses shell commands using the Node.jschild_processspawn module, thanks to @SebastianRuecker.
\n
You can see the list of all your containers, whether they are active or not.
\n
\n
\n
The full circle indicates that the container is active.
\n
The empty circle indicates that it is inactive.
\n
And the round with a full wave indicates that the container is restarting.
\n
\n
When hovering over a container, you will have additional information about it, as well as buttons to turn it on, off, restart, open a console (bash or sh) and delete it.
\n
Install or Download
\n
The latest release can be dowloaded via brew cask:
This little app for OSX help you to manager your Docker containers.
\n
\n \n \n \n \n \n
\n\n\n
You must have Docker launched to make work this app.\nIt uses shell commands using the Node.jschild_processspawn module, thanks to @SebastianRuecker.
\n
You can see the list of all your containers, whether they are active or not.
\n
\n
\n
The full circle indicates that the container is active.
\n
The empty circle indicates that it is inactive.
\n
And the round with a full wave indicates that the container is restarting.
\n
\n
When hovering over a container, you will have additional information about it, as well as buttons to turn it on, off, restart, open a console (bash or sh) and delete it.
\n
Install or Download
\n
The latest release can be dowloaded via brew cask:
The Commandeer Developer IDE - Manage 30+ of the best Cloud Services
\n
\n
Available on Mac, Windows, and Linux
\n
\n
\n
Commandeer is a tool built by developers for developers that solves three things in the cloud. First, we are focused on the deployment of your IAC. Secondly, we enable you to ‘Test your Plumbing’. Lastly, Commandeer provides you the ability to easily view your data. (Manage AWS, Algolia, Slack, Twilio, SendGrid, Serverless, LocalStack, Ansible, Docker and more from your desktop)
The code base for the Commandeer App is closed-source. To make a great product, we feel that is is better to only serve out a final, polished product with every release. If you look at our Release History you will notice that we have very few minor revisions, which are usually quick patches after a major release. This is because we have a hyper-focus on quality within all our tooling, but especially with our Desktop App, as it is a tool specifically meant to help you with your day to day work.
\n
Docker Compose
\n
This is the docker compose file to install Ansible runner, LocalStack, Portainer, Serverless, and Terraform.
\n
Tank Demo
\n
A demo application for help in creating a service to run in Commandeer
The Commandeer Developer IDE - Manage 30+ of the best Cloud Services
\n
\n
Available on Mac, Windows, and Linux
\n
\n
\n
Commandeer is a tool built by developers for developers that solves three things in the cloud. First, we are focused on the deployment of your IAC. Secondly, we enable you to ‘Test your Plumbing’. Lastly, Commandeer provides you the ability to easily view your data. (Manage AWS, Algolia, Slack, Twilio, SendGrid, Serverless, LocalStack, Ansible, Docker and more from your desktop)
The code base for the Commandeer App is closed-source. To make a great product, we feel that is is better to only serve out a final, polished product with every release. If you look at our Release History you will notice that we have very few minor revisions, which are usually quick patches after a major release. This is because we have a hyper-focus on quality within all our tooling, but especially with our Desktop App, as it is a tool specifically meant to help you with your day to day work.
\n
Docker Compose
\n
This is the docker compose file to install Ansible runner, LocalStack, Portainer, Serverless, and Terraform.
\n
Tank Demo
\n
A demo application for help in creating a service to run in Commandeer
Did you know Compy the companion? They are a friendly mini browser to pin on top of any other desktop app and keep doing your things while enjoying a live stream or a youtube video.
Did you know Compy the companion? They are a friendly mini browser to pin on top of any other desktop app and keep doing your things while enjoying a live stream or a youtube video.
This little app for OSX help you to manager your Docker containers.
\n
\n \n \n \n \n \n
\n\n\n
You must have Docker launched to make work this app.\nIt uses shell commands using the Node.jschild_processspawn module, thanks to @SebastianRuecker.
\n
You can see the list of all your containers, whether they are active or not.
\n
\n
\n
The full circle indicates that the container is active.
\n
The empty circle indicates that it is inactive.
\n
And the round with a full wave indicates that the container is restarting.
\n
\n
When hovering over a container, you will have additional information about it, as well as buttons to turn it on, off, restart, open a console (bash or sh) and delete it.
\n
Install or Download
\n
The latest release can be dowloaded via brew cask:
This little app for OSX help you to manager your Docker containers.
\n
\n \n \n \n \n \n
\n\n\n
You must have Docker launched to make work this app.\nIt uses shell commands using the Node.jschild_processspawn module, thanks to @SebastianRuecker.
\n
You can see the list of all your containers, whether they are active or not.
\n
\n
\n
The full circle indicates that the container is active.
\n
The empty circle indicates that it is inactive.
\n
And the round with a full wave indicates that the container is restarting.
\n
\n
When hovering over a container, you will have additional information about it, as well as buttons to turn it on, off, restart, open a console (bash or sh) and delete it.
\n
Install or Download
\n
The latest release can be dowloaded via brew cask:
To clone and run this application, you'll need Git and Node.js (which comes with npm) installed on your computer. From your command line:
\n
# Clone this repository\n$ git clone https://github.com/amitmerchant1990/correo\n\n# Go into the repository\n$ cd correo\n\n# Install dependencies\n$ npm install\n\n# Run the app\n$ npm start
\n
Note: If you're using Linux Bash for Windows, see this guide or use node from the command prompt.
\n
Download
\n
Download the portable version of Correo for Windows, macOS and Linux from here.
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
\n
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
\n
THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
To clone and run this application, you'll need Git and Node.js (which comes with npm) installed on your computer. From your command line:
\n
# Clone this repository\n$ git clone https://github.com/amitmerchant1990/correo\n\n# Go into the repository\n$ cd correo\n\n# Install dependencies\n$ npm install\n\n# Run the app\n$ npm start
\n
Note: If you're using Linux Bash for Windows, see this guide or use node from the command prompt.
\n
Download
\n
Download the portable version of Correo for Windows, macOS and Linux from here.
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
\n
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
\n
THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Stand alone desktop app for Win/Osx/Linux that allows connecting to a local or remote Corda node. Examine transactions, run flows and view node and network properties in a few simple clicks.
\n
Downloading the Node Explorer Binaries
\n
If you're looking to download the node explorer and get started using it; download the latest packaged release on this repo's releases page.
\n
There are install packages for Linux, OSX and Windows.
\n
To login to your Corda node, you will need to provide the:
\n
\n
Hostname (domain, IP, or localhost)
\n
Rpc Port
\n
Username
\n
Password
\n
\n
Notes: You can find the Rpc port in your node config under rpcSettings->address or as displayed in a CraSH shell instance. If you have not explicitly set a username/password project defaults are user1 and test.
\n
Full instructions for using the Node-Explorer application at the documentation
\n\n
Setting up for Node Explorer for Development
\n
Note: This repository uses sub-modules. If cloning use git clone --recursive to automatically initialize and update the submodules.
Note this project uses the node-server submodule available at https://github.com/corda/node-server this must be initialised either by passing the --recursive option when running git clone OR executing the following commands.
\n\n
git submodule init
\n
git submodule update*
\n\n
*this command must also be run after any pull request which includes updates to the submodule. An alternative is to do pull requests with the following option:\ngit pull --recurse-submodules
\n
Other submodule commands:
\n
\n
\n
Fetch and merge the latest node-server submodule code
\n
\n
git submodule update --remote
\n
\n
\n
\n
Doing work on the submodule i.e. changing files in ./server
\n
\n
submodules default to a detached head, so change to server directory and checkout a branch
\n
cd ./server
\n
git checkout master
\n
Add or commit your changes as usual.
\n
\n
\n
\n
To PULL submodule updates from server side, if there are changes on your local branch either merge or rebase with the pull
\n
\n
From MAIN project directory
\n
git submodule update --remote --merge OR
\n
git submodule update --remote --rebase
\n
\n
\n
\n
To PUSH submodule updates to server side
\n
\n
From MAIN project directory
\n
git push --recurse-submodules=on-demand
\n
\n
\n
\n
Running the Node Explorer w/o packaging
\n
To test your changes or run the node explorer without packaging you must:
Note: You must have a compiled server jar in the directory root
\n
\n
cd ./server && ./gradlew bootJar, move compiled jar in ./server/build/libs to the root.
\n
\n
Then run: npm run electron-pack
\n\n
Deploy or Run Node Explorer with Docker
\n
You can build docker images using the provided DockerFile(s). You will need to build two images, one for the Node Explorer front end ./DockerFile and another for the backend Node Server ./server/DockerFile (the Node Server DockerFile utilizes layers so you will need to extract the jar - see A Better Dockerfile)
\n
If you DO NOT want to build your own images you can simply run Node Explorer using the docker-compose.yml and with contributed images. Follow the steps below:
Provide cordapps path as /cordapps in settings tab.
\n
/cordapps\n
\n
",
"readmeOriginal": "
Node Explorer
\n
Stand alone desktop app for Win/Osx/Linux that allows connecting to a local or remote Corda node. Examine transactions, run flows and view node and network properties in a few simple clicks.
\n
Downloading the Node Explorer Binaries
\n
If you're looking to download the node explorer and get started using it; download the latest packaged release on this repo's releases page.
\n
There are install packages for Linux, OSX and Windows.
\n
To login to your Corda node, you will need to provide the:
\n
\n
Hostname (domain, IP, or localhost)
\n
Rpc Port
\n
Username
\n
Password
\n
\n
Notes: You can find the Rpc port in your node config under rpcSettings->address or as displayed in a CraSH shell instance. If you have not explicitly set a username/password project defaults are user1 and test.
\n
Full instructions for using the Node-Explorer application at the documentation
\n\n
Setting up for Node Explorer for Development
\n
Note: This repository uses sub-modules. If cloning use git clone --recursive to automatically initialize and update the submodules.
Note this project uses the node-server submodule available at https://github.com/corda/node-server this must be initialised either by passing the --recursive option when running git clone OR executing the following commands.
\n\n
git submodule init
\n
git submodule update*
\n\n
*this command must also be run after any pull request which includes updates to the submodule. An alternative is to do pull requests with the following option:\ngit pull --recurse-submodules
\n
Other submodule commands:
\n
\n
\n
Fetch and merge the latest node-server submodule code
\n
\n
git submodule update --remote
\n
\n
\n
\n
Doing work on the submodule i.e. changing files in ./server
\n
\n
submodules default to a detached head, so change to server directory and checkout a branch
\n
cd ./server
\n
git checkout master
\n
Add or commit your changes as usual.
\n
\n
\n
\n
To PULL submodule updates from server side, if there are changes on your local branch either merge or rebase with the pull
\n
\n
From MAIN project directory
\n
git submodule update --remote --merge OR
\n
git submodule update --remote --rebase
\n
\n
\n
\n
To PUSH submodule updates to server side
\n
\n
From MAIN project directory
\n
git push --recurse-submodules=on-demand
\n
\n
\n
\n
Running the Node Explorer w/o packaging
\n
To test your changes or run the node explorer without packaging you must:
Note: You must have a compiled server jar in the directory root
\n
\n
cd ./server && ./gradlew bootJar, move compiled jar in ./server/build/libs to the root.
\n
\n
Then run: npm run electron-pack
\n\n
Deploy or Run Node Explorer with Docker
\n
You can build docker images using the provided DockerFile(s). You will need to build two images, one for the Node Explorer front end ./DockerFile and another for the backend Node Server ./server/DockerFile (the Node Server DockerFile utilizes layers so you will need to extract the jar - see A Better Dockerfile)
\n
If you DO NOT want to build your own images you can simply run Node Explorer using the docker-compose.yml and with contributed images. Follow the steps below:
To clone and run this application, you'll need Git and Node.js (which comes with npm) installed on your computer. From your command line:
\n
# Clone this repository\n$ git clone https://github.com/amitmerchant1990/correo\n\n# Go into the repository\n$ cd correo\n\n# Install dependencies\n$ npm install\n\n# Run the app\n$ npm start
\n
Note: If you're using Linux Bash for Windows, see this guide or use node from the command prompt.
\n
Download
\n
Download the portable version of Correo for Windows, macOS and Linux from here.
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
\n
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
\n
THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
To clone and run this application, you'll need Git and Node.js (which comes with npm) installed on your computer. From your command line:
\n
# Clone this repository\n$ git clone https://github.com/amitmerchant1990/correo\n\n# Go into the repository\n$ cd correo\n\n# Install dependencies\n$ npm install\n\n# Run the app\n$ npm start
\n
Note: If you're using Linux Bash for Windows, see this guide or use node from the command prompt.
\n
Download
\n
Download the portable version of Correo for Windows, macOS and Linux from here.
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
\n
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
\n
THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
A desktop application which allows you to batch download a course from coursehunters. Coursehunters is a platform where you can download online courses for free, learn and spread knowledge.
A desktop application which allows you to batch download a course from coursehunters. Coursehunters is a platform where you can download online courses for free, learn and spread knowledge.
Cozy Drive for Desktop allows you to synchronize the files stored in\nyour Cozy with your laptop and/or desktop computer. It\nreplicates your files on your hard drive and apply changes you made on them on\nother synced devices and on your online Cozy.
\n
This is where the app is being developped. If you just want to install it,\nplease see the Download page.
Cozy Drive for Desktop allows you to synchronize the files stored in\nyour Cozy with your laptop and/or desktop computer. It\nreplicates your files on your hard drive and apply changes you made on them on\nother synced devices and on your online Cozy.
\n
This is where the app is being developped. If you just want to install it,\nplease see the Download page.
This project is a Web application that allow the user to check daily cases and much more information about covid-19. (Example: daily cases, daily death, daily recovery, total cases, total death, total recovery, active cases and numbers of tests). This Web application has been made with React*, Nodejs and Electronjs for desktop version (Windows, MacOS, Linux). Mobile version (iOS, Android) can use PWA by adding the website to home screen and use it just like a native app.
This project is a Web application that allow the user to check daily cases and much more information about covid-19. (Example: daily cases, daily death, daily recovery, total cases, total death, total recovery, active cases and numbers of tests). This Web application has been made with React*, Nodejs and Electronjs for desktop version (Windows, MacOS, Linux). Mobile version (iOS, Android) can use PWA by adding the website to home screen and use it just like a native app.
CrossOver allows you to place a customizable crosshair overlay above any application window.\nImprove your aim and gain a competitive advantage with a permanant colored crosshair to mark center screen.
Other crosshair programs offer a single style or color option, and often don't allow you to reposition them. CrossOver is a small, unintrusive crosshair overlay which has plenty of configuration options to assist with aiming and vision of your crosshair. CrossOver offers a huge improvement to many games' default crosshairs for those with colorblindness or contrast issues.
\n
Thanks to Reddit user /u/IrisFlame for the premade library of crosshairs!
\n\n
Install
\n
macOS 10.10+, Linux, and Windows 7+ are supported.
\n
Download the latest version of CrossOver from the releases page
\n
Because this app is Free and Open-Source, we cannot afford to sign our code. This means Chrome may warn about an untrusted download, this is normal. Click the arrow icon -> Keep to finish downloading. Windows Defender and Mac Gatekeeper will prevent you from running the app the first time.
\n
Windows
\n
Download the .exe file. (CrossOver-Setup-x.x.x.exe)
Position: Click and drag the crosshair to anywhere on any screen. Double-click the bullseye to center the app.
\n
Choose Crosshair: Click the bullseye ◎ to select from tons of preloaded crosshairs. Drag an image to the window to use your own custom crosshair.
\n
Customize settings using the \"gear\" icon. See Settings below.
\n
Unlock the app to quit using Control-Alt-Shift-X, then click the close icon in the top-left corner. In Windows you can right-click on the crosshair window > Close.
\n
Default Keyboard Shortcuts
\n
\n\n
\n
Description
\n
Keys
\n
\n\n\n
\n
Toggle the settings window and lock the crosshair in place
\n
Control-Alt-Shift-X
\n
\n
\n
Move the crosshair a single pixel
\n
Control-Alt-Shift-Arrows
\n
\n
\n
Quickly hide/show the application
\n
Control-Alt-Shift-H
\n
\n
\n
Center the crosshair window
\n
Control-Alt-Shift-C
\n
\n
\n
Move the crosshair to the next connected display
\n
Control-Alt-Shift-M
\n
\n
\n
Duplicate your crosshair in a shadow window
\n
Control-Alt-Shift-D
\n
\n
\n
Display the \"About\" window details
\n
Control-Alt-Shift-A
\n
\n
\n
Reset all settings and center the window
\n
Control-Alt-Shift-R
\n
\n\n
\n
Mac: the Option key is used instead of Alt.
\n
Linux: Some distributions do not center on double-click.
\n
\n \n
\n---\n
Settings
\n
Crosshair
\n
Choose from over 100 real and fictional crosshairs, or use your own by dragging an image to the window. You can change the size and opacity.
\n
Reticle
\n
The reticle is the small dot or cross at the center of the sight. You can select the shape and the color, or this can be turned off.
\n
Hide on ADS
\n
Choose a mouse button to use as your ADS button. The crosshair will be hidden while this button is held down.
\n
Harware acceleration
\n
A handful of users have reported FPS issues with certain games (#70), CrossOver should not add any FPS or latency so if you experience it, toggle this setting on or off and disable Hide on ADS
\n
Start on boot
\n
You can automatically set CrossOver to start when your system starts on your gaming PC, so you're always ready to pop heads.
\n
Automatic Updates
\n
By default CrossOver will automatically keep itself updated with bug fixes and improvements. You can disable this in the settings to prevent all network requests.\nCrossOver will only connect to GitHub to download published releases and does not send or store any personal data. I'm a solo developer and you aren't important to me 🙂 I just want to game.
\n
Keybinds
\n
\n
See default keyboard shortcuts.\nAll of the keybinds can be changed or disabled except for the bind to reset all settings. Click into the input and press your bind, or press Backspace or Delete to disable a bind.
\n
\n
Keep in mind that keybinds may conflict with other programs so be careful about what you choose. There's no real mechanism for preventing you from setting two conflicting keyinds within the app, so don't do that.
\n
Duplicate crosshairs
\n
Duplicate crosshair windows use the same settings as the main window and do not support all of the features of the main window. Settings for duplicate crosshairs will not be saved and all duplicate windows will be closed if the main window is closed. Duplicate crosshairs cannot follow the mouse.
\n
Reset
\n
To reset all settings and binds to default, press Control-Alt-Shift-R
CrossOver allows you to place a customizable crosshair overlay above any application window.\nImprove your aim and gain a competitive advantage with a permanant colored crosshair to mark center screen.
Other crosshair programs offer a single style or color option, and often don't allow you to reposition them. CrossOver is a small, unintrusive crosshair overlay which has plenty of configuration options to assist with aiming and vision of your crosshair. CrossOver offers a huge improvement to many games' default crosshairs for those with colorblindness or contrast issues.
\n
Thanks to Reddit user /u/IrisFlame for the premade library of crosshairs!
\n\n
Install
\n
macOS 10.10+, Linux, and Windows 7+ are supported.
\n
Download the latest version of CrossOver from the releases page
\n
Because this app is Free and Open-Source, we cannot afford to sign our code. This means Chrome may warn about an untrusted download, this is normal. Click the arrow icon -> Keep to finish downloading. Windows Defender and Mac Gatekeeper will prevent you from running the app the first time.
\n
Windows
\n
Download the .exe file. (CrossOver-Setup-x.x.x.exe)
Position: Click and drag the crosshair to anywhere on any screen. Double-click the bullseye to center the app.
\n
Choose Crosshair: Click the bullseye ◎ to select from tons of preloaded crosshairs. Drag an image to the window to use your own custom crosshair.
\n
Customize settings using the \"gear\" icon. See Settings below.
\n
Unlock the app to quit using Control-Alt-Shift-X, then click the close icon in the top-left corner. In Windows you can right-click on the crosshair window > Close.
\n
Default Keyboard Shortcuts
\n
\n\n
\n
Description
\n
Keys
\n
\n\n\n
\n
Toggle the settings window and lock the crosshair in place
\n
Control-Alt-Shift-X
\n
\n
\n
Move the crosshair a single pixel
\n
Control-Alt-Shift-Arrows
\n
\n
\n
Quickly hide/show the application
\n
Control-Alt-Shift-H
\n
\n
\n
Center the crosshair window
\n
Control-Alt-Shift-C
\n
\n
\n
Move the crosshair to the next connected display
\n
Control-Alt-Shift-M
\n
\n
\n
Duplicate your crosshair in a shadow window
\n
Control-Alt-Shift-D
\n
\n
\n
Display the \"About\" window details
\n
Control-Alt-Shift-A
\n
\n
\n
Reset all settings and center the window
\n
Control-Alt-Shift-R
\n
\n\n
\n
Mac: the Option key is used instead of Alt.
\n
Linux: Some distributions do not center on double-click.
\n
\n \n
\n---\n
Settings
\n
Crosshair
\n
Choose from over 100 real and fictional crosshairs, or use your own by dragging an image to the window. You can change the size and opacity.
\n
Reticle
\n
The reticle is the small dot or cross at the center of the sight. You can select the shape and the color, or this can be turned off.
\n
Hide on ADS
\n
Choose a mouse button to use as your ADS button. The crosshair will be hidden while this button is held down.
\n
Harware acceleration
\n
A handful of users have reported FPS issues with certain games (#70), CrossOver should not add any FPS or latency so if you experience it, toggle this setting on or off and disable Hide on ADS
\n
Start on boot
\n
You can automatically set CrossOver to start when your system starts on your gaming PC, so you're always ready to pop heads.
\n
Automatic Updates
\n
By default CrossOver will automatically keep itself updated with bug fixes and improvements. You can disable this in the settings to prevent all network requests.\nCrossOver will only connect to GitHub to download published releases and does not send or store any personal data. I'm a solo developer and you aren't important to me 🙂 I just want to game.
\n
Keybinds
\n
\n
See default keyboard shortcuts.\nAll of the keybinds can be changed or disabled except for the bind to reset all settings. Click into the input and press your bind, or press Backspace or Delete to disable a bind.
\n
\n
Keep in mind that keybinds may conflict with other programs so be careful about what you choose. There's no real mechanism for preventing you from setting two conflicting keyinds within the app, so don't do that.
\n
Duplicate crosshairs
\n
Duplicate crosshair windows use the same settings as the main window and do not support all of the features of the main window. Settings for duplicate crosshairs will not be saved and all duplicate windows will be closed if the main window is closed. Duplicate crosshairs cannot follow the mouse.
\n
Reset
\n
To reset all settings and binds to default, press Control-Alt-Shift-R
Crypter is a cross-platform crypto app that makes encryption and decryption\nconvenient while still upholding strong security. It tackles one of the weakest\nlinks in most security systems today - weak passwords. It simplifies secure\npassword generation and management and requires you to only remember one bit -\nyour MasterPass.
\n
Crypter v4.0 is a crypto\napp that can decrypt and encrypt any arbitrary data this includes files and\nfolders. This version has been released and fully tested for macOS (OSX), Linux\n(for all distros via AppImage) and Windows (32 & 64\nbit). All core modules (modules that provide the core functionality) are fully\ntested.
\n
Crypter v5.0 will save your MasterPass\nin your OS's Keychain so you won't have to enter it every time you open the app.\nTo help speed up the development please send a PR for what's left do https://github.com/HR/Crypter/milestone/4
\n
Please open an issue if you have any suggestions and add improvements via PRs!
All prebuilt binaries for all major platforms are available under\nreleases.
\n
Crypter is also on Homebrew Cask for\nmacOS. So to install it, simply run the following command in the Terminal:
\n
$ brew install --cask crypter@4.0.0
\n \n
Screens
\n
\n \n \n \n \n
\n \n
Crypto
\n
\n
One key to derive them all!
\n
\n
Crypter derives a MasterPassKey from the MasterPass obtained at setup by using\nthe PBKDF2 key derivation algorithm (see below for the specification). It\nthen uses PBKDF2 to derive a number of encryption keys from the MasterPassKey\nthat can be used for the encryption of files. This method allows for the\ngeneration of very secure encryption keys for data encryption. Moreover, by\npublicly storing the credentials used to derive the MasterPassKey and the salts\nused to derive the encryption keys, you are able to produce the encryption keys\nat will and without needing to store them securely. Your MasterPass is the only\nthing that you need to remember.
\n
Crypter never directly encrypts anything with your MasterPass. Instead, it\nderives a MasterPassKey from it, which it then uses to derive the\nencryption key used to encrypt your file. Every time a file is decrypted,\nthe encryption key is re-derived from the MasterPassKey. Every time you set the\nMasterPass through the setup or reset it through Verify MasterPass, the\nMasterPassKey is derived from the MasterPass using a newly generated set of\n(random) credentials. These credentials are used to re-derive the MasterPassKey\nevery time that Crypter is executed (i.e. the app is launched).
\n
Authentication with the AES-256-GCM symmetric block cipher is used by default.\nThis ensures that data integrity is verified on decryption and allows the app\nto detect tampering or data corruption.
\n
The following are the crypto defaults and can be found under app/config.js:
When encrypting a file, Crypter first creates a temporary hidden directory,\nnamely '.crypting'. It then encrypts the user-selected file with the crypto\ndefaults and flushes the encrypted data to a file in the directory, namely\n'data'. If it is a directory then it is compressed first (tar). It also writes\nthe public credentials to a file within the same directory, namely 'creds'.\nFinally, Crypter compresses the directory to a tar archive with the name of the\nuser-selected file and the '.crypto' extension appended to it.
\n
Decryption process
\n
The decryption process is essentially the inverse of the encryption process.\nDuring decryption, Crypter creates a temporary hidden directory named\n'.decrypting'. It then reads the credentials from the creds file and decrypts\nthe data file into the original file or directory (after decompressing it) with\nits original name and extension, as deduced from the CRYPTO file name (e.g. the\nextension for \"file.txt.crypto\" would be \".txt\").
\n
Public credentials
\n
Certain credentials are required to decrypt the encrypted data. These are\nneeded to reconstruct the particular encryption key and to verify data integrity.\nThese can be stored publicly without compromising security since it is fairly\nimpossible (by current standards) to reconstruct the encryption key without the\nMasterPass and its credentials. These credentials are stored in the creds file of\nthe CRYPTO file archive (as delineated above) in the following\nformat:
A CRYPTO file is the product of the Crypter encryption process. This file\nstores both the encrypted version of the user file and the public credentials\nneeded to encrypt and decrypt it. It has a .crypto file extension, which\nis appended to the full file name (including the extension) of the file\noriginally encrypted. The file itself is a tar archive in the following\nstructure:
\n
someFile.crypto\n├── data // the encrypted version of the user selected file\n└── creds // the public credentials used to encrypt it
\n
Reusing the same MasterPass
\n
If you attempt to decrypt a CRYPTO file by resetting to a specific\nMasterPass or setting an identical MasterPass on a different machine,\nyou will likely encounter the following error:
\n
ERROR: Unsupported state or unable to authenticate data\n
\n
This issue occurs because the MasterPassKey that was originally used to\nderive the encryption key on is not the same as the MasterPassKey\nderived with the reused MasterPass. Since Crypter uses randomness to\ngenerate secure credentials, this second set of credentials will be quite\ndifferent from the original set. As a result, the derived encryption key is\nincorrect and yields this error.
To achieve portability on Crypter, the set of MasterPassKey credentials\nneed to be exported from Crypter on the source machine1\nand imported into Crypter on the target machine2.
Please refer to the FAQs for instructions on how to perform the above steps.
\n\n
[1] The machine where the CRYPTO file was initially\nencrypted.
\n
[2] The machine where you wish to decrypt the CRYPTO\nfile.
\n \n
Security
\n
Security-first practice
\n
Crypter follows a security-first practice. This means that security is its\nhighest priority and first consideration. Thus, while Crypter seeks\nto make encryption more convenient, it always defers to maintaining\na high level of security.
\n
MasterPass
\n
Crypter never stores your MasterPass in memory or on the filesystem. This\nsubstantially improves the security of your MasterPass. You are only asked to\nenter the MasterPass when you first set, reset or verify it. Whenever you enter\nyour MasterPass, Crypter derives a MasterPassKey (using a set of generated\ncredentials) and then immediately discards the MasterPass. The MasterPassKey is\nthen securely stored in memory and used to derive the encryption keys. Since\nthese credentials are derived via a one-way function, they cannot be used in\nany way to derive the MasterPass.
\n
MasterPassKey
\n
Crypter uses a WeakMap to store the MasterPassKey inside the MasterPassKey class\nusing a closure function. This makes the MasterPassKey data held in the object\n(externally) inaccessible, consequently increasing the protection of the\nMasterPassKey. The MasterPassKey is never flushed to the filesystem and is always\nstored in (main) memory. Since JS does not give control over or allow such a\nlow-level operation as wiping memory, the program relies on the garbage\ncollection and volatility of the main memory for the permanent erasure of the\nMasterPassKey stored in memory.
\n
A decent number of iterations (see the above specifications) are used in the\nderivation of the MasterPassKey to mitigate brute-force attacks. A good\namount of iterations are also used during the derivation of the encryption\nkeys from the MasterPassKey. Consequently, performance and speed are not\nsignificantly compromised. For critical applications, you may choose to\nselect 10,000,000 iterations instead of the default number\n(in app/core/crypto.js). Please refer to\nhttp://nvlpubs.nist.gov/nistpubs/Legacy/SP/nistspecialpublication800-132.pdf for\nmore information.
\n
Crypter generates a new set of random credentials for deriving the MasterPassKey\nevery time the MasterPass is set (at setup) or reset. Crypter employs randomness\nto mitigate brute-force attacks and thus drastically improve security.
\n \n
FAQs
\n
How do I encrypt a file or folder?
\n
If you haven't already, walk through the setup and set your MasterPass.\nTo encrypt a file or folder, first launch Crypter and verify your MasterPass.\nAfter doing so successfully, you will see the main Crypter window with an orange\narea. Here, you can simply drag-and-drop or click to select the file/folder you\nwish to encrypt. Once Crypter is done encrypting your file/folder, it will show\nyou the encryption information (i.e. the encryption key and the path of the\nencrypted file) in a new window. To encrypt another file/folder simply click the\nback arrow at the bottom left and start-over ;)
\n
How do I decrypt a CRYPTO file?
\n
\n
The following instructions assume that the CRYPTO file that you wish to\ndecrypt is being used with the same MasterPass that you set at setup and also\nthat you have not reset it since that time. If this is not the case, please refer\nto Reusing the same MasterPass.
\n
\n
To decrypt a CRYPTO file, first launch Crypter and verify your MasterPass. After\ndoing so successfully, you will see the main Crypter window with an orange area.\nHere, you can simply drag-and-drop or click to select the CRYPTO file that you\nwish to decrypt. After a few seconds, the process will complete and you will see\nsome information about the file and its original encryption in a new window. By\ndefault, the decrypted file has the same name as the name of the original file\n(i.e. the encrypted file name without the .crypto at the end).
\n
How do I encrypt multiple files?
\n
Crypter can encrypt an entire folder so you can put them in a folder or,\nalternatively, compress them into an archive (like a .zip) and then just pass\nit to Crypter ;)
\n
Why am I getting the \"Corrupted Crypter file or trying to decrypt on a different machine.\" error?
\n
This error means that either your Crypter file (i.e. the data file) is\ncorrupt/tempered, that you are on a different machine than the one originally\nused to encrypt the file or that you have previously reset your MasterPass.\nFor the last two cases, please refer to\nReusing the same MasterPass and\nAchieving portability and same MasterPass reuse.
\n
Why can't I decrypt a CRYPTO file on a different machine with the same MasterPass?
Where are my encrypted/decrypted files/folders placed?
\n
By default, every source file that you encrypt/decrypt gets encrypted/decrypted\nto the same directory where the source file is located.
\n
How can I access Crypter's preferences?
\n
You can access Crypter's preferences by either clicking on the cog icon in the\nmain Crypter window or by going to Crypter > Preferences... from the menu.
\n
How can I reset my MasterPass?
\n
You can reset your MasterPass by clicking on the \"Forgot it\" link in the Verify\nMasterPass window. This takes you to a new screen where you can enter a new, valid\nMasterPass. Once you've entered it, click the 'Reset' button and you'll be sent\nback to the verify screen where you can verify your new MasterPass.
\n
What is a valid MasterPass?
\n
Crypter will not allow you to set an invalid MasterPass. A MasterPass is valid\nwhen it adheres to the following rules:
\n
\n
It is at least 8 characters long
\n
It has at least one uppercase alphabetic character (A-Z)
\n
It has at least one lowercase alphabetic character (a-z)
\n
It has at least one numeric character (0-9)
\n
It has at least one special character ($@!%*#?&)
\n
\n
These rules are enforced via the following regular expression:
MasterPass credentials are a set of values that are required to derive the\nMasterPassKey from the MasterPass. These values have a pseudo-random element and\nare cryptographically linked. Every MasterPass that is set or reset with Crypter\nhas a unique set of MasterPass credentials. These yield a distinct MasterPassKey,\neven when a MasterPass is reused.
\n
How can I export my MasterPass credentials?
\n
To export your MasterPass credentials, you can first open Crypter's\npreferences (see above). From this screen, click on the \"Export\" button. A\ndialog will appear from which you can select the folder where you wish to export\nthe credentials. A success message will confirm a successful export. The\nexported MasterPass credentials file is always named credentials.crypter.
\n
How can I import my MasterPass credentials?
\n
To import a set of MasterPass credentials, you can first open Crypter's\npreferences (see above). From this screen, click on the \"Import\" button. A\ndialog will appear from which you can locate your credentials.crypter file.\nAfter you select it, a success message will confirm a successful import and\nyou will have to verify the MasterPass for the credentials.
\n
NOTE: while Crypter does not require the MasterPass credentials file to be\nexactly named credentials.crypter, it does require the file's contents to\nbe unaltered from when it was exported from Crypter. If it has been altered,\nthe import may fail.
\n \n
Development
\n
Crypter is developed in the \"dev\" branch, which may be unstable at times.\nThis branch should typically be used for pull requests.
\n
The \"master\" branch will always be kept stable.
\n
Configurations
\n
All major configurations that you can apply are found under app/config.js.\nThis includes changes to certain cryptography settings. Please be advised\nthat altering these may break functionality and\nportability.
\n
Install (dependencies)
\n
To install all dependencies, run:
\n
$ yarn install\n
\n
Run
\n
Since Crypter uses gulp, please install it globally if you have not already\ndone so. To start Crypter, run:
\n
$ gulp\n
\n
Test
\n
Crypter primarily uses mocha and chai for testing. Since the project uses a\nlot of JS ES6 syntax, babel is also used as a transpiler. To run all the tests,\nexecute:
\n
$ yarn test\n
\n
Crypter uses istanbul for coverage. To run test coverage, execute:
\n
$ yarn run coverage\n
\n
Build
\n
Crypter's binaries (available under releases) have been built using\nElectron. Since Crypter uses electron-builder to build binaries,\nyou must install it globally:
Permission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished todo so, subject to the following conditions:
\n
The above copyright notice and this permission notice shall be included in\nall copies or substantial portions of the Software.
\n
THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN\nTHE SOFTWARE.
Crypter is a cross-platform crypto app that makes encryption and decryption\nconvenient while still upholding strong security. It tackles one of the weakest\nlinks in most security systems today - weak passwords. It simplifies secure\npassword generation and management and requires you to only remember one bit -\nyour MasterPass.
\n
Crypter v4.0 is a crypto\napp that can decrypt and encrypt any arbitrary data this includes files and\nfolders. This version has been released and fully tested for macOS (OSX), Linux\n(for all distros via AppImage) and Windows (32 & 64\nbit). All core modules (modules that provide the core functionality) are fully\ntested.
\n
Crypter v5.0 will save your MasterPass\nin your OS's Keychain so you won't have to enter it every time you open the app.\nTo help speed up the development please send a PR for what's left do https://github.com/HR/Crypter/milestone/4
\n
Please open an issue if you have any suggestions and add improvements via PRs!
All prebuilt binaries for all major platforms are available under\nreleases.
\n
Crypter is also on Homebrew Cask for\nmacOS. So to install it, simply run the following command in the Terminal:
\n
$ brew install --cask crypter@4.0.0
\n \n
Screens
\n
\n \n \n \n \n
\n \n
Crypto
\n
\n
One key to derive them all!
\n
\n
Crypter derives a MasterPassKey from the MasterPass obtained at setup by using\nthe PBKDF2 key derivation algorithm (see below for the specification). It\nthen uses PBKDF2 to derive a number of encryption keys from the MasterPassKey\nthat can be used for the encryption of files. This method allows for the\ngeneration of very secure encryption keys for data encryption. Moreover, by\npublicly storing the credentials used to derive the MasterPassKey and the salts\nused to derive the encryption keys, you are able to produce the encryption keys\nat will and without needing to store them securely. Your MasterPass is the only\nthing that you need to remember.
\n
Crypter never directly encrypts anything with your MasterPass. Instead, it\nderives a MasterPassKey from it, which it then uses to derive the\nencryption key used to encrypt your file. Every time a file is decrypted,\nthe encryption key is re-derived from the MasterPassKey. Every time you set the\nMasterPass through the setup or reset it through Verify MasterPass, the\nMasterPassKey is derived from the MasterPass using a newly generated set of\n(random) credentials. These credentials are used to re-derive the MasterPassKey\nevery time that Crypter is executed (i.e. the app is launched).
\n
Authentication with the AES-256-GCM symmetric block cipher is used by default.\nThis ensures that data integrity is verified on decryption and allows the app\nto detect tampering or data corruption.
\n
The following are the crypto defaults and can be found under app/config.js:
When encrypting a file, Crypter first creates a temporary hidden directory,\nnamely '.crypting'. It then encrypts the user-selected file with the crypto\ndefaults and flushes the encrypted data to a file in the directory, namely\n'data'. If it is a directory then it is compressed first (tar). It also writes\nthe public credentials to a file within the same directory, namely 'creds'.\nFinally, Crypter compresses the directory to a tar archive with the name of the\nuser-selected file and the '.crypto' extension appended to it.
\n
Decryption process
\n
The decryption process is essentially the inverse of the encryption process.\nDuring decryption, Crypter creates a temporary hidden directory named\n'.decrypting'. It then reads the credentials from the creds file and decrypts\nthe data file into the original file or directory (after decompressing it) with\nits original name and extension, as deduced from the CRYPTO file name (e.g. the\nextension for \"file.txt.crypto\" would be \".txt\").
\n
Public credentials
\n
Certain credentials are required to decrypt the encrypted data. These are\nneeded to reconstruct the particular encryption key and to verify data integrity.\nThese can be stored publicly without compromising security since it is fairly\nimpossible (by current standards) to reconstruct the encryption key without the\nMasterPass and its credentials. These credentials are stored in the creds file of\nthe CRYPTO file archive (as delineated above) in the following\nformat:
A CRYPTO file is the product of the Crypter encryption process. This file\nstores both the encrypted version of the user file and the public credentials\nneeded to encrypt and decrypt it. It has a .crypto file extension, which\nis appended to the full file name (including the extension) of the file\noriginally encrypted. The file itself is a tar archive in the following\nstructure:
\n
someFile.crypto\n├── data // the encrypted version of the user selected file\n└── creds // the public credentials used to encrypt it
\n
Reusing the same MasterPass
\n
If you attempt to decrypt a CRYPTO file by resetting to a specific\nMasterPass or setting an identical MasterPass on a different machine,\nyou will likely encounter the following error:
\n
ERROR: Unsupported state or unable to authenticate data\n
\n
This issue occurs because the MasterPassKey that was originally used to\nderive the encryption key on is not the same as the MasterPassKey\nderived with the reused MasterPass. Since Crypter uses randomness to\ngenerate secure credentials, this second set of credentials will be quite\ndifferent from the original set. As a result, the derived encryption key is\nincorrect and yields this error.
To achieve portability on Crypter, the set of MasterPassKey credentials\nneed to be exported from Crypter on the source machine1\nand imported into Crypter on the target machine2.
Please refer to the FAQs for instructions on how to perform the above steps.
\n\n
[1] The machine where the CRYPTO file was initially\nencrypted.
\n
[2] The machine where you wish to decrypt the CRYPTO\nfile.
\n \n
Security
\n
Security-first practice
\n
Crypter follows a security-first practice. This means that security is its\nhighest priority and first consideration. Thus, while Crypter seeks\nto make encryption more convenient, it always defers to maintaining\na high level of security.
\n
MasterPass
\n
Crypter never stores your MasterPass in memory or on the filesystem. This\nsubstantially improves the security of your MasterPass. You are only asked to\nenter the MasterPass when you first set, reset or verify it. Whenever you enter\nyour MasterPass, Crypter derives a MasterPassKey (using a set of generated\ncredentials) and then immediately discards the MasterPass. The MasterPassKey is\nthen securely stored in memory and used to derive the encryption keys. Since\nthese credentials are derived via a one-way function, they cannot be used in\nany way to derive the MasterPass.
\n
MasterPassKey
\n
Crypter uses a WeakMap to store the MasterPassKey inside the MasterPassKey class\nusing a closure function. This makes the MasterPassKey data held in the object\n(externally) inaccessible, consequently increasing the protection of the\nMasterPassKey. The MasterPassKey is never flushed to the filesystem and is always\nstored in (main) memory. Since JS does not give control over or allow such a\nlow-level operation as wiping memory, the program relies on the garbage\ncollection and volatility of the main memory for the permanent erasure of the\nMasterPassKey stored in memory.
\n
A decent number of iterations (see the above specifications) are used in the\nderivation of the MasterPassKey to mitigate brute-force attacks. A good\namount of iterations are also used during the derivation of the encryption\nkeys from the MasterPassKey. Consequently, performance and speed are not\nsignificantly compromised. For critical applications, you may choose to\nselect 10,000,000 iterations instead of the default number\n(in app/core/crypto.js). Please refer to\nhttp://nvlpubs.nist.gov/nistpubs/Legacy/SP/nistspecialpublication800-132.pdf for\nmore information.
\n
Crypter generates a new set of random credentials for deriving the MasterPassKey\nevery time the MasterPass is set (at setup) or reset. Crypter employs randomness\nto mitigate brute-force attacks and thus drastically improve security.
\n \n
FAQs
\n
How do I encrypt a file or folder?
\n
If you haven't already, walk through the setup and set your MasterPass.\nTo encrypt a file or folder, first launch Crypter and verify your MasterPass.\nAfter doing so successfully, you will see the main Crypter window with an orange\narea. Here, you can simply drag-and-drop or click to select the file/folder you\nwish to encrypt. Once Crypter is done encrypting your file/folder, it will show\nyou the encryption information (i.e. the encryption key and the path of the\nencrypted file) in a new window. To encrypt another file/folder simply click the\nback arrow at the bottom left and start-over ;)
\n
How do I decrypt a CRYPTO file?
\n
\n
The following instructions assume that the CRYPTO file that you wish to\ndecrypt is being used with the same MasterPass that you set at setup and also\nthat you have not reset it since that time. If this is not the case, please refer\nto Reusing the same MasterPass.
\n
\n
To decrypt a CRYPTO file, first launch Crypter and verify your MasterPass. After\ndoing so successfully, you will see the main Crypter window with an orange area.\nHere, you can simply drag-and-drop or click to select the CRYPTO file that you\nwish to decrypt. After a few seconds, the process will complete and you will see\nsome information about the file and its original encryption in a new window. By\ndefault, the decrypted file has the same name as the name of the original file\n(i.e. the encrypted file name without the .crypto at the end).
\n
How do I encrypt multiple files?
\n
Crypter can encrypt an entire folder so you can put them in a folder or,\nalternatively, compress them into an archive (like a .zip) and then just pass\nit to Crypter ;)
\n
Why am I getting the \"Corrupted Crypter file or trying to decrypt on a different machine.\" error?
\n
This error means that either your Crypter file (i.e. the data file) is\ncorrupt/tempered, that you are on a different machine than the one originally\nused to encrypt the file or that you have previously reset your MasterPass.\nFor the last two cases, please refer to\nReusing the same MasterPass and\nAchieving portability and same MasterPass reuse.
\n
Why can't I decrypt a CRYPTO file on a different machine with the same MasterPass?
Where are my encrypted/decrypted files/folders placed?
\n
By default, every source file that you encrypt/decrypt gets encrypted/decrypted\nto the same directory where the source file is located.
\n
How can I access Crypter's preferences?
\n
You can access Crypter's preferences by either clicking on the cog icon in the\nmain Crypter window or by going to Crypter > Preferences... from the menu.
\n
How can I reset my MasterPass?
\n
You can reset your MasterPass by clicking on the \"Forgot it\" link in the Verify\nMasterPass window. This takes you to a new screen where you can enter a new, valid\nMasterPass. Once you've entered it, click the 'Reset' button and you'll be sent\nback to the verify screen where you can verify your new MasterPass.
\n
What is a valid MasterPass?
\n
Crypter will not allow you to set an invalid MasterPass. A MasterPass is valid\nwhen it adheres to the following rules:
\n
\n
It is at least 8 characters long
\n
It has at least one uppercase alphabetic character (A-Z)
\n
It has at least one lowercase alphabetic character (a-z)
\n
It has at least one numeric character (0-9)
\n
It has at least one special character ($@!%*#?&)
\n
\n
These rules are enforced via the following regular expression:
MasterPass credentials are a set of values that are required to derive the\nMasterPassKey from the MasterPass. These values have a pseudo-random element and\nare cryptographically linked. Every MasterPass that is set or reset with Crypter\nhas a unique set of MasterPass credentials. These yield a distinct MasterPassKey,\neven when a MasterPass is reused.
\n
How can I export my MasterPass credentials?
\n
To export your MasterPass credentials, you can first open Crypter's\npreferences (see above). From this screen, click on the \"Export\" button. A\ndialog will appear from which you can select the folder where you wish to export\nthe credentials. A success message will confirm a successful export. The\nexported MasterPass credentials file is always named credentials.crypter.
\n
How can I import my MasterPass credentials?
\n
To import a set of MasterPass credentials, you can first open Crypter's\npreferences (see above). From this screen, click on the \"Import\" button. A\ndialog will appear from which you can locate your credentials.crypter file.\nAfter you select it, a success message will confirm a successful import and\nyou will have to verify the MasterPass for the credentials.
\n
NOTE: while Crypter does not require the MasterPass credentials file to be\nexactly named credentials.crypter, it does require the file's contents to\nbe unaltered from when it was exported from Crypter. If it has been altered,\nthe import may fail.
\n \n
Development
\n
Crypter is developed in the \"dev\" branch, which may be unstable at times.\nThis branch should typically be used for pull requests.
\n
The \"master\" branch will always be kept stable.
\n
Configurations
\n
All major configurations that you can apply are found under app/config.js.\nThis includes changes to certain cryptography settings. Please be advised\nthat altering these may break functionality and\nportability.
\n
Install (dependencies)
\n
To install all dependencies, run:
\n
$ yarn install\n
\n
Run
\n
Since Crypter uses gulp, please install it globally if you have not already\ndone so. To start Crypter, run:
\n
$ gulp\n
\n
Test
\n
Crypter primarily uses mocha and chai for testing. Since the project uses a\nlot of JS ES6 syntax, babel is also used as a transpiler. To run all the tests,\nexecute:
\n
$ yarn test\n
\n
Crypter uses istanbul for coverage. To run test coverage, execute:
\n
$ yarn run coverage\n
\n
Build
\n
Crypter's binaries (available under releases) have been built using\nElectron. Since Crypter uses electron-builder to build binaries,\nyou must install it globally:
Permission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished todo so, subject to the following conditions:
\n
The above copyright notice and this permission notice shall be included in\nall copies or substantial portions of the Software.
\n
THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN\nTHE SOFTWARE.
КриптоАРМ ГОСТ - это новый уровень развития знакомой многим программы КриптоАРМ. Новое приложение обеспечивает возможность создания и проверки электронной подписи файлов с произвольным расширением на операционных системах Windows, Linux и macOS.
\n
КриптоАРМ ГОСТ работает с сертификатами и ключами усиленной квалифицированной электронной подписи и полностью совместим с криптопровайдером СКЗИ КриптоПро CSP начиная с версии 4.0.
\n
В приложении поддержаны стандарты для электронной подписи и хеширования ГОСТ Р 34.10-2012 и ГОСТ Р 34.11-2012, которые с должны заменить прекращающие свое действие стандарты ГОСТ Р 34.10-2001 и ГОСТ Р 34.11-94.
\n
\n
Функциональные возможности
\n
\n
Электронная подпись - создание (формирование) электронной подписи в двух вариантах: совмещенной и отделенной. Формат подписи CMS (PKCS#7). Проверка электронной подписи с учетом списков отозванных сертификатов. Добавление электронной подписи к уже существующей.
\n
\n
\n
Для создания усовершенствованной подписи, формата CAdES-X Long Type 1 выберите соответсвующий пункт в Параметрах и укажите ссылку TSP службы, наприvер http://qs.cryptopro.ru/tsp/tsp.srf
\n
\n
\n
Шифрование - шифрование файлов в адрес нескольких получателей. Расшифрование данных. Архивирование результатов после шифрования.
\n
\n
\n
\n
Управление сертификатами - импорт и экспорт сертификатов. Удаление выбранных сертификатов и ключей. Установка сертификатов с токенов (с контейнеров, расположенных на отчуждаемых носителях). Отправка запросов и получение сертификатов с использованием ПАК КриптоПро УЦ 2.0. Установка сертификатов из DSS. Автоматическое построение и проверка цепочки сертификатов.
\n
\n
\n
\n
Журнал операций - журналирование выполненных пользователем операций
\n
\n
\n
\n
Документы - быстрый доступ к документам, с возможностью выполнения операций (подпись, шифрование, архивация и т.д.)
Если у вас есть вопросы по технической поддержке, то напишите нам на support@trusted.ru или откройте обращение на странице GitHub Issues
\n
",
"readmeOriginal": "
КриптоАРМ ГОСТ
\n
\n
Описание
\n
КриптоАРМ ГОСТ - это новый уровень развития знакомой многим программы КриптоАРМ. Новое приложение обеспечивает возможность создания и проверки электронной подписи файлов с произвольным расширением на операционных системах Windows, Linux и macOS.
\n
КриптоАРМ ГОСТ работает с сертификатами и ключами усиленной квалифицированной электронной подписи и полностью совместим с криптопровайдером СКЗИ КриптоПро CSP начиная с версии 4.0.
\n
В приложении поддержаны стандарты для электронной подписи и хеширования ГОСТ Р 34.10-2012 и ГОСТ Р 34.11-2012, которые с должны заменить прекращающие свое действие стандарты ГОСТ Р 34.10-2001 и ГОСТ Р 34.11-94.
\n
\n
Функциональные возможности
\n
\n
Электронная подпись - создание (формирование) электронной подписи в двух вариантах: совмещенной и отделенной. Формат подписи CMS (PKCS#7). Проверка электронной подписи с учетом списков отозванных сертификатов. Добавление электронной подписи к уже существующей.
\n
\n
\n
Для создания усовершенствованной подписи, формата CAdES-X Long Type 1 выберите соответсвующий пункт в Параметрах и укажите ссылку TSP службы, наприvер http://qs.cryptopro.ru/tsp/tsp.srf
\n
\n
\n
Шифрование - шифрование файлов в адрес нескольких получателей. Расшифрование данных. Архивирование результатов после шифрования.
\n
\n
\n
\n
Управление сертификатами - импорт и экспорт сертификатов. Удаление выбранных сертификатов и ключей. Установка сертификатов с токенов (с контейнеров, расположенных на отчуждаемых носителях). Отправка запросов и получение сертификатов с использованием ПАК КриптоПро УЦ 2.0. Установка сертификатов из DSS. Автоматическое построение и проверка цепочки сертификатов.
\n
\n
\n
\n
Журнал операций - журналирование выполненных пользователем операций
\n
\n
\n
\n
Документы - быстрый доступ к документам, с возможностью выполнения операций (подпись, шифрование, архивация и т.д.)
Writing down your bitcoin recovery seeds on plain paper might be solid electronic security, but terrible physical security. Not everyone has a safe they can keep stuff like that in. CryptoSeed encrypts your recovery seed with AES256 and encodes the encrypted data into a QR Code which you can print out and keep anywhere.
\n
Why pay for solutions that still leave your seed in plain text when you can print out and laminate a business card with your encrypted recovery seed on it for free. You could keep a copy in your wallet, or in a safe, or even hide it in plain sight.
\n
\n
When it comes time to use your recovery seed, just scan the QR Code with your phone and decrypt it with CryptoSeed.
\n
\n\n
How secure is it?
\n
Your recovery seed is encrypted with the Cipher Block Chaining (CBC) mode of the Advanced Encryption Standard with a 256 bit key length. Your key is generated using a password of your choice and a random salt, hashed 1 million times with pbkdf2 (sha512). Encrypting the same data with the same key will yield a different result every time.
\n
If you forget your password, your seed is lost. There is no recovery.
\n
Whenever you type anything on a computer connected to the internet, you run the inherent risk of your information being exposed by keyloggers, viruses, and other attack vectors. This risk can be mitigated by using an offline computer or by simply typing in your recovery phrase out of order and rearranging them with the mouse afterword. Another good option would be to use a distro like Qubes.
\n
No matter what you do there is risk, but once encrypted your seed is pretty safe.
Then you can run the build for your desired platform:
\n
\tnpm run pack:linux\n\tnpm run pack:windows\n\tnpm run pack:osx
\n\n
Cryptography Notice
\n
This distribution includes cryptographic software. The country in which you currently reside may have restrictions on the import, possession, use, and/or re-export to another country, of encryption software. BEFORE using any encryption software, please check your country's laws, regulations and policies concerning the import, possession, or use, and re-export of encryption software, to see if this is permitted. See http://www.wassenaar.org/ for more information.
\n
The U.S. Government Department of Commerce, Bureau of Industry and Security (BIS), classifies this software as 5D002. The form and manner of this distribution makes it eligible for export under the License Exception ENC Technology Software Unrestricted (TSU) exception (see the BIS Export Administration Regulations, Section 740.13(e)) for both object code and source code.
\n\n
License
\n
Copyright (c) 2017 Arlen Anderson
\n
License under The MIT License (MIT)
\n
Permission is hereby granted, free of charge, to any person obtaining a copy of\nthis software and associated documentation files (the \"Software\"), to deal in\nthe Software without restriction, including without limitation the rights to\nuse, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of\nthe Software, and to permit persons to whom the Software is furnished to do so,\nsubject to the following conditions:
\n
The above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.
\n
THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS\nFOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR\nCOPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER\nIN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN\nCONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
\n\n
Donate
\n
Bitcoin: 1LPCKLyrqFRjQ8yZRyBdAo3yr5Cx6Sb37F
\n
",
"readmeOriginal": "
CryptoSeed
\n
Secure your bitcoin recovery seed.
\n
Writing down your bitcoin recovery seeds on plain paper might be solid electronic security, but terrible physical security. Not everyone has a safe they can keep stuff like that in. CryptoSeed encrypts your recovery seed with AES256 and encodes the encrypted data into a QR Code which you can print out and keep anywhere.
\n
Why pay for solutions that still leave your seed in plain text when you can print out and laminate a business card with your encrypted recovery seed on it for free. You could keep a copy in your wallet, or in a safe, or even hide it in plain sight.
\n
\n
When it comes time to use your recovery seed, just scan the QR Code with your phone and decrypt it with CryptoSeed.
\n
\n\n
How secure is it?
\n
Your recovery seed is encrypted with the Cipher Block Chaining (CBC) mode of the Advanced Encryption Standard with a 256 bit key length. Your key is generated using a password of your choice and a random salt, hashed 1 million times with pbkdf2 (sha512). Encrypting the same data with the same key will yield a different result every time.
\n
If you forget your password, your seed is lost. There is no recovery.
\n
Whenever you type anything on a computer connected to the internet, you run the inherent risk of your information being exposed by keyloggers, viruses, and other attack vectors. This risk can be mitigated by using an offline computer or by simply typing in your recovery phrase out of order and rearranging them with the mouse afterword. Another good option would be to use a distro like Qubes.
\n
No matter what you do there is risk, but once encrypted your seed is pretty safe.
Then you can run the build for your desired platform:
\n
\tnpm run pack:linux\n\tnpm run pack:windows\n\tnpm run pack:osx
\n\n
Cryptography Notice
\n
This distribution includes cryptographic software. The country in which you currently reside may have restrictions on the import, possession, use, and/or re-export to another country, of encryption software. BEFORE using any encryption software, please check your country's laws, regulations and policies concerning the import, possession, or use, and re-export of encryption software, to see if this is permitted. See http://www.wassenaar.org/ for more information.
\n
The U.S. Government Department of Commerce, Bureau of Industry and Security (BIS), classifies this software as 5D002. The form and manner of this distribution makes it eligible for export under the License Exception ENC Technology Software Unrestricted (TSU) exception (see the BIS Export Administration Regulations, Section 740.13(e)) for both object code and source code.
\n\n
License
\n
Copyright (c) 2017 Arlen Anderson
\n
License under The MIT License (MIT)
\n
Permission is hereby granted, free of charge, to any person obtaining a copy of\nthis software and associated documentation files (the \"Software\"), to deal in\nthe Software without restriction, including without limitation the rights to\nuse, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of\nthe Software, and to permit persons to whom the Software is furnished to do so,\nsubject to the following conditions:
\n
The above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.
\n
THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS\nFOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR\nCOPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER\nIN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN\nCONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
csBooks is a smart solution to manage all your PDF, EPUB and MOBI files. csBooks will automatically generate thumbnails for your books so that you can easily browse them and read them without problems. csBooks is focused on clean and beautiful interface with excellent user experience. csBooks supports PDF format of books and maintains the read status for them.
\n
Tech stack love story
\n
csBooks is made with love 💖, ElectronJS, VueJS, EpubJS, and PdfJS. It is written almost 85% in Typescript for stability and 15% in Javascript for flexibility.
\n
Installing
\n
Ubuntu Software Center or Debian x86
\n\n
Run sudo snap install csbooks.
\n
Launch csBooks using the installed csbooks command.
\n\n
\n
You can also use software center app for your linux version to install the snap file. ;)
Make it executable sudo chmod a+x csBooks_<version>.dmg
\n
Run csBooks_<version>.dmg
\n\n
Windows Users
\n\n
Open your microsoft store app and search for csBooks.
\n
Click on Install button to install the app.
\n\n
Screenshots
\n
\n\n
Epub Support
\n\n
Light and Dark Mode
\n\n
List view
\n\n
PDF File Support
\n\n
Different Themes for Reading with Comfort
\n\n
Integration of Audiobooks from Librivox
\n\n
Audio book player
\n\n
\n
Feature Suggestions
\n
To request any features, please send an email to caesiumstudio@outlook.com OR create a feature request on GitHub to keep track of it.
\n
",
- "readmeOriginal": "
\n\n
\n
\n
csBooks - A Smart Book Manager
\n\n
\n \n
\n\n
csBooks is a smart solution to manage all your PDF, EPUB and MOBI files. csBooks will automatically generate thumbnails for your books so that you can easily browse them and read them without problems. csBooks is focused on clean and beautiful interface with excellent user experience. csBooks supports PDF format of books and maintains the read status for them.
\n
Tech stack love story
\n
csBooks is made with love 💖, ElectronJS, VueJS, EpubJS, and PdfJS. It is written almost 85% in Typescript for stability and 15% in Javascript for flexibility.
\n
Installing
\n
Ubuntu Software Center or Debian x86
\n\n
Run sudo snap install csbooks.
\n
Launch csBooks using the installed csbooks command.
\n\n
\n
You can also use software center app for your linux version to install the snap file. ;)
CSV to SQLite is an electron application designed to convert comma-separated values files to SQLite databases with column type affinities. This desktop app allows a user to convert much more quickly when compared to command-line CSV to SQLite conversion methods. Instead of creating a custom conversion script for each SQLite database, a user is able to quickly adjust the parameters for how the CSV files should be converted.
\n
Compatibility
\n
CSV to SQLite is compatible with Windows, Mac OS, and Linux.
\n
Setup
\n
# clone the repository\ngit clone https://github.com/isaiahnields/csv-to-sqlite\n\n# install dependencies\nnpm install\n\n# serve with hot reload\nnpm run dev\n\n# build electron application for production\nnpm run build
CSV to SQLite is an electron application designed to convert comma-separated values files to SQLite databases with column type affinities. This desktop app allows a user to convert much more quickly when compared to command-line CSV to SQLite conversion methods. Instead of creating a custom conversion script for each SQLite database, a user is able to quickly adjust the parameters for how the CSV files should be converted.
\n
Compatibility
\n
CSV to SQLite is compatible with Windows, Mac OS, and Linux.
\n
Setup
\n
# clone the repository\ngit clone https://github.com/isaiahnields/csv-to-sqlite\n\n# install dependencies\nnpm install\n\n# serve with hot reload\nnpm run dev\n\n# build electron application for production\nnpm run build
csBooks is a smart solution to manage all your PDF, EPUB and MOBI files. csBooks will automatically generate thumbnails for your books so that you can easily browse them and read them without problems. csBooks is focused on clean and beautiful interface with excellent user experience. csBooks supports PDF format of books and maintains the read status for them.
\n
Tech stack love story
\n
csBooks is made with love 💖, ElectronJS, VueJS, EpubJS, and PdfJS. It is written almost 85% in Typescript for stability and 15% in Javascript for flexibility.
\n
Installing
\n
Ubuntu Software Center or Debian x86
\n\n
Run sudo snap install csbooks.
\n
Launch csBooks using the installed csbooks command.
\n\n
\n
You can also use software center app for your linux version to install the snap file. ;)
Make it executable sudo chmod a+x csBooks_<version>.dmg
\n
Run csBooks_<version>.dmg
\n\n
Windows Users
\n\n
Open your microsoft store app and search for csBooks.
\n
Click on Install button to install the app.
\n\n
Screenshots
\n
\n\n
Epub Support
\n\n
Light and Dark Mode
\n\n
List view
\n\n
PDF File Support
\n\n
Different Themes for Reading with Comfort
\n\n
Integration of Audiobooks from Librivox
\n\n
Audio book player
\n\n
\n
Feature Suggestions
\n
To request any features, please send an email to caesiumstudio@outlook.com OR create a feature request on GitHub to keep track of it.
\n
",
+ "readmeOriginal": "
\n\n
\n
\n
csBooks - A Smart Book Manager
\n\n
\n \n
\n\n
csBooks is a smart solution to manage all your PDF, EPUB and MOBI files. csBooks will automatically generate thumbnails for your books so that you can easily browse them and read them without problems. csBooks is focused on clean and beautiful interface with excellent user experience. csBooks supports PDF format of books and maintains the read status for them.
\n
Tech stack love story
\n
csBooks is made with love 💖, ElectronJS, VueJS, EpubJS, and PdfJS. It is written almost 85% in Typescript for stability and 15% in Javascript for flexibility.
\n
Installing
\n
Ubuntu Software Center or Debian x86
\n\n
Run sudo snap install csbooks.
\n
Launch csBooks using the installed csbooks command.
\n\n
\n
You can also use software center app for your linux version to install the snap file. ;)
CryptoBot uses CryptoJS on most of the encrytion methods. You can use this application to view these encrytion and decryption process without headache.
\n
For fun :)
\n
\n
view this app from browser
\n
yarn install\nyarn start\n
\n
view this app (electron)
\n
\nelectron .\n\">
yarn build // you need to modify the /build/index.html for the right <script src=\"\">\nelectron .\n
there may be some issues with the performance on win
\n
Thanks for the new icon by Arslanshn
\n
",
"readmeOriginal": "
It's for encrypting and decrypting your messages
\n
CryptoBot uses CryptoJS on most of the encrytion methods. You can use this application to view these encrytion and decryption process without headache.
\n
For fun :)
\n
\n
view this app from browser
\n
yarn install\nyarn start\n
\n
view this app (electron)
\n
yarn build // you need to modify the /build/index.html for the right <script src=\"\">\nelectron .\n
Ever feel JIRA's UI is hard to use? Every small action it reloads the whole page or open a brand new one. That list of subtask really doesn't let you do anything. Searching doesn't really work the way you expected and if you find the thing, you don't know how you did it.
\n
Enter DarkJ! A fluid, dark themed native desktop UI for JIRA that helps you get by your daily JIRA workflow easier. With a custom built, Angular based UI, viewing issues has never been easier. A easy-to-use tab system manages all the issues you care about in one convenient place. Live update and pinning issues let you resume work faster and a custom built search page let you search almost everything.
\n
Interested? How about heading over to the Releases page and try it out? Oh, and it's free to use by the way.
This app is a fan created work and is not an official product of JIRA or endorsed by Atlassian.
\n
Highlights
\n
\n
Angular based UI with fluid transitions and animations, no more waiting for the whole page to load.
\n
Tab based issue viewing with pin and live update, all the issues you cared about are easily within reach.
\n
Full-text based search feature that lets you search the entire JIRA, no need to fiddle with that complicated JIRA search function.
\n
Custom created controls let you do your daily tasks within DarkJ, included custom controls are:\n
\n
Assignee picker
\n
Title editor
\n
Priority changer
\n
Status changer
\n
Simple description editor
\n
\n
\n
Minimizable create issue window.
\n
Conveniently placed \"Open in JIRA\" buttons, so you can always go to your JIRA UI easily.
\n
Support multiple accounts
\n
\n
Built On
\n
\n
\n
Download & Installation
\n
Head over to the Releases page and download the latest version to get started!
\n
Windows
\n
Download the latest setup.exe and follow the installation instruction.
\n
MacOS
\n
You can download either the .zip or .dmg to use DarkJ.
\n
If you downloaded the .zip:
\n\n
Extract the content of the .zip file.
\n
You can put the extracted file in your /Applications folder for it to show up in Launchpad.
\n\n
If you downloaded the .dmg:
\n\n
Open the .dmg file.
\n
After clicking \"Agree\", drag the DarkJ icon into the Applications folder icon on screen.
\n
DarkJ should now be available in Launchpad.
\n
If there's a separate DarkJ icon appears on your Desktop, you can remove that by draggin it to the Trashcan.
\n\n
How much does this app cost?
\n
0, 🆓! It's free to use! If you like the app, maybe consider Buy me a tea, a gazillion ton of black tea went into DarkJ 😉
\n
FAQ
\n
\n
\n
It doesn't start on MacOS.
\n
Before 0.1.1, DarkJ is not signed and this has been corrected in release 0.1.1. After 0.1.1, you should be able to click \"Open\" in the warning dialog that shows up when you first start DarkJ.
\n
\n
\n
On MacOS, it asks me for permission to use Keychain Access.
\n
DarkJ uses Keychain to store you JIRA token so it will need access to your Keychain to function properly. To prevent future warning, click \"Always Allow\".
\n
\n
\n
Is my JIRA data safe?
\n
DarkJ stores your JIRA API token with your computer's built-in credential manager, on Windows, it's Credential Manager; on MacOS, it's Keychain Access.
\n
Your API token and JIRA login information is only used for authentication purposes and DarkJ will only send your JIRA data and JIRA account information to your organization's JIRA service and not anywhere else.
\n
To improve your account safety, use a dedicated API token for DarkJ.
\n
\n
\n
Is there any keyboard shortcuts?
\n
Yep, common useful shortcuts are:
\n
Ctrl + f = Open Search Page\n Ctrl + n = Open Create Issue Window\n ESC = Exit current window\n
\n
There are other shortcuts available and they are listed in the menus. For MacOS, replace Ctrl with Command.
\n
\n
\n
I am getting some timeout warning.
\n
Try clicking the \"Refresh\" button on the top-right corner or press \"F5\" to reload the app.
\n
\n
\n
I can't transition, create issue or perform some actions.
\n
Although we try to create controls for most JIRA applications, there might be fields that DarkJ doesn't support and is required to fill in during issue creation or transition.
\n
In these cases, click the \"Open External\" button (looks like a square with arrow pointing out) in the related screen and you can perform the actions with JIRA's native UI.
\n
\n
\n
Issues
\n
For any issues or feature suggestions, feel free to post in the Issues.
\n
",
"readmeOriginal": "
DarkJ
\n
\n
Ever feel JIRA's UI is hard to use? Every small action it reloads the whole page or open a brand new one. That list of subtask really doesn't let you do anything. Searching doesn't really work the way you expected and if you find the thing, you don't know how you did it.
\n
Enter DarkJ! A fluid, dark themed native desktop UI for JIRA that helps you get by your daily JIRA workflow easier. With a custom built, Angular based UI, viewing issues has never been easier. A easy-to-use tab system manages all the issues you care about in one convenient place. Live update and pinning issues let you resume work faster and a custom built search page let you search almost everything.
\n
Interested? How about heading over to the Releases page and try it out? Oh, and it's free to use by the way.
This app is a fan created work and is not an official product of JIRA or endorsed by Atlassian.
\n
Highlights
\n
\n
Angular based UI with fluid transitions and animations, no more waiting for the whole page to load.
\n
Tab based issue viewing with pin and live update, all the issues you cared about are easily within reach.
\n
Full-text based search feature that lets you search the entire JIRA, no need to fiddle with that complicated JIRA search function.
\n
Custom created controls let you do your daily tasks within DarkJ, included custom controls are:\n
\n
Assignee picker
\n
Title editor
\n
Priority changer
\n
Status changer
\n
Simple description editor
\n
\n
\n
Minimizable create issue window.
\n
Conveniently placed \"Open in JIRA\" buttons, so you can always go to your JIRA UI easily.
\n
Support multiple accounts
\n
\n
Built On
\n
\n
\n
Download & Installation
\n
Head over to the Releases page and download the latest version to get started!
\n
Windows
\n
Download the latest setup.exe and follow the installation instruction.
\n
MacOS
\n
You can download either the .zip or .dmg to use DarkJ.
\n
If you downloaded the .zip:
\n\n
Extract the content of the .zip file.
\n
You can put the extracted file in your /Applications folder for it to show up in Launchpad.
\n\n
If you downloaded the .dmg:
\n\n
Open the .dmg file.
\n
After clicking \"Agree\", drag the DarkJ icon into the Applications folder icon on screen.
\n
DarkJ should now be available in Launchpad.
\n
If there's a separate DarkJ icon appears on your Desktop, you can remove that by draggin it to the Trashcan.
\n\n
How much does this app cost?
\n
0, 🆓! It's free to use! If you like the app, maybe consider Buy me a tea, a gazillion ton of black tea went into DarkJ 😉
\n
FAQ
\n
\n
\n
It doesn't start on MacOS.
\n
Before 0.1.1, DarkJ is not signed and this has been corrected in release 0.1.1. After 0.1.1, you should be able to click \"Open\" in the warning dialog that shows up when you first start DarkJ.
\n
\n
\n
On MacOS, it asks me for permission to use Keychain Access.
\n
DarkJ uses Keychain to store you JIRA token so it will need access to your Keychain to function properly. To prevent future warning, click \"Always Allow\".
\n
\n
\n
Is my JIRA data safe?
\n
DarkJ stores your JIRA API token with your computer's built-in credential manager, on Windows, it's Credential Manager; on MacOS, it's Keychain Access.
\n
Your API token and JIRA login information is only used for authentication purposes and DarkJ will only send your JIRA data and JIRA account information to your organization's JIRA service and not anywhere else.
\n
To improve your account safety, use a dedicated API token for DarkJ.
\n
\n
\n
Is there any keyboard shortcuts?
\n
Yep, common useful shortcuts are:
\n
Ctrl + f = Open Search Page\n Ctrl + n = Open Create Issue Window\n ESC = Exit current window\n
\n
There are other shortcuts available and they are listed in the menus. For MacOS, replace Ctrl with Command.
\n
\n
\n
I am getting some timeout warning.
\n
Try clicking the \"Refresh\" button on the top-right corner or press \"F5\" to reload the app.
\n
\n
\n
I can't transition, create issue or perform some actions.
\n
Although we try to create controls for most JIRA applications, there might be fields that DarkJ doesn't support and is required to fill in during issue creation or transition.
\n
In these cases, click the \"Open External\" button (looks like a square with arrow pointing out) in the related screen and you can perform the actions with JIRA's native UI.
\n
\n
\n
Issues
\n
For any issues or feature suggestions, feel free to post in the Issues.
The DataPixels.js source code facilitates production of pixel art that is entirely generated programmatically at runtime. Additionally, the accompanying desktop application, Data Pixels Playground, may be used to write and execute code for displaying both customized and automated pixel art.
\n
DataPixels.js
\n
The DataPixels.js source code features a modular, ES2015 Class design for accessible and effortless construction of new instances. Each instance contains both HTMLCanvasElement and HTMLImageElement public accessors whose sources consist of the programmatically generated pixel art.
\n
Install
\n
DataPixels.js package can be installed as a project dependency from NPM by entering the following CLI command:
\n
npm i data-pixels\n
\n
Create
\n
The DataPixels.js constructor requires 2 arguments:
\n\n
\n
pixelData: An array containing one or more arrays of equal length, consisting of strings composed of 0-255 integer values per 24-bit RGB color channel (e.g., “255, 255, 255”) or 32-bit RGBA color channel (e.g., “255, 255, 255, 255”). Additionally, the strings may optionally contain any kind of descriptive text (e.g., “Red: 255, G - 128, 64 for Blue, Transparency = 32”) as only the number values within the string will be parsed in RGB / RGBA order. Strings that contain more than 4 numbers will throw an error.
\n
\n
\n
pixelSize: The size of each color data unit in pixels. This value represents the size of each perceived pixel that forms the pixel art.
\n
\n\n
For more information see the Example Code section below.
\n
\n
Data Pixels Playground
\n
Data Pixels Playground is a lightweight, cross-platform, desktop application for Windows, Mac and Linux, which may be used to write and execute DataPixels.js instances for previewing and testing purposes.
\n
The application features built-in example code via the Help menu as well as the ability to parse pixel data from image files to produce automatically generated code through the File > Open Image File… menu item or through drag-and-drop gestures. Additionally, compiled Data Pixels visible in the View Panel can be easily dragged, scaled and reflected using the mouse or in-app controls to help you design the perfect images for your requirements.
\n
Note: pixel color values that are automatically interpreted from image files with an embedded color space may differ slightly from the image’s intended color values.
\n
\n
Desktop Application Release Builds
\n
Creating release builds for Windows, Mac and/or Linux is a 2-step process: code compilation, then application packaging, both of which are accomplished by running command-line NPM scripts.
\n
Compilation
\n
Production code compilation can be executed by entering the following CLI command at the project root folder [~/DataPixels/ ]:
\n
npm run prod\n
\n
For more detailed information concerning code compilation please refer to Project Foundation.
\n
Packaging
\n
Application packaging can be executed for individual platforms by entering one of the following CLI commands at the project build folder [~/DataPixels/resources/build/ ]:
\n
npm run package-linux\n
\n
npm run package-mac\n
\n
npm run package-windows\n
\n
Note: In order to avoid problems with code signing and other build issues it is highly recommended to execute packaging scripts for an individual platform from its own operating system.
\n
For more detailed information concerning application packaging please refer to Electron Packager.
The DataPixels.js source code facilitates production of pixel art that is entirely generated programmatically at runtime. Additionally, the accompanying desktop application, Data Pixels Playground, may be used to write and execute code for displaying both customized and automated pixel art.
\n
DataPixels.js
\n
The DataPixels.js source code features a modular, ES2015 Class design for accessible and effortless construction of new instances. Each instance contains both HTMLCanvasElement and HTMLImageElement public accessors whose sources consist of the programmatically generated pixel art.
\n
Install
\n
DataPixels.js package can be installed as a project dependency from NPM by entering the following CLI command:
\n
npm i data-pixels\n
\n
Create
\n
The DataPixels.js constructor requires 2 arguments:
\n\n
\n
pixelData: An array containing one or more arrays of equal length, consisting of strings composed of 0-255 integer values per 24-bit RGB color channel (e.g., “255, 255, 255”) or 32-bit RGBA color channel (e.g., “255, 255, 255, 255”). Additionally, the strings may optionally contain any kind of descriptive text (e.g., “Red: 255, G - 128, 64 for Blue, Transparency = 32”) as only the number values within the string will be parsed in RGB / RGBA order. Strings that contain more than 4 numbers will throw an error.
\n
\n
\n
pixelSize: The size of each color data unit in pixels. This value represents the size of each perceived pixel that forms the pixel art.
\n
\n\n
For more information see the Example Code section below.
\n
\n
Data Pixels Playground
\n
Data Pixels Playground is a lightweight, cross-platform, desktop application for Windows, Mac and Linux, which may be used to write and execute DataPixels.js instances for previewing and testing purposes.
\n
The application features built-in example code via the Help menu as well as the ability to parse pixel data from image files to produce automatically generated code through the File > Open Image File… menu item or through drag-and-drop gestures. Additionally, compiled Data Pixels visible in the View Panel can be easily dragged, scaled and reflected using the mouse or in-app controls to help you design the perfect images for your requirements.
\n
Note: pixel color values that are automatically interpreted from image files with an embedded color space may differ slightly from the image’s intended color values.
\n
\n
Desktop Application Release Builds
\n
Creating release builds for Windows, Mac and/or Linux is a 2-step process: code compilation, then application packaging, both of which are accomplished by running command-line NPM scripts.
\n
Compilation
\n
Production code compilation can be executed by entering the following CLI command at the project root folder [~/DataPixels/ ]:
\n
npm run prod\n
\n
For more detailed information concerning code compilation please refer to Project Foundation.
\n
Packaging
\n
Application packaging can be executed for individual platforms by entering one of the following CLI commands at the project build folder [~/DataPixels/resources/build/ ]:
\n
npm run package-linux\n
\n
npm run package-mac\n
\n
npm run package-windows\n
\n
Note: In order to avoid problems with code signing and other build issues it is highly recommended to execute packaging scripts for an individual platform from its own operating system.
\n
For more detailed information concerning application packaging please refer to Electron Packager.
npm install # install dependencies\nnpm run dist :os # compile the app into an binary package
\n
FAQ
\n
How to speed up downloading Electron
\n
If you’re not in Europe or the US, you might want to use a different mirror for\nelectron. You can set the ELECTRON_MIRROR variable to point to a different\nprovider:
\n
# Europe / US\n$ npm install\n\n# Asia / Oceania\n$ ELECTRON_MIRROR=\"https://npm.taobao.org/mirrors/electron/\" npm install
SourceSansPro-Regular.ttf: Copyright 2010, 2012 Adobe Systems Incorporated (http://www.adobe.com/), with Reserved Font Name 'Source'. All Rights Reserved. Source is a trademark of Adobe Systems Incorporated in the United States and/or other countries. SIL Open Font License, 1.1
\n
SourceCodePro-Regular.ttf: Copyright 2010, 2012 Adobe Systems Incorporated. All Rights Reserved. SIL Open Font License, 1.1
npm install # install dependencies\nnpm run dist :os # compile the app into an binary package
\n
FAQ
\n
How to speed up downloading Electron
\n
If you’re not in Europe or the US, you might want to use a different mirror for\nelectron. You can set the ELECTRON_MIRROR variable to point to a different\nprovider:
\n
# Europe / US\n$ npm install\n\n# Asia / Oceania\n$ ELECTRON_MIRROR=\"https://npm.taobao.org/mirrors/electron/\" npm install
SourceSansPro-Regular.ttf: Copyright 2010, 2012 Adobe Systems Incorporated (http://www.adobe.com/), with Reserved Font Name 'Source'. All Rights Reserved. Source is a trademark of Adobe Systems Incorporated in the United States and/or other countries. SIL Open Font License, 1.1
\n
SourceCodePro-Regular.ttf: Copyright 2010, 2012 Adobe Systems Incorporated. All Rights Reserved. SIL Open Font License, 1.1
\n\nA Visual development-tool of creating mocked Json\n
Build and Dev Setup
\n
# install dependencies\nnpm install\n\n# serve with hot reload at localhost:9080\nnpm run dev\n\n# build electron application for production\nnpm run build\n\n# lint all JS/Vue component files in `src/`\nnpm run lint\n
\n\n
User Guide
\n
\n
Start development server\nIn the Server Port field, you can type a Port not occupied, then choose a language. Finally open the Server by clicking the circle on the bottom left. If the Server was initiated successfully, the circle on the top right will be change.
\n
Change your image\nAn Image URL field will be displayed by double clicking the image, then type a image's URL and double click the image again to show the new image.
\n
\n\n
\n\n\n
\n
Create key-value pairs\nIn the factory of creator, the name of key-value pairs can be edited in the Name field. If you want to add a key-value pair, type a key in the Key field and click + button. A new key will be added to the key-value pairs, what to do next is choosing a value, including primary and advanced types. Then, click the save button on the botton left to save the key-value pair. Finally, when you complete each key-value pair, click the check button on the top right to save the whole key-value pairs.
\n
\n\n
\n\n\n
\n
Inspect key-value pairs\nIn the dStore of creator, all the key-value pairs are shown in the data list. User can edit each key-value paris by clicking their name button and delete one by the red close button on the right.
\n
\n\n
\n\n\n
\n
Get the data
\n
\n
\n
http://localhost:{{port your type in the first step, e.g 9090}}/?name={{the name of key-value pairs you want}}
\n\nA Visual development-tool of creating mocked Json\n
Build and Dev Setup
\n
# install dependencies\nnpm install\n\n# serve with hot reload at localhost:9080\nnpm run dev\n\n# build electron application for production\nnpm run build\n\n# lint all JS/Vue component files in `src/`\nnpm run lint\n
\n\n
User Guide
\n
\n
Start development server\nIn the Server Port field, you can type a Port not occupied, then choose a language. Finally open the Server by clicking the circle on the bottom left. If the Server was initiated successfully, the circle on the top right will be change.
\n
Change your image\nAn Image URL field will be displayed by double clicking the image, then type a image's URL and double click the image again to show the new image.
\n
\n\n
\n\n\n
\n
Create key-value pairs\nIn the factory of creator, the name of key-value pairs can be edited in the Name field. If you want to add a key-value pair, type a key in the Key field and click + button. A new key will be added to the key-value pairs, what to do next is choosing a value, including primary and advanced types. Then, click the save button on the botton left to save the key-value pair. Finally, when you complete each key-value pair, click the check button on the top right to save the whole key-value pairs.
\n
\n\n
\n\n\n
\n
Inspect key-value pairs\nIn the dStore of creator, all the key-value pairs are shown in the data list. User can edit each key-value paris by clicking their name button and delete one by the red close button on the right.
\n
\n\n
\n\n\n
\n
Get the data
\n
\n
\n
http://localhost:{{port your type in the first step, e.g 9090}}/?name={{the name of key-value pairs you want}}
Runs as application for Windows, Linux and Mac. Or in Docker container on server and in web Browser on client.
\n
Import, export from/to CSV, Excel, JSON
\n
Free table editor - quick table data editing (cleanup data after import/before export, prototype tables etc.)
\n
Archives - backup your data in JSON files on local filesystem (or on DbGate server, when using web application)
\n
Charts
\n
For detailed info, how to run DbGate in docker container, visit docker hub
\n
Extensible plugin architecture
\n
\n
How to contribute
\n
Any contributions are welcome. If you want to contribute without coding, consider following:
\n
\n
Create issue, if you find problem in app, or you have idea to new feature. If issue already exists, you could leave comment on it, to prioritise most wanted issues.
\n
Tell your friends about DbGate or share on social networks - when more people will use DbGate, it will grow to be better
\n
\n
Why is DbGate different
\n
There are many database managers now, so why DbGate?
\n
\n
Works everywhere - Windows, Linux, Mac, Web browser (+mobile web is planned), without compromises in features
\n
Based on standalone NPM packages, scripts can be run without DbGate (example - CSV export )
\n
Many data browsing functions based using foreign keys - master/detail, expand columns, expandable form view (on screenshot above)
\n
\n
Design goals
\n
\n
Application simplicity - DbGate takes the best and only the best from old DbGate, DatAdmin and DbMouse .
Platform independent - will run as web application in single docker container on server, or as application using Electron platform on Linux, Windows and Mac
Currently following extensions can be implemented using plugins:
\n
\n
File format parsers/writers
\n
Database engine connectors
\n
\n
Basic set of plugins is part of DbGate git repository and is installed with app. Additional plugins pust be downloaded from NPM (this task is handled by DbGate)
\n
How to run development environment
\n
yarn\nyarn start
\n
If you want to make modifications in libraries or plugins, run library compiler in watch mode in the second terminal:
You could run electron app (requires running localhost:5000):
\n
cd app\nyarn\nyarn start
\n
How to run built electron app locally
\n
This mode is very similar to production run of electron app. Electron app forks process with API on dynamically allocated port, works with compiled javascript files and uses compiled version of plugins (doesn't use localhost:5000)
\n
cd app\nyarn
\n
yarn\nyarn build:app:local\nyarn start:app:local
\n
",
"readmeOriginal": "
\n\n\n\n
\n
DbGate - database administration tool
\n
DbGate modern, fast and easy to use database manager
Runs as application for Windows, Linux and Mac. Or in Docker container on server and in web Browser on client.
\n
Import, export from/to CSV, Excel, JSON
\n
Free table editor - quick table data editing (cleanup data after import/before export, prototype tables etc.)
\n
Archives - backup your data in JSON files on local filesystem (or on DbGate server, when using web application)
\n
Charts
\n
For detailed info, how to run DbGate in docker container, visit docker hub
\n
Extensible plugin architecture
\n
\n
How to contribute
\n
Any contributions are welcome. If you want to contribute without coding, consider following:
\n
\n
Create issue, if you find problem in app, or you have idea to new feature. If issue already exists, you could leave comment on it, to prioritise most wanted issues.
\n
Tell your friends about DbGate or share on social networks - when more people will use DbGate, it will grow to be better
\n
\n
Why is DbGate different
\n
There are many database managers now, so why DbGate?
\n
\n
Works everywhere - Windows, Linux, Mac, Web browser (+mobile web is planned), without compromises in features
\n
Based on standalone NPM packages, scripts can be run without DbGate (example - CSV export )
\n
Many data browsing functions based using foreign keys - master/detail, expand columns, expandable form view (on screenshot above)
\n
\n
Design goals
\n
\n
Application simplicity - DbGate takes the best and only the best from old DbGate, DatAdmin and DbMouse .
Platform independent - will run as web application in single docker container on server, or as application using Electron platform on Linux, Windows and Mac
Currently following extensions can be implemented using plugins:
\n
\n
File format parsers/writers
\n
Database engine connectors
\n
\n
Basic set of plugins is part of DbGate git repository and is installed with app. Additional plugins pust be downloaded from NPM (this task is handled by DbGate)
\n
How to run development environment
\n
yarn\nyarn start
\n
If you want to make modifications in libraries or plugins, run library compiler in watch mode in the second terminal:
You could run electron app (requires running localhost:5000):
\n
cd app\nyarn\nyarn start
\n
How to run built electron app locally
\n
This mode is very similar to production run of electron app. Electron app forks process with API on dynamically allocated port, works with compiled javascript files and uses compiled version of plugins (doesn't use localhost:5000)
\n\nA Visual development-tool of creating mocked Json\n
Build and Dev Setup
\n
# install dependencies\nnpm install\n\n# serve with hot reload at localhost:9080\nnpm run dev\n\n# build electron application for production\nnpm run build\n\n# lint all JS/Vue component files in `src/`\nnpm run lint\n
\n\n
User Guide
\n
\n
Start development server\nIn the Server Port field, you can type a Port not occupied, then choose a language. Finally open the Server by clicking the circle on the bottom left. If the Server was initiated successfully, the circle on the top right will be change.
\n
Change your image\nAn Image URL field will be displayed by double clicking the image, then type a image's URL and double click the image again to show the new image.
\n
\n\n
\n\n\n
\n
Create key-value pairs\nIn the factory of creator, the name of key-value pairs can be edited in the Name field. If you want to add a key-value pair, type a key in the Key field and click + button. A new key will be added to the key-value pairs, what to do next is choosing a value, including primary and advanced types. Then, click the save button on the botton left to save the key-value pair. Finally, when you complete each key-value pair, click the check button on the top right to save the whole key-value pairs.
\n
\n\n
\n\n\n
\n
Inspect key-value pairs\nIn the dStore of creator, all the key-value pairs are shown in the data list. User can edit each key-value paris by clicking their name button and delete one by the red close button on the right.
\n
\n\n
\n\n\n
\n
Get the data
\n
\n
\n
http://localhost:{{port your type in the first step, e.g 9090}}/?name={{the name of key-value pairs you want}}
\n\nA Visual development-tool of creating mocked Json\n
Build and Dev Setup
\n
# install dependencies\nnpm install\n\n# serve with hot reload at localhost:9080\nnpm run dev\n\n# build electron application for production\nnpm run build\n\n# lint all JS/Vue component files in `src/`\nnpm run lint\n
\n\n
User Guide
\n
\n
Start development server\nIn the Server Port field, you can type a Port not occupied, then choose a language. Finally open the Server by clicking the circle on the bottom left. If the Server was initiated successfully, the circle on the top right will be change.
\n
Change your image\nAn Image URL field will be displayed by double clicking the image, then type a image's URL and double click the image again to show the new image.
\n
\n\n
\n\n\n
\n
Create key-value pairs\nIn the factory of creator, the name of key-value pairs can be edited in the Name field. If you want to add a key-value pair, type a key in the Key field and click + button. A new key will be added to the key-value pairs, what to do next is choosing a value, including primary and advanced types. Then, click the save button on the botton left to save the key-value pair. Finally, when you complete each key-value pair, click the check button on the top right to save the whole key-value pairs.
\n
\n\n
\n\n\n
\n
Inspect key-value pairs\nIn the dStore of creator, all the key-value pairs are shown in the data list. User can edit each key-value paris by clicking their name button and delete one by the red close button on the right.
\n
\n\n
\n\n\n
\n
Get the data
\n
\n
\n
http://localhost:{{port your type in the first step, e.g 9090}}/?name={{the name of key-value pairs you want}}
Yu-Gi-Oh! DeckMaster is a deck editor for the Yu-Gi-Oh! trading card game.\nIt features a full deck editor and a combo editor for live probabilities.
\n
Installation
\n
You can install DeckMaster via one of our installers, or by building from source.\nVisit the documentation for instructions.
\n
Support
\n
If you encounter any issues when using DeckMaster, or simply have a suggestion on how to improve it, please open an issue in our issue tracker and I'll get back to you.
\n
Alternatively, if you do not have a GitHub account, please use the Discord server.
\n
Contributing
\n
DeckMaster is completely open-source and accepts contributions from the community.\nIf you wish to contribute to DeckMaster, please read our contributing guide.
Card data is served from the YGOProDeck database API
\n
\n
",
- "readmeOriginal": "
Yu-Gi-Oh! DeckMaster
\n
\n
\n
\n
Yu-Gi-Oh! DeckMaster is a deck editor for the Yu-Gi-Oh! trading card game.\nIt features a full deck editor and a combo editor for live probabilities.
\n
Installation
\n
You can install DeckMaster via one of our installers, or by building from source.\nVisit the documentation for instructions.
\n
Support
\n
If you encounter any issues when using DeckMaster, or simply have a suggestion on how to improve it, please open an issue in our issue tracker and I'll get back to you.
\n
Alternatively, if you do not have a GitHub account, please use the Discord server.
\n
Contributing
\n
DeckMaster is completely open-source and accepts contributions from the community.\nIf you wish to contribute to DeckMaster, please read our contributing guide.
The DataPixels.js source code facilitates production of pixel art that is entirely generated programmatically at runtime. Additionally, the accompanying desktop application, Data Pixels Playground, may be used to write and execute code for displaying both customized and automated pixel art.
\n
DataPixels.js
\n
The DataPixels.js source code features a modular, ES2015 Class design for accessible and effortless construction of new instances. Each instance contains both HTMLCanvasElement and HTMLImageElement public accessors whose sources consist of the programmatically generated pixel art.
\n
Install
\n
DataPixels.js package can be installed as a project dependency from NPM by entering the following CLI command:
\n
npm i data-pixels\n
\n
Create
\n
The DataPixels.js constructor requires 2 arguments:
\n\n
\n
pixelData: An array containing one or more arrays of equal length, consisting of strings composed of 0-255 integer values per 24-bit RGB color channel (e.g., “255, 255, 255”) or 32-bit RGBA color channel (e.g., “255, 255, 255, 255”). Additionally, the strings may optionally contain any kind of descriptive text (e.g., “Red: 255, G - 128, 64 for Blue, Transparency = 32”) as only the number values within the string will be parsed in RGB / RGBA order. Strings that contain more than 4 numbers will throw an error.
\n
\n
\n
pixelSize: The size of each color data unit in pixels. This value represents the size of each perceived pixel that forms the pixel art.
\n
\n\n
For more information see the Example Code section below.
\n
\n
Data Pixels Playground
\n
Data Pixels Playground is a lightweight, cross-platform, desktop application for Windows, Mac and Linux, which may be used to write and execute DataPixels.js instances for previewing and testing purposes.
\n
The application features built-in example code via the Help menu as well as the ability to parse pixel data from image files to produce automatically generated code through the File > Open Image File… menu item or through drag-and-drop gestures. Additionally, compiled Data Pixels visible in the View Panel can be easily dragged, scaled and reflected using the mouse or in-app controls to help you design the perfect images for your requirements.
\n
Note: pixel color values that are automatically interpreted from image files with an embedded color space may differ slightly from the image’s intended color values.
\n
\n
Desktop Application Release Builds
\n
Creating release builds for Windows, Mac and/or Linux is a 2-step process: code compilation, then application packaging, both of which are accomplished by running command-line NPM scripts.
\n
Compilation
\n
Production code compilation can be executed by entering the following CLI command at the project root folder [~/DataPixels/ ]:
\n
npm run prod\n
\n
For more detailed information concerning code compilation please refer to Project Foundation.
\n
Packaging
\n
Application packaging can be executed for individual platforms by entering one of the following CLI commands at the project build folder [~/DataPixels/resources/build/ ]:
\n
npm run package-linux\n
\n
npm run package-mac\n
\n
npm run package-windows\n
\n
Note: In order to avoid problems with code signing and other build issues it is highly recommended to execute packaging scripts for an individual platform from its own operating system.
\n
For more detailed information concerning application packaging please refer to Electron Packager.
The DataPixels.js source code facilitates production of pixel art that is entirely generated programmatically at runtime. Additionally, the accompanying desktop application, Data Pixels Playground, may be used to write and execute code for displaying both customized and automated pixel art.
\n
DataPixels.js
\n
The DataPixels.js source code features a modular, ES2015 Class design for accessible and effortless construction of new instances. Each instance contains both HTMLCanvasElement and HTMLImageElement public accessors whose sources consist of the programmatically generated pixel art.
\n
Install
\n
DataPixels.js package can be installed as a project dependency from NPM by entering the following CLI command:
\n
npm i data-pixels\n
\n
Create
\n
The DataPixels.js constructor requires 2 arguments:
\n\n
\n
pixelData: An array containing one or more arrays of equal length, consisting of strings composed of 0-255 integer values per 24-bit RGB color channel (e.g., “255, 255, 255”) or 32-bit RGBA color channel (e.g., “255, 255, 255, 255”). Additionally, the strings may optionally contain any kind of descriptive text (e.g., “Red: 255, G - 128, 64 for Blue, Transparency = 32”) as only the number values within the string will be parsed in RGB / RGBA order. Strings that contain more than 4 numbers will throw an error.
\n
\n
\n
pixelSize: The size of each color data unit in pixels. This value represents the size of each perceived pixel that forms the pixel art.
\n
\n\n
For more information see the Example Code section below.
\n
\n
Data Pixels Playground
\n
Data Pixels Playground is a lightweight, cross-platform, desktop application for Windows, Mac and Linux, which may be used to write and execute DataPixels.js instances for previewing and testing purposes.
\n
The application features built-in example code via the Help menu as well as the ability to parse pixel data from image files to produce automatically generated code through the File > Open Image File… menu item or through drag-and-drop gestures. Additionally, compiled Data Pixels visible in the View Panel can be easily dragged, scaled and reflected using the mouse or in-app controls to help you design the perfect images for your requirements.
\n
Note: pixel color values that are automatically interpreted from image files with an embedded color space may differ slightly from the image’s intended color values.
\n
\n
Desktop Application Release Builds
\n
Creating release builds for Windows, Mac and/or Linux is a 2-step process: code compilation, then application packaging, both of which are accomplished by running command-line NPM scripts.
\n
Compilation
\n
Production code compilation can be executed by entering the following CLI command at the project root folder [~/DataPixels/ ]:
\n
npm run prod\n
\n
For more detailed information concerning code compilation please refer to Project Foundation.
\n
Packaging
\n
Application packaging can be executed for individual platforms by entering one of the following CLI commands at the project build folder [~/DataPixels/resources/build/ ]:
\n
npm run package-linux\n
\n
npm run package-mac\n
\n
npm run package-windows\n
\n
Note: In order to avoid problems with code signing and other build issues it is highly recommended to execute packaging scripts for an individual platform from its own operating system.
\n
For more detailed information concerning application packaging please refer to Electron Packager.
Extract it somewhere, and then run the executable.
\n
or
\n
Package app manually from sources
\n
To clone and run this repository you'll need Git and Node.js (which comes with npm) installed on your computer. From your command line:
\n
# Clone this repository\ngit clone https://github.com/web-pal/dbglass\n# Go into the repository\ncd dbglass\n# Install dependencies and run the app\nnpm install && npm run dev
\n
App will be running in development mode at this point, in which you can:
We add some module's peerDependencies to ignore option as default for application size reduction.
\n
\n
babel-core is required by babel-loader and its size is ~19 MB
\n
node-libs-browser is required by webpack and its size is ~3MB.
\n
\n
\n
Note: If you want to use any above modules in runtime, for example: require('babel/register'), you should move them form devDependencies to dependencies.
\n
\n
Pack into an app for your platform from command line:
Extract it somewhere, and then run the executable.
\n
or
\n
Package app manually from sources
\n
To clone and run this repository you'll need Git and Node.js (which comes with npm) installed on your computer. From your command line:
\n
# Clone this repository\ngit clone https://github.com/web-pal/dbglass\n# Go into the repository\ncd dbglass\n# Install dependencies and run the app\nnpm install && npm run dev
\n
App will be running in development mode at this point, in which you can:
We add some module's peerDependencies to ignore option as default for application size reduction.
\n
\n
babel-core is required by babel-loader and its size is ~19 MB
\n
node-libs-browser is required by webpack and its size is ~3MB.
\n
\n
\n
Note: If you want to use any above modules in runtime, for example: require('babel/register'), you should move them form devDependencies to dependencies.
\n
\n
Pack into an app for your platform from command line:
Yu-Gi-Oh! DeckMaster is a deck editor for the Yu-Gi-Oh! trading card game.\nIt features a full deck editor and a combo editor for live probabilities.
\n
Installation
\n
You can install DeckMaster via one of our installers, or by building from source.\nVisit the documentation for instructions.
\n
Support
\n
If you encounter any issues when using DeckMaster, or simply have a suggestion on how to improve it, please open an issue in our issue tracker and I'll get back to you.
\n
Alternatively, if you do not have a GitHub account, please use the Discord server.
\n
Contributing
\n
DeckMaster is completely open-source and accepts contributions from the community.\nIf you wish to contribute to DeckMaster, please read our contributing guide.
Card data is served from the YGOProDeck database API
\n
\n
",
+ "readmeOriginal": "
Yu-Gi-Oh! DeckMaster
\n
\n
\n
\n
Yu-Gi-Oh! DeckMaster is a deck editor for the Yu-Gi-Oh! trading card game.\nIt features a full deck editor and a combo editor for live probabilities.
\n
Installation
\n
You can install DeckMaster via one of our installers, or by building from source.\nVisit the documentation for instructions.
\n
Support
\n
If you encounter any issues when using DeckMaster, or simply have a suggestion on how to improve it, please open an issue in our issue tracker and I'll get back to you.
\n
Alternatively, if you do not have a GitHub account, please use the Discord server.
\n
Contributing
\n
DeckMaster is completely open-source and accepts contributions from the community.\nIf you wish to contribute to DeckMaster, please read our contributing guide.
Create custom computer macro shortcuts and launch them through your device.\nNo more windows switching to open the folder or website, get Deckboard to simplify them and maximize your productivity!\nWith OBS Studio and Streamlabs OBS supported, bring Deckboard as your personal streaming companion tool!\nConnect your computer to your device through local WiFi connection by entering IP address or scanning QR code.
\n
Features
\n
\n
Custom macro button with image and label
\n
Unlimited macros with 4 x 3 buttons per board (15 x 15 buttons on pro version)
\n
OBS Studio and Streamlabs OBS control for streaming (OBS Websocket plugin required)
\n
Easy connect through local WiFi connection by entering IP address or scanning QR code.
\n
\n
Available Macros
\n
\n
Keyboard macro
\n
Open website
\n
Open folder
\n
Multimedia controls (play, next track, prev track , etc)
\n
Run executable
\n
Twitch chat controls
\n
Spotify playback controls (Premium user only)
\n
Switch scenes (OBS Studio and Streamlabs OBS)
\n
Toggle resources (OBS Studio and Streamlabs OBS)
\n
Toggle streaming and recording (OBS Studio and Streamlabs OBS)
Love the app? You can support the development by purchasing PRO version or donate.
\n
\n
Privacy Policy
\n
The application Deckboard (Android), hereby defined as the app, requests the following potentially sensitive data:
\n
\n
android.permission.CAMERA
\n
\n
This potentially sensitive data is not transmitted over the internet, and is not stored by the app. It is not handled by any system other than the device the app is installed on.
\n
",
"readmeOriginal": "
\n \n
Deckboard
\n
\n \n \n \n \n
\n\n
Create custom computer macro shortcuts and launch them through your device.\nNo more windows switching to open the folder or website, get Deckboard to simplify them and maximize your productivity!\nWith OBS Studio and Streamlabs OBS supported, bring Deckboard as your personal streaming companion tool!\nConnect your computer to your device through local WiFi connection by entering IP address or scanning QR code.
\n
Features
\n
\n
Custom macro button with image and label
\n
Unlimited macros with 4 x 3 buttons per board (15 x 15 buttons on pro version)
\n
OBS Studio and Streamlabs OBS control for streaming (OBS Websocket plugin required)
\n
Easy connect through local WiFi connection by entering IP address or scanning QR code.
\n
\n
Available Macros
\n
\n
Keyboard macro
\n
Open website
\n
Open folder
\n
Multimedia controls (play, next track, prev track , etc)
\n
Run executable
\n
Twitch chat controls
\n
Spotify playback controls (Premium user only)
\n
Switch scenes (OBS Studio and Streamlabs OBS)
\n
Toggle resources (OBS Studio and Streamlabs OBS)
\n
Toggle streaming and recording (OBS Studio and Streamlabs OBS)
Love the app? You can support the development by purchasing PRO version or donate.
\n
\n
Privacy Policy
\n
The application Deckboard (Android), hereby defined as the app, requests the following potentially sensitive data:
\n
\n
android.permission.CAMERA
\n
\n
This potentially sensitive data is not transmitted over the internet, and is not stored by the app. It is not handled by any system other than the device the app is installed on.
DECK is powerful and high performant local web development studio unlike any other, install & try out more than 40+ open source stacks with editable Docker compose files
DECK's inbuilt SSL engine powered by LetsEncrypt and a supercharged proxy layer enables full HTTPS on localhost apps.
\n
Unlimited projects, multiple server configurations
\n
\n
Easily spin-up Laravel, Codeigniter, Node JS, Django, WordPress, Magento\nand many more apps right on your localhost with the click of a button\nand let DECK do the heavy lifting for you.
\n
Built-in terminal
\n
\n
Get shell access to your apps and run commands to make changes in file permissions, server configurations, etc
\n
DECK Flights
\n
Easily share your local app with co-workers remotely by using Flights
\n
Ready to go configurations
\n
Focus on your web app and let DECK handle the server configurations for you.
DECK is powerful and high performant local web development studio unlike any other, install & try out more than 40+ open source stacks with editable Docker compose files
DECK's inbuilt SSL engine powered by LetsEncrypt and a supercharged proxy layer enables full HTTPS on localhost apps.
\n
Unlimited projects, multiple server configurations
\n
\n
Easily spin-up Laravel, Codeigniter, Node JS, Django, WordPress, Magento\nand many more apps right on your localhost with the click of a button\nand let DECK do the heavy lifting for you.
\n
Built-in terminal
\n
\n
Get shell access to your apps and run commands to make changes in file permissions, server configurations, etc
\n
DECK Flights
\n
Easily share your local app with co-workers remotely by using Flights
\n
Ready to go configurations
\n
Focus on your web app and let DECK handle the server configurations for you.
The all-in-one solution for building React Native applications.
\n
You can get started right away on your React Native project by installing Deco and creating a new project — it's fast and there's no manual setup needed. File scaffolding handles your boilerplate. Ready-made components drop right into your code. Properties are graphically editable through the property inspector. It's an entirely new way to write, tweak, and re-use code.
$ git clone git@github.com:decosoftware/deco-ide\n$ cd ./deco-ide/web\n$ npm install\n$ bundle install\n$ cd ../desktop\n$ npm install\n$ npm run copy-libs\n$ cd ../shared\n$ npm install\n$ cd ../desktop/libs/Scripts/sync-service\n$ npm install\n
Shared constants for communicating over our IPC (inter-process communication) abstraction layer.
\n
\n
Quick Start
\n
$ cd ./deco-ide\n$ ./run-dev.js\n
\n
Manual Start
\n
Occasionally it is helpful to stop and restart the desktop gulp task without stopping the web gulp task. To do this you can run the following commands...
\n
$ cd ./web\n$ npm run watch\n\n
\n
This command will:
\n\n
Watch the ./web/src directory and re-build on any changes to the code
\n
Serve the build on localhost:8080
\n\n
# Open a new terminal window\n$ cd ./desktop\n$ npm run start\n
\n
This command will:
\n\n
Build ./desktop/src and place the result into ./desktop/build/app.js
\n
Launch a local Electron binary and load in the bundle from desktop/build/app.js
\n\n
Testing a Production Build
\n
$ cd ./desktop\n$ npm run pack\n
\n
The resulting .pkg file will be output to ./dist/osx/Deco-$VERSION.pkg
\n
This build is for local testing only. When you install, the system will generate a warning about this being from an unapproved developer — this is because the package is not signed when building locally.
\n
Contributing
\n
Opening Issues
\n
Issues are intended for bug reporting and feature requests.
\n
Before you open a new issue, make sure it isn't already in the list of existing issues. If you believe you've found a new bug, it helps to include any relevant logs in your description.
\n
You can find the logs file at ~/Library/Application Support/com.decosoftware.Deco/logs.out
The all-in-one solution for building React Native applications.
\n
You can get started right away on your React Native project by installing Deco and creating a new project — it's fast and there's no manual setup needed. File scaffolding handles your boilerplate. Ready-made components drop right into your code. Properties are graphically editable through the property inspector. It's an entirely new way to write, tweak, and re-use code.
$ git clone git@github.com:decosoftware/deco-ide\n$ cd ./deco-ide/web\n$ npm install\n$ bundle install\n$ cd ../desktop\n$ npm install\n$ npm run copy-libs\n$ cd ../shared\n$ npm install\n$ cd ../desktop/libs/Scripts/sync-service\n$ npm install\n
Shared constants for communicating over our IPC (inter-process communication) abstraction layer.
\n
\n
Quick Start
\n
$ cd ./deco-ide\n$ ./run-dev.js\n
\n
Manual Start
\n
Occasionally it is helpful to stop and restart the desktop gulp task without stopping the web gulp task. To do this you can run the following commands...
\n
$ cd ./web\n$ npm run watch\n\n
\n
This command will:
\n\n
Watch the ./web/src directory and re-build on any changes to the code
\n
Serve the build on localhost:8080
\n\n
# Open a new terminal window\n$ cd ./desktop\n$ npm run start\n
\n
This command will:
\n\n
Build ./desktop/src and place the result into ./desktop/build/app.js
\n
Launch a local Electron binary and load in the bundle from desktop/build/app.js
\n\n
Testing a Production Build
\n
$ cd ./desktop\n$ npm run pack\n
\n
The resulting .pkg file will be output to ./dist/osx/Deco-$VERSION.pkg
\n
This build is for local testing only. When you install, the system will generate a warning about this being from an unapproved developer — this is because the package is not signed when building locally.
\n
Contributing
\n
Opening Issues
\n
Issues are intended for bug reporting and feature requests.
\n
Before you open a new issue, make sure it isn't already in the list of existing issues. If you believe you've found a new bug, it helps to include any relevant logs in your description.
\n
You can find the logs file at ~/Library/Application Support/com.decosoftware.Deco/logs.out
An Open Source electron plugin ecosystem for JS developers that makes tools for the desktop on Windows, Mac and Linux\neasily deployable and manageable as plugins.
Deskfiler is published under the GPLv3. You will find the license within the code tree.
\n
",
"readmeOriginal": "
Deskfiler
\n\n
\n
An Open Source electron plugin ecosystem for JS developers that makes tools for the desktop on Windows, Mac and Linux\neasily deployable and manageable as plugins.
DevDocs.io combines multiple API documentations in a fast, organized, and searchable interface. This is an unofficial desktop app for it.
\n
\n
Features
\n
Background behavior
\n
When closing the window, the app will continue running in the background, in the dock on macOS and the tray on Linux/Windows. Right-click the dock/tray icon and choose Quit to completely quit the app. On macOS, click the dock icon to show the window. On Linux, right-click the tray icon and choose Toggle to toggle the window. On Windows, click the tray icon to toggle the window.
\n
Build-in shortcuts
\n
devdocs the website itself has great built-in shortcuts support, just check the help page in the app.
\n
\n
Planned features
\n
Please consider sponsoring me to accelerate development.
\n
\n
Menubar mode: switch beween desktop mode and menubar mode
\n
Tabs support: allow to open documentation in a new tab
\n
\n
Global shortcut
\n
Use Ctrl+Shift+D (or Command+Shift+D on macOS) to toggle the app.
\n
Install
\n
Using Homebrew
\n
brew install --cask devdocs\n
\n
Manual download
\n
You can manually download the latest release here.
\n
Development
\n
It's really easy to develop this app, no build tools like Webpack needed here, checkout ./app to get more:
\n
npm install\n\nnpm run app\n# edit files, save, refresh and it's done.
DevDocs.io combines multiple API documentations in a fast, organized, and searchable interface. This is an unofficial desktop app for it.
\n
\n
Features
\n
Background behavior
\n
When closing the window, the app will continue running in the background, in the dock on macOS and the tray on Linux/Windows. Right-click the dock/tray icon and choose Quit to completely quit the app. On macOS, click the dock icon to show the window. On Linux, right-click the tray icon and choose Toggle to toggle the window. On Windows, click the tray icon to toggle the window.
\n
Build-in shortcuts
\n
devdocs the website itself has great built-in shortcuts support, just check the help page in the app.
\n
\n
Planned features
\n
Please consider sponsoring me to accelerate development.
\n
\n
Menubar mode: switch beween desktop mode and menubar mode
\n
Tabs support: allow to open documentation in a new tab
\n
\n
Global shortcut
\n
Use Ctrl+Shift+D (or Command+Shift+D on macOS) to toggle the app.
\n
Install
\n
Using Homebrew
\n
brew install --cask devdocs\n
\n
Manual download
\n
You can manually download the latest release here.
\n
Development
\n
It's really easy to develop this app, no build tools like Webpack needed here, checkout ./app to get more:
\n
npm install\n\nnpm run app\n# edit files, save, refresh and it's done.
DECK is powerful and high performant local web development studio unlike any other, install & try out more than 40+ open source stacks with editable Docker compose files
DECK's inbuilt SSL engine powered by LetsEncrypt and a supercharged proxy layer enables full HTTPS on localhost apps.
\n
Unlimited projects, multiple server configurations
\n
\n
Easily spin-up Laravel, Codeigniter, Node JS, Django, WordPress, Magento\nand many more apps right on your localhost with the click of a button\nand let DECK do the heavy lifting for you.
\n
Built-in terminal
\n
\n
Get shell access to your apps and run commands to make changes in file permissions, server configurations, etc
\n
DECK Flights
\n
Easily share your local app with co-workers remotely by using Flights
\n
Ready to go configurations
\n
Focus on your web app and let DECK handle the server configurations for you.
DECK is powerful and high performant local web development studio unlike any other, install & try out more than 40+ open source stacks with editable Docker compose files
DECK's inbuilt SSL engine powered by LetsEncrypt and a supercharged proxy layer enables full HTTPS on localhost apps.
\n
Unlimited projects, multiple server configurations
\n
\n
Easily spin-up Laravel, Codeigniter, Node JS, Django, WordPress, Magento\nand many more apps right on your localhost with the click of a button\nand let DECK do the heavy lifting for you.
\n
Built-in terminal
\n
\n
Get shell access to your apps and run commands to make changes in file permissions, server configurations, etc
\n
DECK Flights
\n
Easily share your local app with co-workers remotely by using Flights
\n
Ready to go configurations
\n
Focus on your web app and let DECK handle the server configurations for you.
\n \n DevHub: GitHub Notifications & Activities on your Desktop \n Android, iOS, Web & Desktop with 95%+ code sharing between them thanks to React Native + React Native Web \n
\n \n \n
\n\n
Why
\n
DevHub is a mobile and desktop app to help you manage GitHub Notifications and stay on top of repository activities. Save custom searches, apply filters and don't miss anything important.
brew tap devhubapp/devhub\n brew install --cask devhub\n
\n
\n
\n
\n
\n \n
Features
\n
\n
Multi-column layout: See at a quick glance everything that is going on (like TweetDeck!);
\n
Filters: Apply different filters to each column, save your custom searches to make your life easier;
\n
Inbox Zero: Mark columns as done and gain peace of mind;
\n
Notifications manager: See all the relevant information before opening the notification, like comment content, issue/pull request status, release description, etc.;
\n
Repository watcher: Keep up to date with repositories' activities without using the watch feature so your notifications don't get cluttered;
\n
User stalking: Follow user activities without using the follow button; see activities that GitHub doesn't show on your feed, like their issue comments and pushed commits;
\n
Home/Dashboard: See yours or other users' home screen (a.k.a. GitHub Dashboard), a great way to discover interesting repositories;
\n
Save for later: Save any activity or notification for later, so you don't forget to get back to them;
\n
Keyboard shortcuts: Do anything using only the keyboard (press Shift+? in the web or desktop app to see all available shortcuts);
\n
Theme support: Choose between 6 light or dark themes; Automatically detect system preference;
\n
And more!: Desktop apps, native mobile apps, open source, modern tech stack, ...
\n
\n \n
Next features:
\n
\n
Issues/PR management: Manage all issues and PRs, filter the ones related to you, take actions, etc. (vote: #110);
\n
Trending: New column type to show Trending repositories (vote: #48);
\n
Push notifications: Enable push notifications for your filtered columns on mobile and/or desktop (vote: #51);
\n
Drag & Drop: Allow moving columns using drag&drop (vote: #42)
\n
GitHub Enterprise: Support for self hosted GitHubs on local networks (vote: #165)
\n
\n
\n
Which one do you want first? Any other recommendations? Search for existing feature requests and add a 👍 reaction on them, or create a new one. Feel free to ping me (@brunolemos) if you feel it's something important.
This project is provided as is without any warranties. Use at your own risk. \nBy using DevHub you agree with its privacy policy and license.
\n
",
"readmeOriginal": "
\n \n DevHub: GitHub Notifications & Activities on your Desktop \n Android, iOS, Web & Desktop with 95%+ code sharing between them thanks to React Native + React Native Web \n
\n \n \n
\n\n
Why
\n
DevHub is a mobile and desktop app to help you manage GitHub Notifications and stay on top of repository activities. Save custom searches, apply filters and don't miss anything important.
brew tap devhubapp/devhub\n brew install --cask devhub\n
\n
\n
\n
\n
\n \n
Features
\n
\n
Multi-column layout: See at a quick glance everything that is going on (like TweetDeck!);
\n
Filters: Apply different filters to each column, save your custom searches to make your life easier;
\n
Inbox Zero: Mark columns as done and gain peace of mind;
\n
Notifications manager: See all the relevant information before opening the notification, like comment content, issue/pull request status, release description, etc.;
\n
Repository watcher: Keep up to date with repositories' activities without using the watch feature so your notifications don't get cluttered;
\n
User stalking: Follow user activities without using the follow button; see activities that GitHub doesn't show on your feed, like their issue comments and pushed commits;
\n
Home/Dashboard: See yours or other users' home screen (a.k.a. GitHub Dashboard), a great way to discover interesting repositories;
\n
Save for later: Save any activity or notification for later, so you don't forget to get back to them;
\n
Keyboard shortcuts: Do anything using only the keyboard (press Shift+? in the web or desktop app to see all available shortcuts);
\n
Theme support: Choose between 6 light or dark themes; Automatically detect system preference;
\n
And more!: Desktop apps, native mobile apps, open source, modern tech stack, ...
\n
\n \n
Next features:
\n
\n
Issues/PR management: Manage all issues and PRs, filter the ones related to you, take actions, etc. (vote: #110);
\n
Trending: New column type to show Trending repositories (vote: #48);
\n
Push notifications: Enable push notifications for your filtered columns on mobile and/or desktop (vote: #51);
\n
Drag & Drop: Allow moving columns using drag&drop (vote: #42)
\n
GitHub Enterprise: Support for self hosted GitHubs on local networks (vote: #165)
\n
\n
\n
Which one do you want first? Any other recommendations? Search for existing feature requests and add a 👍 reaction on them, or create a new one. Feel free to ping me (@brunolemos) if you feel it's something important.
Open-Source collaborative IDE with many features and extremely quick setup!
\n
Currently work-in-progress/early alpha, but you can try it out with npx devsession in\nthe directory in which you want to start a coding session, or by downloading the GUI starter\nfrom the latest release.
You can run devsession from anywhere by entering npx devsession, which will automatically download,\ninstall and run devsession. You can install it globally by entering npm i -g devsession, so you can\njust invoke devsession at any time.
\n
You can also install devsession as a dev dependency to your project and create an npm script in your\npackage.json with preset CLI arguments to quickly enter a session that fits the projects needs.
\n
You can use the following arguments:
\n
\n
-p, --port [port], The port on which to run the server. Defaults to 8020.
\n
-k, --adminkey [key], This key can be used to register a user as an admin. Defaults to a random string.
\n
-d, --dir [dir], The project directory. Defaults to the current directory.
\n
-v, --verbose, Log all socket messages for debugging.
\n
-a, --autosave, Duration (in seconds) of periodic auto saving of all open files. 0 = disabled. Defaults to 120.
\n
\n
Building/Contributing
\n
The project is set up as a monorepo using Lerna. Note that, prior to doing anything else and\nespecially prior to installing dependencies, you need to run npx lerna link to establish\nsymlinks between the packages.
\n
\n
\n
To start developing, run yarn && yarn start in the root directory. This will start\na development server for the backend and the frontend and automatically recompile if\nchanges are detected. The backend starts on port 8020, the frontend on port 3000.\nTo debug, open the frontend from the url:\nhttp://localhost:3000/?adminkey=adminkey&backend=http://localhost:8020
\n
\n
\n
To run a new build, run yarn && yarn build. This will build the common package,\nthe backend, the frontend, the website and the guistarter app.
\n
\n
\n
To release a new version, run yarn && yarn pub. This will build everything, bump\nversions for all packages, upload new versions for the packages which are deployed\non npm and commit and push the version bumps. The CI pipeline will pick that up and\nredeploy the website and attach the guistarter binaries with the github release.
\n
\n
\n
Acknowledgements
\n
Notable third-party frameworks used are:
\n
\n
Microsofts Monaco as editor frontend
\n
Microsofts Typescript as primary programming language
\n
Facebooks React for frontend development
\n
Redux and Palantirs Redoodle for state management
\n
Palantirs BlueprintJs as UI library
\n
ExpressJS for the backend
\n
Socket.io for real-time communication between frontend and backend
\n
Electron for creating a standalone binary of the GUI starter
\n
ngrok and localtunnel as built-in port-forwarding service
\n
Node-pty for running terminals in the backend
\n
xterm for displaying terminals in the frontend
\n
\n
...as well as many others.
\n
",
+ "readmeOriginal": "
DevSession
\n
\n\n\n\n\n\n\n\n\n
\n
Open-Source collaborative IDE with many features and extremely quick setup!
\n
Currently work-in-progress/early alpha, but you can try it out with npx devsession in\nthe directory in which you want to start a coding session, or by downloading the GUI starter\nfrom the latest release.
You can run devsession from anywhere by entering npx devsession, which will automatically download,\ninstall and run devsession. You can install it globally by entering npm i -g devsession, so you can\njust invoke devsession at any time.
\n
You can also install devsession as a dev dependency to your project and create an npm script in your\npackage.json with preset CLI arguments to quickly enter a session that fits the projects needs.
\n
You can use the following arguments:
\n
\n
-p, --port [port], The port on which to run the server. Defaults to 8020.
\n
-k, --adminkey [key], This key can be used to register a user as an admin. Defaults to a random string.
\n
-d, --dir [dir], The project directory. Defaults to the current directory.
\n
-v, --verbose, Log all socket messages for debugging.
\n
-a, --autosave, Duration (in seconds) of periodic auto saving of all open files. 0 = disabled. Defaults to 120.
\n
\n
Building/Contributing
\n
The project is set up as a monorepo using Lerna. Note that, prior to doing anything else and\nespecially prior to installing dependencies, you need to run npx lerna link to establish\nsymlinks between the packages.
\n
\n
\n
To start developing, run yarn && yarn start in the root directory. This will start\na development server for the backend and the frontend and automatically recompile if\nchanges are detected. The backend starts on port 8020, the frontend on port 3000.\nTo debug, open the frontend from the url:\nhttp://localhost:3000/?adminkey=adminkey&backend=http://localhost:8020
\n
\n
\n
To run a new build, run yarn && yarn build. This will build the common package,\nthe backend, the frontend, the website and the guistarter app.
\n
\n
\n
To release a new version, run yarn && yarn pub. This will build everything, bump\nversions for all packages, upload new versions for the packages which are deployed\non npm and commit and push the version bumps. The CI pipeline will pick that up and\nredeploy the website and attach the guistarter binaries with the github release.
\n
\n
\n
Acknowledgements
\n
Notable third-party frameworks used are:
\n
\n
Microsofts Monaco as editor frontend
\n
Microsofts Typescript as primary programming language
\n
Facebooks React for frontend development
\n
Redux and Palantirs Redoodle for state management
\n
Palantirs BlueprintJs as UI library
\n
ExpressJS for the backend
\n
Socket.io for real-time communication between frontend and backend
\n
Electron for creating a standalone binary of the GUI starter
\n
ngrok and localtunnel as built-in port-forwarding service
This is our approach to create a cross platform desktop application for devRant.com.
\n
\n
Installation
\n
Pre-compiled builds can be found on the latest release page.\nAdditionally on macOS, brew can be used to install devRantron:
\n
$ brew cask install devrantron\n
\n
Contribute
\n
How to setup the project
\n
$ git clone https://github.com/tahnik/devRantron.git\n$ cd devRantron\n$ npm install\n$ npm run dev
\n
The dev script entry will start two processes. One process will create a webpack-dev-server that will watch and reload the bundle as you edit and will make it available at http://localhost:8080.\nThe second process will run the electron app in development mode, meaning that it will open up devtools with React and Redux devtools initialized.
\n
Commiting code
\n
Make sure that your code is passing all linting tests before commiting it. This is usually done automatically by using husky precommit hooks.
\n
devRantron uses angular styled commit messages. Messages that do not match the criteria are rejected. To make it easy to use them, use git cz instead of git commit.\nIt will start an interactive prompt and asks you for various things.
\n
Before pushing
\n
Make sure that you add yourself as a contributor. Simply run npm run contributors:add <comma_separated_list_of_emoji_keys. All the different emoji keys can be found here.
This is our approach to create a cross platform desktop application for devRant.com.
\n
\n
Installation
\n
Pre-compiled builds can be found on the latest release page.\nAdditionally on macOS, brew can be used to install devRantron:
\n
$ brew cask install devrantron\n
\n
Contribute
\n
How to setup the project
\n
$ git clone https://github.com/tahnik/devRantron.git\n$ cd devRantron\n$ npm install\n$ npm run dev
\n
The dev script entry will start two processes. One process will create a webpack-dev-server that will watch and reload the bundle as you edit and will make it available at http://localhost:8080.\nThe second process will run the electron app in development mode, meaning that it will open up devtools with React and Redux devtools initialized.
\n
Commiting code
\n
Make sure that your code is passing all linting tests before commiting it. This is usually done automatically by using husky precommit hooks.
\n
devRantron uses angular styled commit messages. Messages that do not match the criteria are rejected. To make it easy to use them, use git cz instead of git commit.\nIt will start an interactive prompt and asks you for various things.
\n
Before pushing
\n
Make sure that you add yourself as a contributor. Simply run npm run contributors:add <comma_separated_list_of_emoji_keys. All the different emoji keys can be found here.
Dext is a JavaScript powered smart launcher. Built with JavaScript behind the influences of Alfred.
\n
Made compatible with Alfred workflows that is powered by node (see: alfy).
\n
\n
Note: Currently available only for Mac OS X platform. Please help contribute for Windows and Linux users.
\n
Install
\n
Download the latest zip file here and unzip the archive. Open Dext.app and follow the instructions below for usage.
\n
You can also use Homebrew Cask to download the app by running these commands:
\n
brew update\nbrew cask install dext\n
\n
NOTE: Release version may not be stable as Dext is still in it's early stage of development. Please help contribute towards a stable build.
\n
Usage
\n
Toggle Dext Bar
\n
Simply toggle and start typing with:
\n
alt + space
\n
Actions
\n
Each item may have it's own action. You can execute an item by double-clicking on the item or selecting it and pressing:
\n
enter
\n
Help/About
\n
Type ?
\n
Dext Package Manager
\n
Dext Package Manager (dpm) is available to download separately. dpm can be used to easily install and configure your Dext instance. Please refer to the docs over at the dpm repository for more information.
\n
$ npm install -g dext-cli
\n
Configuring
\n
The Dext configuration file is located in the .dext folder in your home directory (~/.dext/). This directory should contain a config.json file as well as a plugins folder. In here, you can drop any plugins.
To provide a free/open-source alternative to Spotlight, and Alfred.
\n
Preserve compatibility with existing Alfred workflows.
\n
Allow customization and extending via plugins and themes.
\n
\n
Contributing
\n
♥Dext and want to contribute? I am seeking contributors of any levels to help grow the application. You can help contribute to the growth of this application in many ways.
Dext is a JavaScript powered smart launcher. Built with JavaScript behind the influences of Alfred.
\n
Made compatible with Alfred workflows that is powered by node (see: alfy).
\n
\n
Note: Currently available only for Mac OS X platform. Please help contribute for Windows and Linux users.
\n
Install
\n
Download the latest zip file here and unzip the archive. Open Dext.app and follow the instructions below for usage.
\n
You can also use Homebrew Cask to download the app by running these commands:
\n
brew update\nbrew cask install dext\n
\n
NOTE: Release version may not be stable as Dext is still in it's early stage of development. Please help contribute towards a stable build.
\n
Usage
\n
Toggle Dext Bar
\n
Simply toggle and start typing with:
\n
alt + space
\n
Actions
\n
Each item may have it's own action. You can execute an item by double-clicking on the item or selecting it and pressing:
\n
enter
\n
Help/About
\n
Type ?
\n
Dext Package Manager
\n
Dext Package Manager (dpm) is available to download separately. dpm can be used to easily install and configure your Dext instance. Please refer to the docs over at the dpm repository for more information.
\n
$ npm install -g dext-cli
\n
Configuring
\n
The Dext configuration file is located in the .dext folder in your home directory (~/.dext/). This directory should contain a config.json file as well as a plugins folder. In here, you can drop any plugins.
To provide a free/open-source alternative to Spotlight, and Alfred.
\n
Preserve compatibility with existing Alfred workflows.
\n
Allow customization and extending via plugins and themes.
\n
\n
Contributing
\n
♥Dext and want to contribute? I am seeking contributors of any levels to help grow the application. You can help contribute to the growth of this application in many ways.
DevDocs.io combines multiple API documentations in a fast, organized, and searchable interface. This is an unofficial desktop app for it.
\n
\n
Features
\n
Background behavior
\n
When closing the window, the app will continue running in the background, in the dock on macOS and the tray on Linux/Windows. Right-click the dock/tray icon and choose Quit to completely quit the app. On macOS, click the dock icon to show the window. On Linux, right-click the tray icon and choose Toggle to toggle the window. On Windows, click the tray icon to toggle the window.
\n
Build-in shortcuts
\n
devdocs the website itself has great built-in shortcuts support, just check the help page in the app.
\n
\n
Planned features
\n
Please consider sponsoring me to accelerate development.
\n
\n
Menubar mode: switch beween desktop mode and menubar mode
\n
Tabs support: allow to open documentation in a new tab
\n
\n
Global shortcut
\n
Use Ctrl+Shift+D (or Command+Shift+D on macOS) to toggle the app.
\n
Install
\n
Using Homebrew
\n
brew install --cask devdocs\n
\n
Manual download
\n
You can manually download the latest release here.
\n
Development
\n
It's really easy to develop this app, no build tools like Webpack needed here, checkout ./app to get more:
\n
npm install\n\nnpm run app\n# edit files, save, refresh and it's done.
DevDocs.io combines multiple API documentations in a fast, organized, and searchable interface. This is an unofficial desktop app for it.
\n
\n
Features
\n
Background behavior
\n
When closing the window, the app will continue running in the background, in the dock on macOS and the tray on Linux/Windows. Right-click the dock/tray icon and choose Quit to completely quit the app. On macOS, click the dock icon to show the window. On Linux, right-click the tray icon and choose Toggle to toggle the window. On Windows, click the tray icon to toggle the window.
\n
Build-in shortcuts
\n
devdocs the website itself has great built-in shortcuts support, just check the help page in the app.
\n
\n
Planned features
\n
Please consider sponsoring me to accelerate development.
\n
\n
Menubar mode: switch beween desktop mode and menubar mode
\n
Tabs support: allow to open documentation in a new tab
\n
\n
Global shortcut
\n
Use Ctrl+Shift+D (or Command+Shift+D on macOS) to toggle the app.
\n
Install
\n
Using Homebrew
\n
brew install --cask devdocs\n
\n
Manual download
\n
You can manually download the latest release here.
\n
Development
\n
It's really easy to develop this app, no build tools like Webpack needed here, checkout ./app to get more:
\n
npm install\n\nnpm run app\n# edit files, save, refresh and it's done.
Diffuse is a static web application, which means it's just HTML, CSS and Javascript. No REST API, database, or anything backend-related involved. The app uses a hash, aka. fragment, based routing system, so you don't need any special server rules for routing. You can download a pre-build web-only version of Diffuse on the releases page. Diffuse uses service workers, so you may need HTTPS for it to work smoothly in certain browsers. I should also note that some source services use OAuth, so you'll need to use your own application credentials (eg. google drive client id + secret).
\n
In short:
\n
\n
Diffuse is a static, serverless, web application
\n
Routing is done using hashes/fragments (eg. diffuse.sh/#/sources)
May need own OAuth application credentials for some source services
\n
\n\n
Building it yourself
\n
This project uses Nix to manage the project's environment. If you'd like to build this project without Nix, check out the dependencies in the shell.nix file (most are available through Homebrew as well).
\n
# 🍱\n\n# 1. Setup Nix environment\n# https://nixos.org/download.html\n\n# 2. Install js dependencies\njust install-deps\n\n# 3. Build, start server & watch for changes\njust
\n
",
"readmeOriginal": "
\n
A music player that connects to your cloud/distributed storage, \nin the form of a static, serverless, web application.
Diffuse is a static web application, which means it's just HTML, CSS and Javascript. No REST API, database, or anything backend-related involved. The app uses a hash, aka. fragment, based routing system, so you don't need any special server rules for routing. You can download a pre-build web-only version of Diffuse on the releases page. Diffuse uses service workers, so you may need HTTPS for it to work smoothly in certain browsers. I should also note that some source services use OAuth, so you'll need to use your own application credentials (eg. google drive client id + secret).
\n
In short:
\n
\n
Diffuse is a static, serverless, web application
\n
Routing is done using hashes/fragments (eg. diffuse.sh/#/sources)
May need own OAuth application credentials for some source services
\n
\n\n
Building it yourself
\n
This project uses Nix to manage the project's environment. If you'd like to build this project without Nix, check out the dependencies in the shell.nix file (most are available through Homebrew as well).
\n
# 🍱\n\n# 1. Setup Nix environment\n# https://nixos.org/download.html\n\n# 2. Install js dependencies\njust install-deps\n\n# 3. Build, start server & watch for changes\njust
Open-Source collaborative IDE with many features and extremely quick setup!
\n
Currently work-in-progress/early alpha, but you can try it out with npx devsession in\nthe directory in which you want to start a coding session, or by downloading the GUI starter\nfrom the latest release.
You can run devsession from anywhere by entering npx devsession, which will automatically download,\ninstall and run devsession. You can install it globally by entering npm i -g devsession, so you can\njust invoke devsession at any time.
\n
You can also install devsession as a dev dependency to your project and create an npm script in your\npackage.json with preset CLI arguments to quickly enter a session that fits the projects needs.
\n
You can use the following arguments:
\n
\n
-p, --port [port], The port on which to run the server. Defaults to 8020.
\n
-k, --adminkey [key], This key can be used to register a user as an admin. Defaults to a random string.
\n
-d, --dir [dir], The project directory. Defaults to the current directory.
\n
-v, --verbose, Log all socket messages for debugging.
\n
-a, --autosave, Duration (in seconds) of periodic auto saving of all open files. 0 = disabled. Defaults to 120.
\n
\n
Building/Contributing
\n
The project is set up as a monorepo using Lerna. Note that, prior to doing anything else and\nespecially prior to installing dependencies, you need to run npx lerna link to establish\nsymlinks between the packages.
\n
\n
\n
To start developing, run yarn && yarn start in the root directory. This will start\na development server for the backend and the frontend and automatically recompile if\nchanges are detected. The backend starts on port 8020, the frontend on port 3000.\nTo debug, open the frontend from the url:\nhttp://localhost:3000/?adminkey=adminkey&backend=http://localhost:8020
\n
\n
\n
To run a new build, run yarn && yarn build. This will build the common package,\nthe backend, the frontend, the website and the guistarter app.
\n
\n
\n
To release a new version, run yarn && yarn pub. This will build everything, bump\nversions for all packages, upload new versions for the packages which are deployed\non npm and commit and push the version bumps. The CI pipeline will pick that up and\nredeploy the website and attach the guistarter binaries with the github release.
\n
\n
\n
Acknowledgements
\n
Notable third-party frameworks used are:
\n
\n
Microsofts Monaco as editor frontend
\n
Microsofts Typescript as primary programming language
\n
Facebooks React for frontend development
\n
Redux and Palantirs Redoodle for state management
\n
Palantirs BlueprintJs as UI library
\n
ExpressJS for the backend
\n
Socket.io for real-time communication between frontend and backend
\n
Electron for creating a standalone binary of the GUI starter
\n
ngrok and localtunnel as built-in port-forwarding service
\n
Node-pty for running terminals in the backend
\n
xterm for displaying terminals in the frontend
\n
\n
...as well as many others.
\n
",
- "readmeOriginal": "
DevSession
\n
\n\n\n\n\n\n\n\n\n
\n
Open-Source collaborative IDE with many features and extremely quick setup!
\n
Currently work-in-progress/early alpha, but you can try it out with npx devsession in\nthe directory in which you want to start a coding session, or by downloading the GUI starter\nfrom the latest release.
You can run devsession from anywhere by entering npx devsession, which will automatically download,\ninstall and run devsession. You can install it globally by entering npm i -g devsession, so you can\njust invoke devsession at any time.
\n
You can also install devsession as a dev dependency to your project and create an npm script in your\npackage.json with preset CLI arguments to quickly enter a session that fits the projects needs.
\n
You can use the following arguments:
\n
\n
-p, --port [port], The port on which to run the server. Defaults to 8020.
\n
-k, --adminkey [key], This key can be used to register a user as an admin. Defaults to a random string.
\n
-d, --dir [dir], The project directory. Defaults to the current directory.
\n
-v, --verbose, Log all socket messages for debugging.
\n
-a, --autosave, Duration (in seconds) of periodic auto saving of all open files. 0 = disabled. Defaults to 120.
\n
\n
Building/Contributing
\n
The project is set up as a monorepo using Lerna. Note that, prior to doing anything else and\nespecially prior to installing dependencies, you need to run npx lerna link to establish\nsymlinks between the packages.
\n
\n
\n
To start developing, run yarn && yarn start in the root directory. This will start\na development server for the backend and the frontend and automatically recompile if\nchanges are detected. The backend starts on port 8020, the frontend on port 3000.\nTo debug, open the frontend from the url:\nhttp://localhost:3000/?adminkey=adminkey&backend=http://localhost:8020
\n
\n
\n
To run a new build, run yarn && yarn build. This will build the common package,\nthe backend, the frontend, the website and the guistarter app.
\n
\n
\n
To release a new version, run yarn && yarn pub. This will build everything, bump\nversions for all packages, upload new versions for the packages which are deployed\non npm and commit and push the version bumps. The CI pipeline will pick that up and\nredeploy the website and attach the guistarter binaries with the github release.
\n
\n
\n
Acknowledgements
\n
Notable third-party frameworks used are:
\n
\n
Microsofts Monaco as editor frontend
\n
Microsofts Typescript as primary programming language
\n
Facebooks React for frontend development
\n
Redux and Palantirs Redoodle for state management
\n
Palantirs BlueprintJs as UI library
\n
ExpressJS for the backend
\n
Socket.io for real-time communication between frontend and backend
\n
Electron for creating a standalone binary of the GUI starter
\n
ngrok and localtunnel as built-in port-forwarding service
Better access to computer hardware (microphone and speakers)
\n
Improved system notifications when a conversation is offered
\n
Support for click-to-call (tel:+18889107555)
\n
Busylight support
\n
Auto-update and installation of new versions in the background
\n
Copy/paste support
\n
Native menu
\n
Prevent system sleep
\n
\n
About:
\n
Dixa is a born global customer service tech company on a mission to solve customer chaos, eliminate bad customer service and build strong bonds between companies and their customers - much like the connection between friends.
\n
Our software eliminates chaos caused by using disconnected systems and unifies the customer experience across email, chat, messaging and phone.
\n
Dixa has customers in 20+ countries and has rocketed from new entrant to the #1 ranked SaaS Contact Center platform in just over 1 year.
Better access to computer hardware (microphone and speakers)
\n
Improved system notifications when a conversation is offered
\n
Support for click-to-call (tel:+18889107555)
\n
Busylight support
\n
Auto-update and installation of new versions in the background
\n
Copy/paste support
\n
Native menu
\n
Prevent system sleep
\n
\n
About:
\n
Dixa is a born global customer service tech company on a mission to solve customer chaos, eliminate bad customer service and build strong bonds between companies and their customers - much like the connection between friends.
\n
Our software eliminates chaos caused by using disconnected systems and unifies the customer experience across email, chat, messaging and phone.
\n
Dixa has customers in 20+ countries and has rocketed from new entrant to the #1 ranked SaaS Contact Center platform in just over 1 year.
An application can install many convenient tools for platforms of OS X 、Windows and Linux .\nIt can get more and more convenience tool in the future and no need reinstall Application.
You will see your packages in Package Store page after new store config saved.
\n
\n
\n
",
"readmeOriginal": "
\n
DN Tool Container
\n
\n
An application can install many convenient tools for platforms of OS X 、Windows and Linux .\nIt can get more and more convenience tool in the future and no need reinstall Application.
DomTerm - a terminal emulator and console using DOM and JavaScript
\n
DomTerm is a combined terminal emulator and REPL console using web\ntechnlogies - i.e. JavaScript and DOM: Users can type commands which\ngets sent to an application, which evaluates the command, and displays\nthe results, typically in some kind of type-script format.
DomTerm - a terminal emulator and console using DOM and JavaScript
\n
DomTerm is a combined terminal emulator and REPL console using web\ntechnlogies - i.e. JavaScript and DOM: Users can type commands which\ngets sent to an application, which evaluates the command, and displays\nthe results, typically in some kind of type-script format.
⚠ This project is no longer actively maintained. Check out this repository by @stefnotch for an actively maintained version
\n
Download the alpha release for windows here. Report bugs or suggest features here.
\n
\n
Note: This branch is for v2.x of Downline, which is still under development. If you're interested in the currently functional v1.x, head over to this branch.
\n
",
+ "readmeOriginal": "
Downline 2.x
\n
⚠ This project is no longer actively maintained. Check out this repository by @stefnotch for an actively maintained version
\n
Download the alpha release for windows here. Report bugs or suggest features here.
\n
\n
Note: This branch is for v2.x of Downline, which is still under development. If you're interested in the currently functional v1.x, head over to this branch.
Domain Book app, an easy and straightforward way to monitor your domains' expiration date.\nIt is like a phonebook for your domains.
\n
\n
You can buy the macOS version via Paddle for only $14.99, and the Windows version via Paddle for only $14.99.
\n
Features
\n
Multi Platforms
\n
You can run the application on macOS (intel) or Windows 10 (64-bit).
\n
Simple and Easy to use
\n
A simple UI to give you the critical information about your domains, especially when you have many domains with various registrars. All you need to do is adding your domain, and the app will get all the information required from the Internet. We support a long list of domains WHOIS servers. Also, you can refresh the domain information at any time.
\n
\n
Modify the local domain information
\n
If for some reason, we were not able to get a piece of accurate information about your domains, you can use the edit screen to correct this information. Also, you can add notes and tags to help remember anything about a specific domain name.
\n
Once you modified the expiration date, a red dot will be shown near the domain to identify what you have changed. Meanwhile, if you added notes, a small page icon will appear which you can click to read these notes.
\n
\n
\n
Auto import
\n
By utilizing the powerful API that each registrar provide, we were able to provide this feature which allows you to auto import the list of your domains directly without the need to add them manually. Right now we only support four companies, and we are planning to add more shortly.
\n
\n
What will expire soon?
\n
We all know how it feels when you forget to renew your domain, that's why we have added two menus to our application, one to show you a list of all the domains which will expire in 30 days, the other one display the domains which will expire in 60 days. This way you will know when your domain will be renewed, no surprise payments anymore.
\n
\n
More info
\n
More info about the application can be seen at Darawish website.
\n
",
"readmeOriginal": "
Domain book application
\n
Domain Book app, an easy and straightforward way to monitor your domains' expiration date.\nIt is like a phonebook for your domains.
\n
\n
You can buy the macOS version via Paddle for only $14.99, and the Windows version via Paddle for only $14.99.
\n
Features
\n
Multi Platforms
\n
You can run the application on macOS (intel) or Windows 10 (64-bit).
\n
Simple and Easy to use
\n
A simple UI to give you the critical information about your domains, especially when you have many domains with various registrars. All you need to do is adding your domain, and the app will get all the information required from the Internet. We support a long list of domains WHOIS servers. Also, you can refresh the domain information at any time.
\n
\n
Modify the local domain information
\n
If for some reason, we were not able to get a piece of accurate information about your domains, you can use the edit screen to correct this information. Also, you can add notes and tags to help remember anything about a specific domain name.
\n
Once you modified the expiration date, a red dot will be shown near the domain to identify what you have changed. Meanwhile, if you added notes, a small page icon will appear which you can click to read these notes.
\n
\n
\n
Auto import
\n
By utilizing the powerful API that each registrar provide, we were able to provide this feature which allows you to auto import the list of your domains directly without the need to add them manually. Right now we only support four companies, and we are planning to add more shortly.
\n
\n
What will expire soon?
\n
We all know how it feels when you forget to renew your domain, that's why we have added two menus to our application, one to show you a list of all the domains which will expire in 30 days, the other one display the domains which will expire in 60 days. This way you will know when your domain will be renewed, no surprise payments anymore.
\n
\n
More info
\n
More info about the application can be seen at Darawish website.
⚠ This project is no longer actively maintained. Check out this repository by @stefnotch for an actively maintained version
\n
Download the alpha release for windows here. Report bugs or suggest features here.
\n
\n
Note: This branch is for v2.x of Downline, which is still under development. If you're interested in the currently functional v1.x, head over to this branch.
\n
",
- "readmeOriginal": "
Downline 2.x
\n
⚠ This project is no longer actively maintained. Check out this repository by @stefnotch for an actively maintained version
\n
Download the alpha release for windows here. Report bugs or suggest features here.
\n
\n
Note: This branch is for v2.x of Downline, which is still under development. If you're interested in the currently functional v1.x, head over to this branch.
A minimalistic music player, designed for simplicity. Built on electron, uses Howler for handling music playback, Svelte for the UI, and music-metadata to retrieve ID3 tags.
\n
This can also serve as a starting point to implement your own front-end/UI for a music Player.
Download the build for your OS. Start the application and then click on the Folders tab on the top left corner, this will bring up a window where you can select the folder where you want to play your audio files from.\nOnce you select a folder with songs, just click play.
\n
Building from the repo
\n
Clone the repository, make it your working directory, and then on your terminal run npm install.\nOnce all the dependencies have finished downloading, run npm run app-dev to test it, and npm run build to build it for your platform.
\n
Features
\n
\n
Supports: mp3, opus, ogg, wav, aac, m4a and webm.
\n
Reads ID3 tags and displays the artist and album art (if it exists).
\n
Quickly switch tracks from the playlist.
\n
Search for songs from the search bar.
\n
Instantly switch between Dark, Light and Disco modes.
\n
Use keyboard shortcuts to control playback.
\n
\n
Shortcuts
\n
Next track: 🠊 |\nPrevious track: 🠈 |\nVolume up: 🠉 |\nVolume down: 🠋 |\nPlay/pause: Space
\n
Screenshots
\n
\n\n
\n
\n\n
\n
Upcoming Features
\n
Some new features and under the hood stuff that will be or has already been implemented. They'll be included in the next update.
\n
\n
Nothing new yet!
\n
\n
Contributing
\n
Please read CONTRIBUTING.md before raising a PR or creating an issue.
A minimalistic music player, designed for simplicity. Built on electron, uses Howler for handling music playback, Svelte for the UI, and music-metadata to retrieve ID3 tags.
\n
This can also serve as a starting point to implement your own front-end/UI for a music Player.
Download the build for your OS. Start the application and then click on the Folders tab on the top left corner, this will bring up a window where you can select the folder where you want to play your audio files from.\nOnce you select a folder with songs, just click play.
\n
Building from the repo
\n
Clone the repository, make it your working directory, and then on your terminal run npm install.\nOnce all the dependencies have finished downloading, run npm run app-dev to test it, and npm run build to build it for your platform.
\n
Features
\n
\n
Supports: mp3, opus, ogg, wav, aac, m4a and webm.
\n
Reads ID3 tags and displays the artist and album art (if it exists).
\n
Quickly switch tracks from the playlist.
\n
Search for songs from the search bar.
\n
Instantly switch between Dark, Light and Disco modes.
\n
Use keyboard shortcuts to control playback.
\n
\n
Shortcuts
\n
Next track: 🠊 |\nPrevious track: 🠈 |\nVolume up: 🠉 |\nVolume down: 🠋 |\nPlay/pause: Space
\n
Screenshots
\n
\n\n
\n
\n\n
\n
Upcoming Features
\n
Some new features and under the hood stuff that will be or has already been implemented. They'll be included in the next update.
\n
\n
Nothing new yet!
\n
\n
Contributing
\n
Please read CONTRIBUTING.md before raising a PR or creating an issue.
EBTCalc (Desktop) is a Reverse Polish Notation (RPN) calculator with custom buttons, programmed in Javascript, using a convenient editor. EBTCalc runs on Windows 10, OSX, and Linux. EBTCalc is open source.
EBTCalc (Desktop) is a Reverse Polish Notation (RPN) calculator with custom buttons, programmed in Javascript, using a convenient editor. EBTCalc runs on Windows 10, OSX, and Linux. EBTCalc is open source.
A minimalistic music player, designed for simplicity. Built on electron, uses Howler for handling music playback, Svelte for the UI, and music-metadata to retrieve ID3 tags.
\n
This can also serve as a starting point to implement your own front-end/UI for a music Player.
Download the build for your OS. Start the application and then click on the Folders tab on the top left corner, this will bring up a window where you can select the folder where you want to play your audio files from.\nOnce you select a folder with songs, just click play.
\n
Building from the repo
\n
Clone the repository, make it your working directory, and then on your terminal run npm install.\nOnce all the dependencies have finished downloading, run npm run app-dev to test it, and npm run build to build it for your platform.
\n
Features
\n
\n
Supports: mp3, opus, ogg, wav, aac, m4a and webm.
\n
Reads ID3 tags and displays the artist and album art (if it exists).
\n
Quickly switch tracks from the playlist.
\n
Search for songs from the search bar.
\n
Instantly switch between Dark, Light and Disco modes.
\n
Use keyboard shortcuts to control playback.
\n
\n
Shortcuts
\n
Next track: 🠊 |\nPrevious track: 🠈 |\nVolume up: 🠉 |\nVolume down: 🠋 |\nPlay/pause: Space
\n
Screenshots
\n
\n\n
\n
\n\n
\n
Upcoming Features
\n
Some new features and under the hood stuff that will be or has already been implemented. They'll be included in the next update.
\n
\n
Nothing new yet!
\n
\n
Contributing
\n
Please read CONTRIBUTING.md before raising a PR or creating an issue.
A minimalistic music player, designed for simplicity. Built on electron, uses Howler for handling music playback, Svelte for the UI, and music-metadata to retrieve ID3 tags.
\n
This can also serve as a starting point to implement your own front-end/UI for a music Player.
Download the build for your OS. Start the application and then click on the Folders tab on the top left corner, this will bring up a window where you can select the folder where you want to play your audio files from.\nOnce you select a folder with songs, just click play.
\n
Building from the repo
\n
Clone the repository, make it your working directory, and then on your terminal run npm install.\nOnce all the dependencies have finished downloading, run npm run app-dev to test it, and npm run build to build it for your platform.
\n
Features
\n
\n
Supports: mp3, opus, ogg, wav, aac, m4a and webm.
\n
Reads ID3 tags and displays the artist and album art (if it exists).
\n
Quickly switch tracks from the playlist.
\n
Search for songs from the search bar.
\n
Instantly switch between Dark, Light and Disco modes.
\n
Use keyboard shortcuts to control playback.
\n
\n
Shortcuts
\n
Next track: 🠊 |\nPrevious track: 🠈 |\nVolume up: 🠉 |\nVolume down: 🠋 |\nPlay/pause: Space
\n
Screenshots
\n
\n\n
\n
\n\n
\n
Upcoming Features
\n
Some new features and under the hood stuff that will be or has already been implemented. They'll be included in the next update.
\n
\n
Nothing new yet!
\n
\n
Contributing
\n
Please read CONTRIBUTING.md before raising a PR or creating an issue.
No more! Stop copy/pasting magnet links and uploading torrent files through a tedious webinterface. Electorrent is your new desktop remote torrenting application. Remote control your NAS, VPS, seedbox - you name it.
\n
Support
\n
Electorrent can connect to the following bittorrent clients:
When using rTorrent you have to configure your http server correctly. Follow this guide to make sure you have it set up correctly. Alternative you may be able to use /plugins/httprpc/action.php as the path if your have the HTTPRPC plugin installed.
No more! Stop copy/pasting magnet links and uploading torrent files through a tedious webinterface. Electorrent is your new desktop remote torrenting application. Remote control your NAS, VPS, seedbox - you name it.
\n
Support
\n
Electorrent can connect to the following bittorrent clients:
When using rTorrent you have to configure your http server correctly. Follow this guide to make sure you have it set up correctly. Alternative you may be able to use /plugins/httprpc/action.php as the path if your have the HTTPRPC plugin installed.
ElectroCRUD is Open Source Database CRUD (Create, Read, Update, Delete) Software. No Code Needed — Just in a few clicks, you can create a Database Admin/Dashboard/Whatever. Its Open Source — It's Free.
\n
Why?
\n
After a failed search for a basic admin panel that does not involve writing code or installs web-based solutions, I came up with ElectroCRUD idea.
\n
ElectroCRUD v1
\n
The ElectroCRUD v1 was born in 2016. An Electron application that made it possible to create a friendly dashboard with data tables, search, widgets, filter & relations with few clicks without any experience in programming.
\n
ElectroCRUD v2
\n
After a few years of the project being inactive, I decided to bring it to life again. The codebase was built from scratch using Electron+Angular8. The new version contains most of the features of the first version, and new features are added on a weekly basis.
\n
From version 2.7.0 SQLite has been added, currently its very limited support but we working on full support for next version.
\n
\n
\n
Functionality
\n
\n
MySQL Support
\n
PostgreSQL Support
\n
SQLite Support (limited support, work in progress)
\n
SSH Tunnels (Keys & Password)
\n
Accounts (represent a database)\n
\n
Add / Edit
\n
Test connection (ssh, db)
\n
Export / Import
\n
\n
\n
Views (represent a table)\n
\n
Add new view & Edit view configurations
\n
Data table with pagination
\n
Search
\n
Permissions (C,R,U,D)
\n
Terminology
\n
Selection of columns to display or search by
\n
Add new record / Edit record
\n
Edit record
\n
Connect existing view as sub views
\n
Export data in various formats like: csv, dump
\n
\n
\n
Custom SQL Queries
\n
Subviews (represent a sub table)
\n
Views relations\n
\n
Drill from view to view (subview)
\n
Column based tables relation (left join)
\n
\n
\n
View widgets (display aggragated data in the view)\n
\n
Add / Edit / Remove widgets
\n
Aggregation functions (AVG, SUM, MIN, MAX, COUNT)
\n
Apply filters on widget data
\n
\n
\n
View filters (build where clauses to filter the data)\n
\n
Add / Edit / Remove filter in each view
\n
One click apply / unapply on view data
\n
Simple & friendly interface to build where clauses
CSC_IDENTITY_AUTO_DISCOVERY=false npm run electron:mac-win-linux
\n
\n\n
\n
",
- "readmeOriginal": "
\n
ElectroCRUD 2
\n
ElectroCRUD?
\n
ElectroCRUD is Open Source Database CRUD (Create, Read, Update, Delete) Software. No Code Needed — Just in a few clicks, you can create a Database Admin/Dashboard/Whatever. Its Open Source — It's Free.
\n
Why?
\n
After a failed search for a basic admin panel that does not involve writing code or installs web-based solutions, I came up with ElectroCRUD idea.
\n
ElectroCRUD v1
\n
The ElectroCRUD v1 was born in 2016. An Electron application that made it possible to create a friendly dashboard with data tables, search, widgets, filter & relations with few clicks without any experience in programming.
\n
ElectroCRUD v2
\n
After a few years of the project being inactive, I decided to bring it to life again. The codebase was built from scratch using Electron+Angular8. The new version contains most of the features of the first version, and new features are added on a weekly basis.
\n
From version 2.7.0 SQLite has been added, currently its very limited support but we working on full support for next version.
\n
\n
\n
Functionality
\n
\n
MySQL Support
\n
PostgreSQL Support
\n
SQLite Support (limited support, work in progress)
\n
SSH Tunnels (Keys & Password)
\n
Accounts (represent a database)\n
\n
Add / Edit
\n
Test connection (ssh, db)
\n
Export / Import
\n
\n
\n
Views (represent a table)\n
\n
Add new view & Edit view configurations
\n
Data table with pagination
\n
Search
\n
Permissions (C,R,U,D)
\n
Terminology
\n
Selection of columns to display or search by
\n
Add new record / Edit record
\n
Edit record
\n
Connect existing view as sub views
\n
Export data in various formats like: csv, dump
\n
\n
\n
Custom SQL Queries
\n
Subviews (represent a sub table)
\n
Views relations\n
\n
Drill from view to view (subview)
\n
Column based tables relation (left join)
\n
\n
\n
View widgets (display aggragated data in the view)\n
\n
Add / Edit / Remove widgets
\n
Aggregation functions (AVG, SUM, MIN, MAX, COUNT)
\n
Apply filters on widget data
\n
\n
\n
View filters (build where clauses to filter the data)\n
\n
Add / Edit / Remove filter in each view
\n
One click apply / unapply on view data
\n
Simple & friendly interface to build where clauses
EBTCalc (Desktop) is a Reverse Polish Notation (RPN) calculator with custom buttons, programmed in Javascript, using a convenient editor. EBTCalc runs on Windows 10, OSX, and Linux. EBTCalc is open source.
EBTCalc (Desktop) is a Reverse Polish Notation (RPN) calculator with custom buttons, programmed in Javascript, using a convenient editor. EBTCalc runs on Windows 10, OSX, and Linux. EBTCalc is open source.
A clipboard manger that support text and images for now.\nThis cliboard is inspired by Ditto for Windows.\nif you on windows use ditto instead of this. Hence it is far better than this at current stage.\ni needed a same solution for linux and mac so i built it for myself.
\n
Since it is not configurable right now so let me give you a tour.\nIt allows you to copy and paste images/text while keeping your cliboard histroy as well. voila!\nYou can search through your texts using pannel.\nYou can hide/show tha app using alt+space for mac/windows/linux.
\n
The main thing i wanted was to be able to have a hot key for recent copied commands.
\n
So,\nYou have ctrl+1 to ... ctrl + 5 for your most recent 5 copied text or images at your disposal.\nif your are on mac use cmnd + 1 to achieve the desire effect.\nthere is a catch here Ditto allows you to paste using the hot keys as well. Since it is writter on electron i was unable to get the funcationality. i have found the way around but it's not that good.\nSo, to be able to use that functionality you need to have the jdk (java) installed on your computer since it uses the node module that uses the jar file to trigerr keys.\nThe above solution is kind a slow and unresponsive espacially for mac.\nSo, for mac i have used the apple script within this app. so you have to allow this application accesbility feature in order to use this functionality. other wise you can use the defualt settingss which is to press the desired hot key and then press ctrl/cmnd+ v manually to paste the text on that number.
\n
\n
\n
Todo Design a fine logo ;-)
\n
\n
\n
Add about Window.
\n
\n
\n
Allow user to change keys for hiding and pasting shortcuts through gui.
\n
\n
\n
Find a perfect way to trigger pasting using hot keys without delay.
\n
\n
\n
Auto Launch on startup
\n
Any suggestion hit me up or create a pull request if you want in on fun!\n
\n
\n
\n
",
"readmeOriginal": "
Clippy
\n
Clipboard manager that makes sense
\n
A clipboard manger that support text and images for now.\nThis cliboard is inspired by Ditto for Windows.\nif you on windows use ditto instead of this. Hence it is far better than this at current stage.\ni needed a same solution for linux and mac so i built it for myself.
\n
Since it is not configurable right now so let me give you a tour.\nIt allows you to copy and paste images/text while keeping your cliboard histroy as well. voila!\nYou can search through your texts using pannel.\nYou can hide/show tha app using alt+space for mac/windows/linux.
\n
The main thing i wanted was to be able to have a hot key for recent copied commands.
\n
So,\nYou have ctrl+1 to ... ctrl + 5 for your most recent 5 copied text or images at your disposal.\nif your are on mac use cmnd + 1 to achieve the desire effect.\nthere is a catch here Ditto allows you to paste using the hot keys as well. Since it is writter on electron i was unable to get the funcationality. i have found the way around but it's not that good.\nSo, to be able to use that functionality you need to have the jdk (java) installed on your computer since it uses the node module that uses the jar file to trigerr keys.\nThe above solution is kind a slow and unresponsive espacially for mac.\nSo, for mac i have used the apple script within this app. so you have to allow this application accesbility feature in order to use this functionality. other wise you can use the defualt settingss which is to press the desired hot key and then press ctrl/cmnd+ v manually to paste the text on that number.
\n
\n
\n
Todo Design a fine logo ;-)
\n
\n
\n
Add about Window.
\n
\n
\n
Allow user to change keys for hiding and pasting shortcuts through gui.
\n
\n
\n
Find a perfect way to trigger pasting using hot keys without delay.
\n
\n
\n
Auto Launch on startup
\n
Any suggestion hit me up or create a pull request if you want in on fun!\n
ElectroCRUD is Open Source Database CRUD (Create, Read, Update, Delete) Software. No Code Needed — Just in a few clicks, you can create a Database Admin/Dashboard/Whatever. Its Open Source — It's Free.
\n
Why?
\n
After a failed search for a basic admin panel that does not involve writing code or installs web-based solutions, I came up with ElectroCRUD idea.
\n
ElectroCRUD v1
\n
The ElectroCRUD v1 was born in 2016. An Electron application that made it possible to create a friendly dashboard with data tables, search, widgets, filter & relations with few clicks without any experience in programming.
\n
ElectroCRUD v2
\n
After a few years of the project being inactive, I decided to bring it to life again. The codebase was built from scratch using Electron+Angular8. The new version contains most of the features of the first version, and new features are added on a weekly basis.
\n
From version 2.7.0 SQLite has been added, currently its very limited support but we working on full support for next version.
\n
\n
\n
Functionality
\n
\n
MySQL Support
\n
PostgreSQL Support
\n
SQLite Support (limited support, work in progress)
\n
SSH Tunnels (Keys & Password)
\n
Accounts (represent a database)\n
\n
Add / Edit
\n
Test connection (ssh, db)
\n
Export / Import
\n
\n
\n
Views (represent a table)\n
\n
Add new view & Edit view configurations
\n
Data table with pagination
\n
Search
\n
Permissions (C,R,U,D)
\n
Terminology
\n
Selection of columns to display or search by
\n
Add new record / Edit record
\n
Edit record
\n
Connect existing view as sub views
\n
Export data in various formats like: csv, dump
\n
\n
\n
Custom SQL Queries
\n
Subviews (represent a sub table)
\n
Views relations\n
\n
Drill from view to view (subview)
\n
Column based tables relation (left join)
\n
\n
\n
View widgets (display aggragated data in the view)\n
\n
Add / Edit / Remove widgets
\n
Aggregation functions (AVG, SUM, MIN, MAX, COUNT)
\n
Apply filters on widget data
\n
\n
\n
View filters (build where clauses to filter the data)\n
\n
Add / Edit / Remove filter in each view
\n
One click apply / unapply on view data
\n
Simple & friendly interface to build where clauses
CSC_IDENTITY_AUTO_DISCOVERY=false npm run electron:mac-win-linux
\n
\n\n
\n
",
+ "readmeOriginal": "
\n
ElectroCRUD 2
\n
ElectroCRUD?
\n
ElectroCRUD is Open Source Database CRUD (Create, Read, Update, Delete) Software. No Code Needed — Just in a few clicks, you can create a Database Admin/Dashboard/Whatever. Its Open Source — It's Free.
\n
Why?
\n
After a failed search for a basic admin panel that does not involve writing code or installs web-based solutions, I came up with ElectroCRUD idea.
\n
ElectroCRUD v1
\n
The ElectroCRUD v1 was born in 2016. An Electron application that made it possible to create a friendly dashboard with data tables, search, widgets, filter & relations with few clicks without any experience in programming.
\n
ElectroCRUD v2
\n
After a few years of the project being inactive, I decided to bring it to life again. The codebase was built from scratch using Electron+Angular8. The new version contains most of the features of the first version, and new features are added on a weekly basis.
\n
From version 2.7.0 SQLite has been added, currently its very limited support but we working on full support for next version.
\n
\n
\n
Functionality
\n
\n
MySQL Support
\n
PostgreSQL Support
\n
SQLite Support (limited support, work in progress)
\n
SSH Tunnels (Keys & Password)
\n
Accounts (represent a database)\n
\n
Add / Edit
\n
Test connection (ssh, db)
\n
Export / Import
\n
\n
\n
Views (represent a table)\n
\n
Add new view & Edit view configurations
\n
Data table with pagination
\n
Search
\n
Permissions (C,R,U,D)
\n
Terminology
\n
Selection of columns to display or search by
\n
Add new record / Edit record
\n
Edit record
\n
Connect existing view as sub views
\n
Export data in various formats like: csv, dump
\n
\n
\n
Custom SQL Queries
\n
Subviews (represent a sub table)
\n
Views relations\n
\n
Drill from view to view (subview)
\n
Column based tables relation (left join)
\n
\n
\n
View widgets (display aggragated data in the view)\n
\n
Add / Edit / Remove widgets
\n
Aggregation functions (AVG, SUM, MIN, MAX, COUNT)
\n
Apply filters on widget data
\n
\n
\n
View filters (build where clauses to filter the data)\n
\n
Add / Edit / Remove filter in each view
\n
One click apply / unapply on view data
\n
Simple & friendly interface to build where clauses
In order to use this source code you need to have Node.js, Git and Bower installed globally. After that you have to follow the steps below.
\n
# Clone this repository\ngit clone https://github.com/florianfe/Elements\n# Go into the repository\ncd Elements\n# Install npm dependencies\nnpm install\n# Install bower dependencies\nbower install\n# Run the app in test mode\nnpm start\n# build application for release\nnpm run-script dist
In order to use this source code you need to have Node.js, Git and Bower installed globally. After that you have to follow the steps below.
\n
# Clone this repository\ngit clone https://github.com/florianfe/Elements\n# Go into the repository\ncd Elements\n# Install npm dependencies\nnpm install\n# Install bower dependencies\nbower install\n# Run the app in test mode\nnpm start\n# build application for release\nnpm run-script dist
Download the latest version for Windows10 at Microsoft Store.
\n
🍻 Contribution
\n
I need more locale files. \nWhen you have translated the menu into your language, could you please send me the locale file as a pull request?
\n\n
Create {your_LANG}.json in src/locales.
\n
Then import the locale file into src/lib/setLocales.ts as follows:
\n\n
{\n i18next.init({\n lng: locale,\n fallbackLng: 'en',\n resources: {\n en: { translation: en },\n ja: { translation: ja },\n+ de: { translation: de },\n },\n });\n };\n\">
import en from './locales/en.json';\n import ja from './locales/ja.json';\n+ import de from './locales/de.json';\n\n export const setLocales = (locale: string): void => {\n i18next.init({\n lng: locale,\n fallbackLng: 'en',\n resources: {\n en: { translation: en },\n ja: { translation: ja },\n+ de: { translation: de },\n },\n });\n };
Download the latest version for Windows10 at Microsoft Store.
\n
🍻 Contribution
\n
I need more locale files. \nWhen you have translated the menu into your language, could you please send me the locale file as a pull request?
\n\n
Create {your_LANG}.json in src/locales.
\n
Then import the locale file into src/lib/setLocales.ts as follows:
\n\n
import en from './locales/en.json';\n import ja from './locales/ja.json';\n+ import de from './locales/de.json';\n\n export const setLocales = (locale: string): void => {\n i18next.init({\n lng: locale,\n fallbackLng: 'en',\n resources: {\n en: { translation: en },\n ja: { translation: ja },\n+ de: { translation: de },\n },\n });\n };
Encrypt and Decrypt files on a Mac, Windows or Linux using a Passphrase
\n
\n
💡 Motivation
\n
Sometimes you just need a quick way to encrypt files securely using a passphrase. I started this project to explore the world of Electron and learn about cryptography.
\n
encrypt0r provides a simple drag and drop interface to encrypt/decrypt your files using a password.
\n
🔏 Signing Issues
\n
When running the app on Mac/Windows, you might get an untrusted developer warning. This is because the app is not signed by the developer (aka me). Signing an app requires a Signing Certificate that costs hundreds of dollars per year. Apart from the warning, the app works as advertised.
Encrypt and Decrypt files on a Mac, Windows or Linux using a Passphrase
\n
\n
💡 Motivation
\n
Sometimes you just need a quick way to encrypt files securely using a passphrase. I started this project to explore the world of Electron and learn about cryptography.
\n
encrypt0r provides a simple drag and drop interface to encrypt/decrypt your files using a password.
\n
🔏 Signing Issues
\n
When running the app on Mac/Windows, you might get an untrusted developer warning. This is because the app is not signed by the developer (aka me). Signing an app requires a Signing Certificate that costs hundreds of dollars per year. Apart from the warning, the app works as advertised.
ElectronMail is an Electron-based unofficial desktop client for ProtonMail. The app aims to provide enhanced desktop user experience enabling features that are not supported by the official in-browser web clients.\nIt is written in TypeScript and uses Angular.
\n
\n\n\n
\n
\n
Download
\n
The download page with Linux/OSX/Windows installation packages is here.
\n
The way of verifying that the installation packages attached to the releases have been assembled from the source code is being provided.
\n
Some Linux package types are available for installing from the repositories (Pacman and Snap packages are being maintained by @joshirio):
⚙️Cross platform. The app works on Linux/OSX/Windows platforms. Binary installation packages located here.
\n
\n
\n
🔎Full-text search. Including email body content scanning capability. Enabled with v2.2.0 release. See the respective issue for details.
\n
\n
\n
🔎JavaScript-based/unlimited messages filtering. Enabled since v4.11.0 release. See the respective #257 for details. Requires local store feature to be enabled.
\n
\n
\n
📦Offline access to the email messages (attachments content not stored locally, but emails body content). The local store feature enables storing your messages in the encrypted database.bin file (see FAQ for file purpose details). So the app allows you to view your messages offline, running full-text search against them, exporting them to EML/JSON files. etc. Enabled since v2.0.0 release.
\n
\n
\n
📫Multi accounts support including supporting individual API entry points. For example, you can force the specific email account added in the app connect to the email provider via the Tor only by selecting the Tor version 3 address API entry point in the dropdown list and configuring a proxy as described in this message.
\n
\n
\n
🔓Automatic login into the app with a remembered the system keychain remembered master (keep me signed in feature). Integration with as a system keychain is done with the keytar module. By the way, on Linux KeePassXC implements the Secret Service interface and so it can be acting as a system keychain (for details, see the \"automatic login into the app\"-related point in the FAQ).
\n
\n
\n
🔓Automatic login into the email accounts, including filling 2FA tokens. Two auto-login delay scenarios supported in order to make it harder to correlate the identities, see the respective issue.
\n
\n
\n
🔓Persistent email account sessions. The feature introduced since v4.2.0 version with the experimental label, #227. The feature enables the scenario when you to enter the account credentials on the login form only once, manually or automatically by the app, and then you never see the login form anymore for this email account even if you restart the app (unless you explicitly dropped the session in the admin area or it got dropped by the service due to the inactivity/expiration). If this feature is enabled for the account, manual credentials filling is the preferred option as a more secure option since you don't save the account credentials anywhere (credentials are encrypted though even if saved, see settings.bin file description in the FAQ).
\n
\n
\n
🔐Encrypted local storage with switchable predefined key derivation and encryption presets. Argon2 is used as the default key derivation function.
\n
\n
\n
⚙️Switchable accounts handle buttons positioning (top , left, left-thin). See details in #36 and #175. Demo screenshots placed in the images folder (specifically this image).
\n
\n
\n
📦Batch emails export to EML files (attachments can optionally be exported in online / live mode, not available in offline mode since not stored locally). Feature released with v2.0.0-beta.4 version, requires local store feature to be enabled.
\n
\n
\n
🔐Built-in/prepackaged web clients. The prepackaged with the app proton web clients assembled from source code, see the respective official repositories. See 79 and 80 issues for details.
\n
\n
\n
⚙️Configuring proxy per account support. Enabled since v3.0.0 release. See 113 and 120 issues for details.
🔔System tray icon with a total number of unread messages shown on top of it. Enabling local store improves this feature, see #30.
\n
\n
\n
⚙️Starting minimized to tray and closing to tray opt-out features.
\n
\n
\n
🔔Native notifications for individual accounts clicking on which focuses the app window and selects respective account in the accounts list.
\n
\n
\n
📆Calendar notifications / alarms regardless of the open page (mail/calendar/settings/account/drive). The opt-in feature has been enabled since v4.9.0. See #229 for details.
\n
\n
\n
😎Making all email \"read\" in a single mouse click. Enabled since v3.8.0. Requires local store feature to be enabled.
\n
\n
\n
😎Routing images through proxy. The opt-in feature has been enabled since v4.9.0. See #312 for details.
\n
\n
\n
😎Batch mails removing bypassing the trash. Enabled since v4.9.0. Requires local store feature to be enabled.
\n
\n
\n
😎Batch mails moving between folders. Enabled since v4.5.0. Requires local store feature to be enabled.
How to build your own installation package from source code
\n
Building on Continuous Integration server
\n
The reproducible builds idea is respected by the project. So the simplest way to prepare your own installation package from the source code is to clone the project. The respective GitHub Actions CI config file comes with the project.
\n
Building locally
\n
\n
Regardless of the platform you are working on, you will need to have Node.js v15 installed. You might want to use Node Version Manager to be able to switch between the Node.js versions:\n
Make sure you are using npm v7+, not the v6 (run npm -v to see the version).
\n
Some native modules require compiling process to be involved and for that Python and C++ compiler need to be installed on the system:\n
\n
On Windows: the simplest way to install all the needed stuff on Windows is to run npm install --global --production windows-build-tools CLI command.
\n
On Linux: python, make and a C/C++ compiler toolchain, like GCC are most likely already installed. Besides keytar needs libsecret library to be installed.
\n
On macOS: python and Xcode need to be installed. You also need to install the Command Line Tools via Xcode, can be found under the Xcode -> Preferences -> Downloads menu.
\n
\n
\n
ProtonMail's WebClient requires addition environment setup if you run Windows, see.
\n
Clone this project to your local device. If you are going to contribute, consider cloning the forked into your own GitHub account project.
Install dependencies running yarn --pure-lockfile (setting PLAYWRIGHT_SKIP_BROWSER_DOWNLOAD=1 environment variable might speed up the process).
\n
Build app running yarn run app:dist.
\n
Build a package to install running npm run electron-builder:dist command to build Windows/Mac OS X package and one of the following commands to build Linux package:\n
\n
npm run electron-builder:dist:linux:appimage
\n
npm run electron-builder:dist:linux:deb
\n
npm run electron-builder:dist:linux:freebsd
\n
npm run electron-builder:dist:linux:pacman
\n
npm run electron-builder:dist:linux:rpm
\n
npm run electron-builder:dist:linux:snap
\n
\n
\n
The assembled installation package comes into the ./dist folder.
\n
\n
To recap, considering that all the described build requirements are met, the short command to build let's say Arch Linux package will be yarn --pure-lockfile && yarn app:dist && npm run electron-builder:dist:linux:pacman.
\n
Data/config files created and used by the app
\n
If you want to backup the app data these are only files you need to take care of (files localed in the settings folder):
\n
\n
config.json file keeps config parameters. There is no sensitive data in this file, so unencrypted.
\n
settings.bin file keeps added to the app accounts including credentials if a user decided to save them. The file is encrypted with 32 bytes length key derived from the master password.
\n
database.bin file is a local database that keeps fetched emails/folders/contacts entities if the local store feature was enabled for at least one account. The file is encrypted with 32 bytes length key randomly generated and stored in settings.bin. The app by design flushes and loads to memory the database.bin file as a whole thing but not like encrypting only the specific columns of the database. It's of course not an optimal approach in terms of performance and resource consumption but it allows keeping the metadata hidden. You can see some details here.
\n
database-session.bin file is being used in the same way and for the same purpose as database.bin but it holds the current session data only. The data from this file will be merged to the database.bin on the next app unlocking with the master password.
\n
session.bin file holds the session data of the email accounts. The file is used if the Persistent Session feature is enabled for at least one account (the feature introduced since v4.2.0 version with experimental label, #227). The file is encrypted with 32 bytes length key randomly generated and stored in settings.bin.
\n
log.log file keeps log lines. The log level by default is set to error (see config.json file).
\n
\n
Removing the app
\n
It's recommended to perform the following actions before uninstalling the app:
\n
\n
If you had the Keep me signed in feature enabled (see screenshot), click Log-out action in the app menu (see screenshot). That will remove locally stored master password (done with node-keytar). You can also remove it having the app already uninstalled, but that would be a more complicated way as you will have to manually edit the system's keychain.
\n
Remove settings folder manually. You can locate settings folder path clicking Open setting folder app/tray menu item (see screenshot) or reading app.getPath(name =\"userData\") related app.getPath(name) section here.
\n
\n
",
"readmeOriginal": "
\n \n
\n
ElectronMail is an Electron-based unofficial desktop client for ProtonMail. The app aims to provide enhanced desktop user experience enabling features that are not supported by the official in-browser web clients.\nIt is written in TypeScript and uses Angular.
\n
\n\n\n
\n
\n
Download
\n
The download page with Linux/OSX/Windows installation packages is here.
\n
The way of verifying that the installation packages attached to the releases have been assembled from the source code is being provided.
\n
Some Linux package types are available for installing from the repositories (Pacman and Snap packages are being maintained by @joshirio):
⚙️Cross platform. The app works on Linux/OSX/Windows platforms. Binary installation packages located here.
\n
\n
\n
🔎Full-text search. Including email body content scanning capability. Enabled with v2.2.0 release. See the respective issue for details.
\n
\n
\n
🔎JavaScript-based/unlimited messages filtering. Enabled since v4.11.0 release. See the respective #257 for details. Requires local store feature to be enabled.
\n
\n
\n
📦Offline access to the email messages (attachments content not stored locally, but emails body content). The local store feature enables storing your messages in the encrypted database.bin file (see FAQ for file purpose details). So the app allows you to view your messages offline, running full-text search against them, exporting them to EML/JSON files. etc. Enabled since v2.0.0 release.
\n
\n
\n
📫Multi accounts support including supporting individual API entry points. For example, you can force the specific email account added in the app connect to the email provider via the Tor only by selecting the Tor version 3 address API entry point in the dropdown list and configuring a proxy as described in this message.
\n
\n
\n
🔓Automatic login into the app with a remembered the system keychain remembered master (keep me signed in feature). Integration with as a system keychain is done with the keytar module. By the way, on Linux KeePassXC implements the Secret Service interface and so it can be acting as a system keychain (for details, see the \"automatic login into the app\"-related point in the FAQ).
\n
\n
\n
🔓Automatic login into the email accounts, including filling 2FA tokens. Two auto-login delay scenarios supported in order to make it harder to correlate the identities, see the respective issue.
\n
\n
\n
🔓Persistent email account sessions. The feature introduced since v4.2.0 version with the experimental label, #227. The feature enables the scenario when you to enter the account credentials on the login form only once, manually or automatically by the app, and then you never see the login form anymore for this email account even if you restart the app (unless you explicitly dropped the session in the admin area or it got dropped by the service due to the inactivity/expiration). If this feature is enabled for the account, manual credentials filling is the preferred option as a more secure option since you don't save the account credentials anywhere (credentials are encrypted though even if saved, see settings.bin file description in the FAQ).
\n
\n
\n
🔐Encrypted local storage with switchable predefined key derivation and encryption presets. Argon2 is used as the default key derivation function.
\n
\n
\n
⚙️Switchable accounts handle buttons positioning (top , left, left-thin). See details in #36 and #175. Demo screenshots placed in the images folder (specifically this image).
\n
\n
\n
📦Batch emails export to EML files (attachments can optionally be exported in online / live mode, not available in offline mode since not stored locally). Feature released with v2.0.0-beta.4 version, requires local store feature to be enabled.
\n
\n
\n
🔐Built-in/prepackaged web clients. The prepackaged with the app proton web clients assembled from source code, see the respective official repositories. See 79 and 80 issues for details.
\n
\n
\n
⚙️Configuring proxy per account support. Enabled since v3.0.0 release. See 113 and 120 issues for details.
🔔System tray icon with a total number of unread messages shown on top of it. Enabling local store improves this feature, see #30.
\n
\n
\n
⚙️Starting minimized to tray and closing to tray opt-out features.
\n
\n
\n
🔔Native notifications for individual accounts clicking on which focuses the app window and selects respective account in the accounts list.
\n
\n
\n
📆Calendar notifications / alarms regardless of the open page (mail/calendar/settings/account/drive). The opt-in feature has been enabled since v4.9.0. See #229 for details.
\n
\n
\n
😎Making all email \"read\" in a single mouse click. Enabled since v3.8.0. Requires local store feature to be enabled.
\n
\n
\n
😎Routing images through proxy. The opt-in feature has been enabled since v4.9.0. See #312 for details.
\n
\n
\n
😎Batch mails removing bypassing the trash. Enabled since v4.9.0. Requires local store feature to be enabled.
\n
\n
\n
😎Batch mails moving between folders. Enabled since v4.5.0. Requires local store feature to be enabled.
How to build your own installation package from source code
\n
Building on Continuous Integration server
\n
The reproducible builds idea is respected by the project. So the simplest way to prepare your own installation package from the source code is to clone the project. The respective GitHub Actions CI config file comes with the project.
\n
Building locally
\n
\n
Regardless of the platform you are working on, you will need to have Node.js v15 installed. You might want to use Node Version Manager to be able to switch between the Node.js versions:\n
Make sure you are using npm v7+, not the v6 (run npm -v to see the version).
\n
Some native modules require compiling process to be involved and for that Python and C++ compiler need to be installed on the system:\n
\n
On Windows: the simplest way to install all the needed stuff on Windows is to run npm install --global --production windows-build-tools CLI command.
\n
On Linux: python, make and a C/C++ compiler toolchain, like GCC are most likely already installed. Besides keytar needs libsecret library to be installed.
\n
On macOS: python and Xcode need to be installed. You also need to install the Command Line Tools via Xcode, can be found under the Xcode -> Preferences -> Downloads menu.
\n
\n
\n
ProtonMail's WebClient requires addition environment setup if you run Windows, see.
\n
Clone this project to your local device. If you are going to contribute, consider cloning the forked into your own GitHub account project.
Install dependencies running yarn --pure-lockfile (setting PLAYWRIGHT_SKIP_BROWSER_DOWNLOAD=1 environment variable might speed up the process).
\n
Build app running yarn run app:dist.
\n
Build a package to install running npm run electron-builder:dist command to build Windows/Mac OS X package and one of the following commands to build Linux package:\n
\n
npm run electron-builder:dist:linux:appimage
\n
npm run electron-builder:dist:linux:deb
\n
npm run electron-builder:dist:linux:freebsd
\n
npm run electron-builder:dist:linux:pacman
\n
npm run electron-builder:dist:linux:rpm
\n
npm run electron-builder:dist:linux:snap
\n
\n
\n
The assembled installation package comes into the ./dist folder.
\n
\n
To recap, considering that all the described build requirements are met, the short command to build let's say Arch Linux package will be yarn --pure-lockfile && yarn app:dist && npm run electron-builder:dist:linux:pacman.
\n
Data/config files created and used by the app
\n
If you want to backup the app data these are only files you need to take care of (files localed in the settings folder):
\n
\n
config.json file keeps config parameters. There is no sensitive data in this file, so unencrypted.
\n
settings.bin file keeps added to the app accounts including credentials if a user decided to save them. The file is encrypted with 32 bytes length key derived from the master password.
\n
database.bin file is a local database that keeps fetched emails/folders/contacts entities if the local store feature was enabled for at least one account. The file is encrypted with 32 bytes length key randomly generated and stored in settings.bin. The app by design flushes and loads to memory the database.bin file as a whole thing but not like encrypting only the specific columns of the database. It's of course not an optimal approach in terms of performance and resource consumption but it allows keeping the metadata hidden. You can see some details here.
\n
database-session.bin file is being used in the same way and for the same purpose as database.bin but it holds the current session data only. The data from this file will be merged to the database.bin on the next app unlocking with the master password.
\n
session.bin file holds the session data of the email accounts. The file is used if the Persistent Session feature is enabled for at least one account (the feature introduced since v4.2.0 version with experimental label, #227). The file is encrypted with 32 bytes length key randomly generated and stored in settings.bin.
\n
log.log file keeps log lines. The log level by default is set to error (see config.json file).
\n
\n
Removing the app
\n
It's recommended to perform the following actions before uninstalling the app:
\n
\n
If you had the Keep me signed in feature enabled (see screenshot), click Log-out action in the app menu (see screenshot). That will remove locally stored master password (done with node-keytar). You can also remove it having the app already uninstalled, but that would be a more complicated way as you will have to manually edit the system's keychain.
\n
Remove settings folder manually. You can locate settings folder path clicking Open setting folder app/tray menu item (see screenshot) or reading app.getPath(name =\"userData\") related app.getPath(name) section here.
EnderFramework enables you to build cross-platform applications using JavaScript, HTML, and CSS. It is based on Electron. Why make a new framework out of another framework? Glad you asked! This framework will be more focused on introducing custom elements, custom designs, and custom APIs on top of the originals! And giving the user the ability to build a full-on custom app, with a fully customizable UI using CSS, in a matter of minutes.
\n
You can find out more about this framework in here!
\n
Note: the framework is still in the very early development stages. We are open to suggestions.
\n
Installation
\n
To run EnderFramework, you need to have NodeJS and VS Build Tools 2017 installed on your device. Execute npm install to install all the modules. And then, after the installation process is done, execute npm start.
\n
You can change the start file code (core/start.js) to start any app! Look for the ready event in the file.
\n
app.on(\"ready\",function(){\n for(vari=0;i<process.argv.length;i++){\n if(process.argv[i].includes(\"--start=\")){//You can change this to true!\n done=true;\n varappID=process.argv[i].replace(/\\s/g,'').substring(8),\n length=appID.replace(/[^.]/g,\"\").length;\n /*And replace the code above with any value you want, such as:\n var appID = \"com.enderadel.test\",\n length = appID.replace(/[^.]/g, \"\").length;*/\n [...]\n }elseif(process.argv[i]==\"--store\"){//You can change this to true!\n [...]\n }elseif(process.argv[i]==\"--installer\"){//You can change this to true!\n [...]\n }elseif(process.argv[i]==\"--studio\"){//You can change this to true!\n [...]\n }elseif(process.argv[i]==\"--settings\"){//You can change this to true!\n [...]\n }\n }\n [...]\n});
\n
Quick start
\n
Coming soon!
\n
Reporting Bugs and requesting Features
\n
You can report bugs and request new features by opening a new issue.
\n
Contributing
\n
If you are interested in reporting/fixing issues and contributing directly to the code base, feel free to do so! Please read CONTRIBUTING.md for more information!
\n
Note:As you can see, I'm not very active on GitHub. The reason is because I'm a student. You can contact me on my email (adel.sbeh.email@gmail.com) regarding any concern!
\n
Screenshots
\n
\n
\n
The framework supports light mode and dark mode!\n\n
When using the logos of EnderFramework, or GitHub, be sure to follow the GitHub logo guidelines.
\n
More
\n
Follow @_EnderCommunity on Twitter to keep yourself up-to-date on everything related to the framework. You can also join our Discord server.
\n
EnderFramework is the property of EnderCommunity
\n
",
- "readmeOriginal": "
\n
\n
EnderFramework enables you to build cross-platform applications using JavaScript, HTML, and CSS. It is based on Electron. Why make a new framework out of another framework? Glad you asked! This framework will be more focused on introducing custom elements, custom designs, and custom APIs on top of the originals! And giving the user the ability to build a full-on custom app, with a fully customizable UI using CSS, in a matter of minutes.
\n
You can find out more about this framework in here!
\n
Note: the framework is still in the very early development stages. We are open to suggestions.
\n
Installation
\n
To run EnderFramework, you need to have NodeJS and VS Build Tools 2017 installed on your device. Execute npm install to install all the modules. And then, after the installation process is done, execute npm start.
\n
You can change the start file code (core/start.js) to start any app! Look for the ready event in the file.
\n
app.on(\"ready\",function(){\n for(vari=0;i<process.argv.length;i++){\n if(process.argv[i].includes(\"--start=\")){//You can change this to true!\n done=true;\n varappID=process.argv[i].replace(/\\s/g,'').substring(8),\n length=appID.replace(/[^.]/g,\"\").length;\n /*And replace the code above with any value you want, such as:\n var appID = \"com.enderadel.test\",\n length = appID.replace(/[^.]/g, \"\").length;*/\n [...]\n }elseif(process.argv[i]==\"--store\"){//You can change this to true!\n [...]\n }elseif(process.argv[i]==\"--installer\"){//You can change this to true!\n [...]\n }elseif(process.argv[i]==\"--studio\"){//You can change this to true!\n [...]\n }elseif(process.argv[i]==\"--settings\"){//You can change this to true!\n [...]\n }\n }\n [...]\n});
\n
Quick start
\n
Coming soon!
\n
Reporting Bugs and requesting Features
\n
You can report bugs and request new features by opening a new issue.
\n
Contributing
\n
If you are interested in reporting/fixing issues and contributing directly to the code base, feel free to do so! Please read CONTRIBUTING.md for more information!
\n
Note:As you can see, I'm not very active on GitHub. The reason is because I'm a student. You can contact me on my email (adel.sbeh.email@gmail.com) regarding any concern!
\n
Screenshots
\n
\n
\n
The framework supports light mode and dark mode!\n\n
A Cross-Platform Desktop App for processing all rows of excel files
\n
Simply generates an array of items from the rows of an excel file and does the repetitive tedious operations step by step\nrecursively till every item of the array is processed. For example downloading all the URL's in an excel file.
Just select or drag & drop an excel file, then select the output folder for the downloaded images or files. All of the\nitems in the excel file will be downloaded into the selected folder and you will be notified about the state of ongoing\nprogress.
Asset URL ( can be any type of file jpg, jpeg, png, txt, doc, etc)
\n
\n
\n
\n\n
\n \n
Currently there is no limit for n, I tested with 4000 items and unless your IP is banned from the publisher there\nis no problem to download as much as you can.
\n
Demo
\n
\n
Development
\n
You need to have Node.js installed on your computer in order to develop & build this app.
\n
$ git clone https://github.com/btargac/excel-parser-processor.git\n$ cd excel-parser-processor\n$ npm install\n$ npm run build\n$ npm start
\n
If you are changing the view or renderer related things, you can use webpack's watch feature with
\n
$ npm run start-renderer-dev
\n
After running this command, you'll see a webpack process watching your files after a new renderer.bundle.js is generated\nyou can refresh the excel parser processor app window with cmd + R or ctrl + R depending on your system.
\n
To generate binaries on your computer after your development is completed, you can run;
\n
$ npm run dist
\n
This will add binaries under /release folder on your project folder.
\n
/release folder is ignored at the repository. Travis will be building the binaries after your branch is merged with master.
\n
Contributors
\n
This project exists thanks to all the people who contribute. [Code of Conduct].\n
A Cross-Platform Desktop App for processing all rows of excel files
\n
Simply generates an array of items from the rows of an excel file and does the repetitive tedious operations step by step\nrecursively till every item of the array is processed. For example downloading all the URL's in an excel file.
Just select or drag & drop an excel file, then select the output folder for the downloaded images or files. All of the\nitems in the excel file will be downloaded into the selected folder and you will be notified about the state of ongoing\nprogress.
Asset URL ( can be any type of file jpg, jpeg, png, txt, doc, etc)
\n
\n
\n
\n\n
\n \n
Currently there is no limit for n, I tested with 4000 items and unless your IP is banned from the publisher there\nis no problem to download as much as you can.
\n
Demo
\n
\n
Development
\n
You need to have Node.js installed on your computer in order to develop & build this app.
\n
$ git clone https://github.com/btargac/excel-parser-processor.git\n$ cd excel-parser-processor\n$ npm install\n$ npm run build\n$ npm start
\n
If you are changing the view or renderer related things, you can use webpack's watch feature with
\n
$ npm run start-renderer-dev
\n
After running this command, you'll see a webpack process watching your files after a new renderer.bundle.js is generated\nyou can refresh the excel parser processor app window with cmd + R or ctrl + R depending on your system.
\n
To generate binaries on your computer after your development is completed, you can run;
\n
$ npm run dist
\n
This will add binaries under /release folder on your project folder.
\n
/release folder is ignored at the repository. Travis will be building the binaries after your branch is merged with master.
\n
Contributors
\n
This project exists thanks to all the people who contribute. [Code of Conduct].\n
EnderFramework enables you to build cross-platform applications using JavaScript, HTML, and CSS. It is based on Electron. Why make a new framework out of another framework? Glad you asked! This framework will be more focused on introducing custom elements, custom designs, and custom APIs on top of the originals! And giving the user the ability to build a full-on custom app, with a fully customizable UI using CSS, in a matter of minutes.
\n
You can find out more about this framework in here!
\n
Note: the framework is still in the very early development stages. We are open to suggestions.
\n
Installation
\n
To run EnderFramework, you need to have NodeJS and VS Build Tools 2017 installed on your device. Execute npm install to install all the modules. And then, after the installation process is done, execute npm start.
\n
You can change the start file code (core/start.js) to start any app! Look for the ready event in the file.
\n
app.on(\"ready\",function(){\n for(vari=0;i<process.argv.length;i++){\n if(process.argv[i].includes(\"--start=\")){//You can change this to true!\n done=true;\n varappID=process.argv[i].replace(/\\s/g,'').substring(8),\n length=appID.replace(/[^.]/g,\"\").length;\n /*And replace the code above with any value you want, such as:\n var appID = \"com.enderadel.test\",\n length = appID.replace(/[^.]/g, \"\").length;*/\n [...]\n }elseif(process.argv[i]==\"--store\"){//You can change this to true!\n [...]\n }elseif(process.argv[i]==\"--installer\"){//You can change this to true!\n [...]\n }elseif(process.argv[i]==\"--studio\"){//You can change this to true!\n [...]\n }elseif(process.argv[i]==\"--settings\"){//You can change this to true!\n [...]\n }\n }\n [...]\n});
\n
Quick start
\n
Coming soon!
\n
Reporting Bugs and requesting Features
\n
You can report bugs and request new features by opening a new issue.
\n
Contributing
\n
If you are interested in reporting/fixing issues and contributing directly to the code base, feel free to do so! Please read CONTRIBUTING.md for more information!
\n
Note:As you can see, I'm not very active on GitHub. The reason is because I'm a student. You can contact me on my email (adel.sbeh.email@gmail.com) regarding any concern!
\n
Screenshots
\n
\n
\n
The framework supports light mode and dark mode!\n\n
When using the logos of EnderFramework, or GitHub, be sure to follow the GitHub logo guidelines.
\n
More
\n
Follow @_EnderCommunity on Twitter to keep yourself up-to-date on everything related to the framework. You can also join our Discord server.
\n
EnderFramework is the property of EnderCommunity
\n
",
+ "readmeOriginal": "
\n
\n
EnderFramework enables you to build cross-platform applications using JavaScript, HTML, and CSS. It is based on Electron. Why make a new framework out of another framework? Glad you asked! This framework will be more focused on introducing custom elements, custom designs, and custom APIs on top of the originals! And giving the user the ability to build a full-on custom app, with a fully customizable UI using CSS, in a matter of minutes.
\n
You can find out more about this framework in here!
\n
Note: the framework is still in the very early development stages. We are open to suggestions.
\n
Installation
\n
To run EnderFramework, you need to have NodeJS and VS Build Tools 2017 installed on your device. Execute npm install to install all the modules. And then, after the installation process is done, execute npm start.
\n
You can change the start file code (core/start.js) to start any app! Look for the ready event in the file.
\n
app.on(\"ready\",function(){\n for(vari=0;i<process.argv.length;i++){\n if(process.argv[i].includes(\"--start=\")){//You can change this to true!\n done=true;\n varappID=process.argv[i].replace(/\\s/g,'').substring(8),\n length=appID.replace(/[^.]/g,\"\").length;\n /*And replace the code above with any value you want, such as:\n var appID = \"com.enderadel.test\",\n length = appID.replace(/[^.]/g, \"\").length;*/\n [...]\n }elseif(process.argv[i]==\"--store\"){//You can change this to true!\n [...]\n }elseif(process.argv[i]==\"--installer\"){//You can change this to true!\n [...]\n }elseif(process.argv[i]==\"--studio\"){//You can change this to true!\n [...]\n }elseif(process.argv[i]==\"--settings\"){//You can change this to true!\n [...]\n }\n }\n [...]\n});
\n
Quick start
\n
Coming soon!
\n
Reporting Bugs and requesting Features
\n
You can report bugs and request new features by opening a new issue.
\n
Contributing
\n
If you are interested in reporting/fixing issues and contributing directly to the code base, feel free to do so! Please read CONTRIBUTING.md for more information!
\n
Note:As you can see, I'm not very active on GitHub. The reason is because I'm a student. You can contact me on my email (adel.sbeh.email@gmail.com) regarding any concern!
\n
Screenshots
\n
\n
\n
The framework supports light mode and dark mode!\n\n
🎉 This is the complete source code and the build instructions of the Hive blockchain desktop client Esteem Desktop founded by Feruz M and Lead Surfer Talha, supported by Esteem team and vast Hive community contibutors.
\n
\n
What is already implemented
\n
\n
Surfing your feed and trending/hot stuff
\n
Creating new posts
\n
Commenting
\n
Voting with any %
\n
Reading replies/comments/mentions
\n
Drafts synced with Esteem Mobile
\n
Post Schedules synced with Esteem Mobile
\n
Bookmarks synced with Esteem Mobile
\n
Favorites synced with Esteem Mobile
\n
Comments/Memo Encryption
\n
Night Mode (Dark Theme)
\n
Wallet Transfers
\n
Image Gallery
\n
Detailed Voters Info
\n
Witness Voting
\n
\n
More functions are coming!
\n
Supported systems
\n
\n
Windows XP - Windows 10
\n
Mac OS X 10.6 - Mac OS X 10.15
\n
Ubuntu 12.04 - Ubuntu 19.10
\n
Fedora 22 - Fedora 24
\n
\n
Build instructions
\n
Requirements
\n
\n
node ^6.14.0 || ^8.10.0 || >=9.10.0
\n
yarn
\n
\n
Clone
\n
$ git clone https://github.com/eSteemApp/esteem-surfer\n$ cd esteem-surfer\n
\n
Install dependencies
\n
$ yarn\n
\n
Create a dummy config.js
\n
This is for the backend server configuration. Actual server addresses are not needed for most functions.
\n
$ cp app/config.example.js app/config.js\n
\n
Run in development mode
\n
$ npm run dev\n
\n
Package
\n
$ npm run package\n
\n
Test
\n
$ npm run test\n
\n
",
"readmeOriginal": "
This is Legacy version new version is available here: Ecency desktop
🎉 This is the complete source code and the build instructions of the Hive blockchain desktop client Esteem Desktop founded by Feruz M and Lead Surfer Talha, supported by Esteem team and vast Hive community contibutors.
\n
\n
What is already implemented
\n
\n
Surfing your feed and trending/hot stuff
\n
Creating new posts
\n
Commenting
\n
Voting with any %
\n
Reading replies/comments/mentions
\n
Drafts synced with Esteem Mobile
\n
Post Schedules synced with Esteem Mobile
\n
Bookmarks synced with Esteem Mobile
\n
Favorites synced with Esteem Mobile
\n
Comments/Memo Encryption
\n
Night Mode (Dark Theme)
\n
Wallet Transfers
\n
Image Gallery
\n
Detailed Voters Info
\n
Witness Voting
\n
\n
More functions are coming!
\n
Supported systems
\n
\n
Windows XP - Windows 10
\n
Mac OS X 10.6 - Mac OS X 10.15
\n
Ubuntu 12.04 - Ubuntu 19.10
\n
Fedora 22 - Fedora 24
\n
\n
Build instructions
\n
Requirements
\n
\n
node ^6.14.0 || ^8.10.0 || >=9.10.0
\n
yarn
\n
\n
Clone
\n
$ git clone https://github.com/eSteemApp/esteem-surfer\n$ cd esteem-surfer\n
\n
Install dependencies
\n
$ yarn\n
\n
Create a dummy config.js
\n
This is for the backend server configuration. Actual server addresses are not needed for most functions.
This is a free, cross-platform ETCD v3 client and GUI. The goal of the project is twofold:
\n
\n
Provide an efficient, modern GUI for desktop (Windows, Linux, Mac), mobile (iOS and Android) and web.
\n
Cover all ETCD functionality. Anything you can do with etcdctl, you should be able to do with this tool as well. This app should be useful for simple and power users alike.
\n
\n
Please note that currently ETCD V2 API is not supported! At the moment, we support V3 only.
\n
Features
\n
Available now (v1.2)
\n
Currently, the following features are implemented:
\n
\n
Key management:\n
\n
Manage (browse, create, edit, delete) keys.
\n
Create keys with TTL
\n
Key browser has multiple views: tree or list with paging.
\n
Key list live updates: refresh list when the value of any key changes.
\n
Manage revisions: list revisions of any key and revert to any previous value.
\n
\n
\n
Settings and config:\n
\n
Able to use multiple config profiles, allowing you to manage any number of ETCD clusters with dedicated settings.
\n
Import / export settings: save settings to or load from file.
\n
\n
\n
Authentication and security:\n
\n
Basic authentication: (username / password)
\n
HTTPS client certificate authentication
\n
Supports both HTTP and HTTPS (secure) connections
\n
Supports no auth (ETCD with authentication disabled)
\n
\n
\n
Other functions:\n
\n
Display basic info about ETCD cluster and its nodes, perform health checks.
\n
Manage leases: list and revoke leases, view details.
This release is mainly for contributors. There will be no new features in this one. Instead, we gonna focus solely on making it easier to understand how the code works and how to get started with contributing. In order to achieve this, we'll refactor many parts of the code and we'll also try to provide better documentation for contributors and a project dashboard.
\n
As for refactoring, some of the things we gonna change are:
\n
\n
Better typing (we gonna add missing types, no \"any\", \"unknown\" and crap like that)
\n
Better tests (we are planning to replace Spectron with Cypress)
\n
Smaller, more focused, easy to maintain components. We are going to to use the Vue 3 Composition API here.
\n
Better folder structure for source files.
\n
Proper Dependency Injection support (for services, filters etc).
We plan to add tons of cool features in the future. The most important ones are listed below.:
\n
Features
\n
\n
Watchers: more responders, such as Email, Log to file, Log to REST API as well as app integrations like Slack, Google Chat, Viber etc.
\n
Cluster: maintenance / admin features and more detailed cluster info
\n
ETCD Dashboard: live dashboard with graphs.
\n
Complex queries using transactions.
\n
Diff tool: compare the revisions of any two keys (much like Total Commander).
\n
Report generation in different formats (HTML, PDF, XML etc)
\n
Better in-app console
\n
... and much more!
\n
\n
Future platforms
\n
\n
Android and iOS
\n
Web (browser version)
\n
\n
A better organized overview of these plans will be available soon. Stay tuned :)
\n
Installation
\n
End users..
\n
The current stable (prod) version is 1.2. It's available for Mac OS X (10.15.5 Catalina+), MS Windows (7, 8, 10+) and some major Linux distros (Ubuntu 10.04+, Arch etc). The following are pre-built binaries and this is the recommended way to install.
\n
If you are using a more or less recent major Linux distro (Ubuntu, Redhat, Suse etc), or Ubuntu LTS or some up-to-date rolling release distro like Arch, everything should work fine. Most older Linux systems should be supported as well. However, very old Linux versions might not work as expected. If you have difficulties installing the app, please report the problem using our issue tracker.
Once you have the code, simply execute the following commands:
\n
yarn install\n
\n
The next step is to compile the GRPC Node extension. This requires the usual build tools (gcc, make etc) to be installed. Make sure you have these, then run:
... where ELECTRON_VERSION is the exact version number of the Electron framework the app uses. You can determine this by running:
\n
yarn list electron\n
\n
Finally, start the dev server in the following way:
\n
yarn electron:serve\n
\n
This will start a dev build and the app should appear shortly.
\n
Usage and support
\n
First of all, in order to work properly, ETCD Manager must be configured.
\n
You need to provide only two mandatory settings: the host and the port ETCD is running at. You'll find these on the settings screen, under the ETCD tab.\nIf your ETCD host requires authentication, you will also need to provide a password / username pair or certificates / keys, which you can do under the auth tab.\nThere are several additional configuration options, but those are all optional.
\n
Detailed documentation is not available (yet), but you may want to activate quick help, which is available everywhere. Press CTRL / CMD + H to open the help pane. Here you'll find some basic info as well as all the keyboard shortcuts. This should be enough to get you started.
\n
If you still need help, please feel free to contact us. Create a issue (question / support request).
\n
Once the documentation is ready, we'll upload it to the website.
\n
Upgrading
\n
If you've installed the app using the Windows or Mac installer or the Linux AppImage, you'll be notified automatically whenever a new release is available. Simply restart the app, and it'll check for updates.
\n
Otherwise, you have to download and install the new version manually.
\n
As for the dev version, you may update that by the usual means (Yarn or Git). In any case, please read our changelog for an overview of the most recent changes.
\n
Bugs and feature requests
\n
If you find a bug, please report it using our issue tracker.
\n
This is also the place for requesting new features or asking questions. Please label your issue appropriately, use the \"bug\", \"enchantment\" and \"question\" labels, respectively.
This is a free, cross-platform ETCD v3 client and GUI. The goal of the project is twofold:
\n
\n
Provide an efficient, modern GUI for desktop (Windows, Linux, Mac), mobile (iOS and Android) and web.
\n
Cover all ETCD functionality. Anything you can do with etcdctl, you should be able to do with this tool as well. This app should be useful for simple and power users alike.
\n
\n
Please note that currently ETCD V2 API is not supported! At the moment, we support V3 only.
\n
Features
\n
Available now (v1.2)
\n
Currently, the following features are implemented:
\n
\n
Key management:\n
\n
Manage (browse, create, edit, delete) keys.
\n
Create keys with TTL
\n
Key browser has multiple views: tree or list with paging.
\n
Key list live updates: refresh list when the value of any key changes.
\n
Manage revisions: list revisions of any key and revert to any previous value.
\n
\n
\n
Settings and config:\n
\n
Able to use multiple config profiles, allowing you to manage any number of ETCD clusters with dedicated settings.
\n
Import / export settings: save settings to or load from file.
\n
\n
\n
Authentication and security:\n
\n
Basic authentication: (username / password)
\n
HTTPS client certificate authentication
\n
Supports both HTTP and HTTPS (secure) connections
\n
Supports no auth (ETCD with authentication disabled)
\n
\n
\n
Other functions:\n
\n
Display basic info about ETCD cluster and its nodes, perform health checks.
\n
Manage leases: list and revoke leases, view details.
This release is mainly for contributors. There will be no new features in this one. Instead, we gonna focus solely on making it easier to understand how the code works and how to get started with contributing. In order to achieve this, we'll refactor many parts of the code and we'll also try to provide better documentation for contributors and a project dashboard.
\n
As for refactoring, some of the things we gonna change are:
\n
\n
Better typing (we gonna add missing types, no \"any\", \"unknown\" and crap like that)
\n
Better tests (we are planning to replace Spectron with Cypress)
\n
Smaller, more focused, easy to maintain components. We are going to to use the Vue 3 Composition API here.
\n
Better folder structure for source files.
\n
Proper Dependency Injection support (for services, filters etc).
We plan to add tons of cool features in the future. The most important ones are listed below.:
\n
Features
\n
\n
Watchers: more responders, such as Email, Log to file, Log to REST API as well as app integrations like Slack, Google Chat, Viber etc.
\n
Cluster: maintenance / admin features and more detailed cluster info
\n
ETCD Dashboard: live dashboard with graphs.
\n
Complex queries using transactions.
\n
Diff tool: compare the revisions of any two keys (much like Total Commander).
\n
Report generation in different formats (HTML, PDF, XML etc)
\n
Better in-app console
\n
... and much more!
\n
\n
Future platforms
\n
\n
Android and iOS
\n
Web (browser version)
\n
\n
A better organized overview of these plans will be available soon. Stay tuned :)
\n
Installation
\n
End users..
\n
The current stable (prod) version is 1.2. It's available for Mac OS X (10.15.5 Catalina+), MS Windows (7, 8, 10+) and some major Linux distros (Ubuntu 10.04+, Arch etc). The following are pre-built binaries and this is the recommended way to install.
\n
If you are using a more or less recent major Linux distro (Ubuntu, Redhat, Suse etc), or Ubuntu LTS or some up-to-date rolling release distro like Arch, everything should work fine. Most older Linux systems should be supported as well. However, very old Linux versions might not work as expected. If you have difficulties installing the app, please report the problem using our issue tracker.
Once you have the code, simply execute the following commands:
\n
yarn install\n
\n
The next step is to compile the GRPC Node extension. This requires the usual build tools (gcc, make etc) to be installed. Make sure you have these, then run:
... where ELECTRON_VERSION is the exact version number of the Electron framework the app uses. You can determine this by running:
\n
yarn list electron\n
\n
Finally, start the dev server in the following way:
\n
yarn electron:serve\n
\n
This will start a dev build and the app should appear shortly.
\n
Usage and support
\n
First of all, in order to work properly, ETCD Manager must be configured.
\n
You need to provide only two mandatory settings: the host and the port ETCD is running at. You'll find these on the settings screen, under the ETCD tab.\nIf your ETCD host requires authentication, you will also need to provide a password / username pair or certificates / keys, which you can do under the auth tab.\nThere are several additional configuration options, but those are all optional.
\n
Detailed documentation is not available (yet), but you may want to activate quick help, which is available everywhere. Press CTRL / CMD + H to open the help pane. Here you'll find some basic info as well as all the keyboard shortcuts. This should be enough to get you started.
\n
If you still need help, please feel free to contact us. Create a issue (question / support request).
\n
Once the documentation is ready, we'll upload it to the website.
\n
Upgrading
\n
If you've installed the app using the Windows or Mac installer or the Linux AppImage, you'll be notified automatically whenever a new release is available. Simply restart the app, and it'll check for updates.
\n
Otherwise, you have to download and install the new version manually.
\n
As for the dev version, you may update that by the usual means (Yarn or Git). In any case, please read our changelog for an overview of the most recent changes.
\n
Bugs and feature requests
\n
If you find a bug, please report it using our issue tracker.
\n
This is also the place for requesting new features or asking questions. Please label your issue appropriately, use the \"bug\", \"enchantment\" and \"question\" labels, respectively.
Desktop app to clean metadata from images, videos, PDFs, and other files.
\n
\n
\n
!!!!! NOTE - UPGRADE TO 3.6.0+ ASAP !!!!!
\n
If you are running a version of ExifCleaner before 3.6.0, upgrade immediately! A security vulnerability was found in exiftool, the command-line application that powers ExifCleaner under the hood, and this was updated in ExifCleaner 3.5.0. There was also an XSS and Electron remote shell vulnerability due to unsanitized HTML output that was fixed in ExifCleaner 3.6.0.
\n
Benefits
\n
\n
Fast
\n
Drag & Drop
\n
Free and open source (MIT)
\n
Windows, Mac, and Linux
\n
Supports popular image formats such as PNG, JPG, GIF, and TIFF
\n
Supports popular video formats such as M4A, MOV, and MP4
Below is a full list of supported file types that ExifCleaner will remove metadata for. It's based on which file types ExifTool supports write operations for.
\n
\n
3G2, 3GP2 – 3rd Gen. Partnership Project 2 a/v (QuickTime-based)
\n
3GP, 3GPP – 3rd Gen. Partnership Project a/v (QuickTime-based)
ExifCleaner has the same writer limitations as the underlying exiftool it depends on. Taken from the official website:
\n
\n
ExifTool will not rewrite a file if it detects a significant problem with the file format.
\n
ExifTool has been tested with a wide range of different images, but since it is not possible to test it with every known image type, there is the possibility that it will corrupt some files. Be sure to keep backups of your files.
\n
Even though ExifTool does some validation of the information written, it is still possible to write illegal values which may cause problems when reading the images with other software. So take care to validate the information you are writing.
\n
ExifTool is not guaranteed to remove metadata completely from a file when attempting to delete all metadata. For JPEG images, all APP segments (except Adobe APP14, which is not removed by default) and trailers are removed which effectively removes all metadata, but for other formats the results are less complete:\n
\n
JPEG - APP segments (except Adobe APP14) and trailers are removed.
\n
TIFF - XMP, IPTC, ICC_Profile and the ExifIFD are removed, but some EXIF may remain in IFD0. (The CommonIFD0 Shortcut tag is provided to simplify removal of common metadata tags from IFD0.)
\n
PNG - Only XMP, EXIF, ICC_Profile and native PNG textual data chunks are removed.
\n
PDF - The original metadata is never actually removed.
\n
PS - Only XMP and some native PostScript tags may be deleted.
\n
MOV/MP4 - Most top-level metadata is removed.
\n
RAW formats - It is not recommended to remove all metadata from RAW images because this will likely remove some proprietary information that is necessary for proper rendering of the image.
\n
\n
\n
\n
Translations
\n
New translations and corrections to existing translations are welcome! See the Adding a Translation section if there is a language you would like to add. Here is the current translations status:
\n
\n
Arabic ✅ by @ZER0-X
\n
Chinese (Mandarin) ✅ by MarcusPierce
\n
Croatian ✅ by @milotype
\n
Danish ✅ by @zlatco
\n
Dutch ✅ by @rvl-code
\n
French (France) ✅ by @NathanBnm (Nathan Bonnemains)
\n
French (Quebec) ❌ needs translation if France version is not sufficient
\n
German ✅ by @tayfuuun, with updates by @philippsandhaus
\n
Italian ✅ by @blackcat-917
\n
Japanese ✅ by @AKKED
\n
Polish ✅ by @m1chu
\n
Portuguese (Brazil) ✅ by @iraamaro, with updates by @dadodollabela
\n
Portuguese (Portugal) ❌ needs translation if Brazil version is not sufficient
\n
Russian ✅ by @likhner (Arthur Likhner)
\n
Spanish (Spain) ✅ by @ff-ss (Francisco)
\n
Spanish (Latin America) ❌ needs translation if Spain version is not sufficient
\n
Slovak ✅ by @LiJu09
\n
Turkish ✅ by @bsonmez (Burak Sonmez)
\n
Ukranian ✅ by @hugonote (Alexander Berger)
\n
\n
Verifying checksum of downloads from the Github releases page
\n
Download the latest.yml (Windows), latest-mac.yml (Mac), or latest-linux.yml (Linux) file from the release page that corresponds to your operating system. Then run the following command to generate a sha checksum. ExifCleaner 3.5.0 is used here as an example.
\n
On Mac, Linux, and on Windows using the Linux Subsystem for Windows:
The output should match the sha512 value in the latest.yml file for the version you downloaded. As of now there is no checksum generated for the Linux RPM version (appears to be an electron-build issue, see Github issue here).
\n
Development
\n
Built with Electron. Uses node-exiftool as a wrapper for Exiftool binaries. To see the current list of NPM dependencies, run:
Pull down the latest ExifTool binaries (in Windows, run this within the Linux Subsystem for Windows):
\n
yarn run update-exiftool
\n
Finally, launch the application. This supports Hot Module Reload (HMR) so you will automatically see your changes every time you save a file.
\n
yarn run dev
\n
Contributing
\n
This app is mostly feature complete. I want to keep it simple and not add a bunch of bloat to it. And I want to avoid release churn. That said, there are a couple small features that might be worth adding. And there are a few minor bugs or points of cleanup that would be worth polishing. If you'd like to help check out the Issue Tracker which contains an exhaustive list of known issues. Just pick one and submit a Pull Request or leave a comment and I can provide guidance or help if you need it. Make sure to test the app out to see if it still works though. There isn't much going on in this app so it should be easy enough to do. I might add some automated tests later on to help with this. For now it's just been me working on the app so manual testing has worked out fine.
\n
TypeScript code is formatted using Prettier.
\n
Adding a Translation
\n
Adding a translation is easy. All you have to do is go to the translation list, click on \"Edit this file\", and add an entry for the new language underneath the other ones. So for example if you wanted to add a Spanish translation, where it says:
and repeat that pattern for each of the entries. That's probably the easiest way to contribute. If you want to be able to see all of your translations working in a live app before submitting, you can also do this:
\n\n
Fork the project on Github
\n
Follow the directions here to get ExifCleaner running in development mode on your computer
\n
Then update the strings.json file as mentioned above, and quit the program and relaunch it to see your changes. When you're finished, commit your changes from the command line with for example git commit -am \"Finished adding translations\". Then run git push origin master, and go to the project URL your forked it to (for example https://github.com/myusernamehere/exifcleaner) and click the button to open a new Pull Request.
\n\n
If you want to run the app with a specific locale without changing your system preferences, use one of the following commands with the correct language code. If you don't see your language listed below, just follow the pattern and plug in your own language code from this list.
\n
yarn run dev --lang=en #English\nyarn run dev --lang=fr #French\nyarn run dev --lang=pl #Polish\nyarn run dev --lang=ja #Japanese\nyarn run dev --lang=es #Spanish\nyarn run dev --lang=de #German
\n
Let me know if you run into any issues, I can guide you through the process if you get stuck.
\n
Linux AppImage Notes
\n
To mount the AppImage and inspect it's contents:
\n
./ExifCleaner-x.y.z.AppImage --appimage-mount
\n
Where x.y.z is the release version number
\n
Smoke test checklist for new releases
\n
On all platforms:
\n
\n
Linux
\n
Windows
\n
Mac
\n
\n
Perform the following manual tests before a release:
\n
\n
Drag and drop hundreds of files
\n
File -> Open dialog
\n
Switch locale to each language and check translations
\n
Switch between light and dark mode
\n
Open \"About\" dialog
\n
\n
Publishing a new release
\n
This section is really for my own reference when publishing a new release.
\n
Bump the version with release (choose a \"pre\" release for point releases for testing):
\n
yarn run release
\n
Check the Github release page and confirm a new draft release was created. Then run the publish command:
\n
yarn run publish
\n
Once you're happy with the release and want to finalize it, remove the draft flag on the Github releases page.
\n
Contributors
\n
Thanks to all the people who submitted bug reports and fixes. I've tried to include everyone so if I've missed you it was by accident, just let me know and I'll add you.
\n
\n
@m1chu - Polish translation, fix for Mac dock bug on non-Mac platforms, help debugging Unicode filename bug
\n
@LukasThyWalls - help debugging Unicode filename bug, feature suggestions
\n
@AKKED - Japanese translation, help debugging Unicode filename bug
\n
@TomasGutierrez0 - help auditing ExifTool dependency
\n
@5a384507-18ce-417c-bb55-d4dfcc8883fe - help debugging initial Linux version
\n
@totoroot - help debugging Linux AppImage installer, usability feedback, feature suggestions
\n
@Scopuli - help debugging Linux AppImage installer
\n
@Tox86 - found broken Settings menu item bug
\n
@ff-ss (Francisco) - Spanish translation
\n
@tayfuuun - German translation
\n
@philippsandhaus - German translation fixes
\n
@airvue - Help debugging Ubuntu .deb package error
\n
@Goblin80 - Help debugging Ubuntu .deb package error
\n
@zahroc - Help diagnosing error when adding bulk directories
\n
@iraamaro - Portuguese (Brazil) translation. Fix for update_exiftool.pl when building from source on Debian and Slackware
@v4k0nd (Szabó Krisztián) - Help building instructions on verifying release checksums
\n
@papb - Help setting up Windows portable build
\n
@Bellisario - Help setting up Windows portable build
\n
@overjt (Jonathan Toledo) - Proof of concept for XSS and Electron remote shell vulnerability
\n
@bsonmez (Burak Sonmez) - Turkish translation
\n
@milotype - Croatian translation
\n
\n
",
"readmeOriginal": "
ExifCleaner
\n
\n
\n
Desktop app to clean metadata from images, videos, PDFs, and other files.
\n
\n
\n
!!!!! NOTE - UPGRADE TO 3.6.0+ ASAP !!!!!
\n
If you are running a version of ExifCleaner before 3.6.0, upgrade immediately! A security vulnerability was found in exiftool, the command-line application that powers ExifCleaner under the hood, and this was updated in ExifCleaner 3.5.0. There was also an XSS and Electron remote shell vulnerability due to unsanitized HTML output that was fixed in ExifCleaner 3.6.0.
\n
Benefits
\n
\n
Fast
\n
Drag & Drop
\n
Free and open source (MIT)
\n
Windows, Mac, and Linux
\n
Supports popular image formats such as PNG, JPG, GIF, and TIFF
\n
Supports popular video formats such as M4A, MOV, and MP4
Below is a full list of supported file types that ExifCleaner will remove metadata for. It's based on which file types ExifTool supports write operations for.
\n
\n
3G2, 3GP2 – 3rd Gen. Partnership Project 2 a/v (QuickTime-based)
\n
3GP, 3GPP – 3rd Gen. Partnership Project a/v (QuickTime-based)
ExifCleaner has the same writer limitations as the underlying exiftool it depends on. Taken from the official website:
\n
\n
ExifTool will not rewrite a file if it detects a significant problem with the file format.
\n
ExifTool has been tested with a wide range of different images, but since it is not possible to test it with every known image type, there is the possibility that it will corrupt some files. Be sure to keep backups of your files.
\n
Even though ExifTool does some validation of the information written, it is still possible to write illegal values which may cause problems when reading the images with other software. So take care to validate the information you are writing.
\n
ExifTool is not guaranteed to remove metadata completely from a file when attempting to delete all metadata. For JPEG images, all APP segments (except Adobe APP14, which is not removed by default) and trailers are removed which effectively removes all metadata, but for other formats the results are less complete:\n
\n
JPEG - APP segments (except Adobe APP14) and trailers are removed.
\n
TIFF - XMP, IPTC, ICC_Profile and the ExifIFD are removed, but some EXIF may remain in IFD0. (The CommonIFD0 Shortcut tag is provided to simplify removal of common metadata tags from IFD0.)
\n
PNG - Only XMP, EXIF, ICC_Profile and native PNG textual data chunks are removed.
\n
PDF - The original metadata is never actually removed.
\n
PS - Only XMP and some native PostScript tags may be deleted.
\n
MOV/MP4 - Most top-level metadata is removed.
\n
RAW formats - It is not recommended to remove all metadata from RAW images because this will likely remove some proprietary information that is necessary for proper rendering of the image.
\n
\n
\n
\n
Translations
\n
New translations and corrections to existing translations are welcome! See the Adding a Translation section if there is a language you would like to add. Here is the current translations status:
\n
\n
Arabic ✅ by @ZER0-X
\n
Chinese (Mandarin) ✅ by MarcusPierce
\n
Croatian ✅ by @milotype
\n
Danish ✅ by @zlatco
\n
Dutch ✅ by @rvl-code
\n
French (France) ✅ by @NathanBnm (Nathan Bonnemains)
\n
French (Quebec) ❌ needs translation if France version is not sufficient
\n
German ✅ by @tayfuuun, with updates by @philippsandhaus
\n
Italian ✅ by @blackcat-917
\n
Japanese ✅ by @AKKED
\n
Polish ✅ by @m1chu
\n
Portuguese (Brazil) ✅ by @iraamaro, with updates by @dadodollabela
\n
Portuguese (Portugal) ❌ needs translation if Brazil version is not sufficient
\n
Russian ✅ by @likhner (Arthur Likhner)
\n
Spanish (Spain) ✅ by @ff-ss (Francisco)
\n
Spanish (Latin America) ❌ needs translation if Spain version is not sufficient
\n
Slovak ✅ by @LiJu09
\n
Turkish ✅ by @bsonmez (Burak Sonmez)
\n
Ukranian ✅ by @hugonote (Alexander Berger)
\n
\n
Verifying checksum of downloads from the Github releases page
\n
Download the latest.yml (Windows), latest-mac.yml (Mac), or latest-linux.yml (Linux) file from the release page that corresponds to your operating system. Then run the following command to generate a sha checksum. ExifCleaner 3.5.0 is used here as an example.
\n
On Mac, Linux, and on Windows using the Linux Subsystem for Windows:
The output should match the sha512 value in the latest.yml file for the version you downloaded. As of now there is no checksum generated for the Linux RPM version (appears to be an electron-build issue, see Github issue here).
\n
Development
\n
Built with Electron. Uses node-exiftool as a wrapper for Exiftool binaries. To see the current list of NPM dependencies, run:
Pull down the latest ExifTool binaries (in Windows, run this within the Linux Subsystem for Windows):
\n
yarn run update-exiftool
\n
Finally, launch the application. This supports Hot Module Reload (HMR) so you will automatically see your changes every time you save a file.
\n
yarn run dev
\n
Contributing
\n
This app is mostly feature complete. I want to keep it simple and not add a bunch of bloat to it. And I want to avoid release churn. That said, there are a couple small features that might be worth adding. And there are a few minor bugs or points of cleanup that would be worth polishing. If you'd like to help check out the Issue Tracker which contains an exhaustive list of known issues. Just pick one and submit a Pull Request or leave a comment and I can provide guidance or help if you need it. Make sure to test the app out to see if it still works though. There isn't much going on in this app so it should be easy enough to do. I might add some automated tests later on to help with this. For now it's just been me working on the app so manual testing has worked out fine.
\n
TypeScript code is formatted using Prettier.
\n
Adding a Translation
\n
Adding a translation is easy. All you have to do is go to the translation list, click on \"Edit this file\", and add an entry for the new language underneath the other ones. So for example if you wanted to add a Spanish translation, where it says:
and repeat that pattern for each of the entries. That's probably the easiest way to contribute. If you want to be able to see all of your translations working in a live app before submitting, you can also do this:
\n\n
Fork the project on Github
\n
Follow the directions here to get ExifCleaner running in development mode on your computer
\n
Then update the strings.json file as mentioned above, and quit the program and relaunch it to see your changes. When you're finished, commit your changes from the command line with for example git commit -am \"Finished adding translations\". Then run git push origin master, and go to the project URL your forked it to (for example https://github.com/myusernamehere/exifcleaner) and click the button to open a new Pull Request.
\n\n
If you want to run the app with a specific locale without changing your system preferences, use one of the following commands with the correct language code. If you don't see your language listed below, just follow the pattern and plug in your own language code from this list.
\n
yarn run dev --lang=en #English\nyarn run dev --lang=fr #French\nyarn run dev --lang=pl #Polish\nyarn run dev --lang=ja #Japanese\nyarn run dev --lang=es #Spanish\nyarn run dev --lang=de #German
\n
Let me know if you run into any issues, I can guide you through the process if you get stuck.
\n
Linux AppImage Notes
\n
To mount the AppImage and inspect it's contents:
\n
./ExifCleaner-x.y.z.AppImage --appimage-mount
\n
Where x.y.z is the release version number
\n
Smoke test checklist for new releases
\n
On all platforms:
\n
\n
Linux
\n
Windows
\n
Mac
\n
\n
Perform the following manual tests before a release:
\n
\n
Drag and drop hundreds of files
\n
File -> Open dialog
\n
Switch locale to each language and check translations
\n
Switch between light and dark mode
\n
Open \"About\" dialog
\n
\n
Publishing a new release
\n
This section is really for my own reference when publishing a new release.
\n
Bump the version with release (choose a \"pre\" release for point releases for testing):
\n
yarn run release
\n
Check the Github release page and confirm a new draft release was created. Then run the publish command:
\n
yarn run publish
\n
Once you're happy with the release and want to finalize it, remove the draft flag on the Github releases page.
\n
Contributors
\n
Thanks to all the people who submitted bug reports and fixes. I've tried to include everyone so if I've missed you it was by accident, just let me know and I'll add you.
\n
\n
@m1chu - Polish translation, fix for Mac dock bug on non-Mac platforms, help debugging Unicode filename bug
\n
@LukasThyWalls - help debugging Unicode filename bug, feature suggestions
\n
@AKKED - Japanese translation, help debugging Unicode filename bug
\n
@TomasGutierrez0 - help auditing ExifTool dependency
\n
@5a384507-18ce-417c-bb55-d4dfcc8883fe - help debugging initial Linux version
\n
@totoroot - help debugging Linux AppImage installer, usability feedback, feature suggestions
\n
@Scopuli - help debugging Linux AppImage installer
\n
@Tox86 - found broken Settings menu item bug
\n
@ff-ss (Francisco) - Spanish translation
\n
@tayfuuun - German translation
\n
@philippsandhaus - German translation fixes
\n
@airvue - Help debugging Ubuntu .deb package error
\n
@Goblin80 - Help debugging Ubuntu .deb package error
\n
@zahroc - Help diagnosing error when adding bulk directories
\n
@iraamaro - Portuguese (Brazil) translation. Fix for update_exiftool.pl when building from source on Debian and Slackware
The minimum required version of windows is Windows 8.
\n
macOS
\n
Changes to the security model used in the latest versions of MacOS X 10.14 (Mojave) and 10.15 (Catalina)\nmean that the operating system will show an error message ('\"ExpressLRS Configurator.app\" is damaged and can’t be\nopened. You should move it to the Trash.') when trying to install the application. To work around this, run the\nfollowing command in a terminal after installing:
This file must be placed at /etc/udev/rules.d/99-platformio-udev.rules (preferred location) or\n/lib/udev/rules.d/99-platformio-udev.rules (required on some broken systems).
\n
Please open system Terminal and type:
\n
# Recommended\ncurl -fsSL https://raw.githubusercontent.com/platformio/platformio-core/master/scripts/99-platformio-udev.rules | sudo tee /etc/udev/rules.d/99-platformio-udev.rules\n\n# OR, manually download and copy this file to destination folder\nsudo cp 99-platformio-udev.rules /etc/udev/rules.d/99-platformio-udev.rules
\n
Restart \"udev\" management tool:
\n
sudo service udev restart\n# or\nsudo udevadm control --reload-rules\nsudo udevadm trigger
\n
Ubuntu/Debian users may need to add own \"username\" to the \"dialout\" group if they are not \"root\", doing this issuing:
\n
sudo usermod -a -G dialout $USER\nsudo usermod -a -G plugdev $USER\n
\n
Similarly, Arch users may need to add their user to the “uucp” group
\n
sudo usermod -a -G uucp $USER\nsudo usermod -a -G lock $USER
This Electron application is split into two parts: a local API server that does all the work, and a UI layer. Both of\nthese application layers communicate within each other using Graphql protocol.
\n
Heavy use of TypeScript and @graphql-codegen/cli is made throughout the repository to ensure the datatypes transmitted\nbetween the API and UI layers are consistent at compile-time and Graphql ensuring the datatypes are consistent at\nruntime.
\n
Starting Development
\n
Prerequisites
\n
\n
node >=14.0
\n
git >= 2.25
\n
python >= 3.6
\n
platformio >= 5.0
\n
\n
Start the app in the dev environment:
\n
yarn install --frozen-lockfile\nyarn start
\n
Other useful cli commands
\n
Generate TypeScript types from Graphql schema and Queries located in src/ui/gql/queries:
The use and operation of this type of device may require a license, and some countries may forbid its use. It is\nentirely up to the end user to ensure compliance with local regulations. This is experimental software / hardware and\nthere is no guarantee of stability or reliability. USE AT YOUR OWN RISK.
\n
\n
",
"readmeOriginal": "
ExpressLRS Configurator
\n
\n\n\n
\n
ExpressLRS Configurator is a cross-platform build & configuration tool for the\nExpressLRS - open source RC link for RC applications.
The minimum required version of windows is Windows 8.
\n
macOS
\n
Changes to the security model used in the latest versions of MacOS X 10.14 (Mojave) and 10.15 (Catalina)\nmean that the operating system will show an error message ('\"ExpressLRS Configurator.app\" is damaged and can’t be\nopened. You should move it to the Trash.') when trying to install the application. To work around this, run the\nfollowing command in a terminal after installing:
This file must be placed at /etc/udev/rules.d/99-platformio-udev.rules (preferred location) or\n/lib/udev/rules.d/99-platformio-udev.rules (required on some broken systems).
\n
Please open system Terminal and type:
\n
# Recommended\ncurl -fsSL https://raw.githubusercontent.com/platformio/platformio-core/master/scripts/99-platformio-udev.rules | sudo tee /etc/udev/rules.d/99-platformio-udev.rules\n\n# OR, manually download and copy this file to destination folder\nsudo cp 99-platformio-udev.rules /etc/udev/rules.d/99-platformio-udev.rules
\n
Restart \"udev\" management tool:
\n
sudo service udev restart\n# or\nsudo udevadm control --reload-rules\nsudo udevadm trigger
\n
Ubuntu/Debian users may need to add own \"username\" to the \"dialout\" group if they are not \"root\", doing this issuing:
\n
sudo usermod -a -G dialout $USER\nsudo usermod -a -G plugdev $USER\n
\n
Similarly, Arch users may need to add their user to the “uucp” group
\n
sudo usermod -a -G uucp $USER\nsudo usermod -a -G lock $USER
This Electron application is split into two parts: a local API server that does all the work, and a UI layer. Both of\nthese application layers communicate within each other using Graphql protocol.
\n
Heavy use of TypeScript and @graphql-codegen/cli is made throughout the repository to ensure the datatypes transmitted\nbetween the API and UI layers are consistent at compile-time and Graphql ensuring the datatypes are consistent at\nruntime.
\n
Starting Development
\n
Prerequisites
\n
\n
node >=14.0
\n
git >= 2.25
\n
python >= 3.6
\n
platformio >= 5.0
\n
\n
Start the app in the dev environment:
\n
yarn install --frozen-lockfile\nyarn start
\n
Other useful cli commands
\n
Generate TypeScript types from Graphql schema and Queries located in src/ui/gql/queries:
The use and operation of this type of device may require a license, and some countries may forbid its use. It is\nentirely up to the end user to ensure compliance with local regulations. This is experimental software / hardware and\nthere is no guarantee of stability or reliability. USE AT YOUR OWN RISK.
Flash OS images to SD cards & USB drives, safely and easily.
\n
\n
Etcher is a powerful OS image flasher built with web technologies to ensure\nflashing an SDCard or USB drive is a pleasant and safe experience. It protects\nyou from accidentally writing to your hard-drives, ensures every byte of data\nwas written correctly, and much more. It can also directly flash Raspberry Pi devices that support USB device boot mode.
Etcher is offered through the Arch User Repository and can be installed on both Manjaro and Arch systems. You can compile it from the source code in this repository using balena-etcher. The following example uses a common AUR helper to install the latest release:
\n
yay -S balena-etcher
\n
Uninstall
\n
yay -R balena-etcher
\n
Brew (macOS)
\n
Note: Etcher has to be updated manually to point to new versions,\nso it might not refer to the latest version immediately after an Etcher\nrelease.
\n
brew install balenaetcher
\n
Uninstall
\n
brew uninstall balenaetcher
\n
Chocolatey (Windows)
\n
This package is maintained by @majkinetor, and\nis kept up to date automatically.
\n
choco install etcher
\n
Uninstall
\n
choco uninstall etcher
\n
Support
\n
If you're having any problem, please raise an issue on GitHub, and\nthe balena.io team will be happy to help.
\n
License
\n
Etcher is free software and may be redistributed under the terms specified in\nthe license.
\n
",
- "readmeOriginal": "
Etcher
\n
\n
Flash OS images to SD cards & USB drives, safely and easily.
\n
\n
Etcher is a powerful OS image flasher built with web technologies to ensure\nflashing an SDCard or USB drive is a pleasant and safe experience. It protects\nyou from accidentally writing to your hard-drives, ensures every byte of data\nwas written correctly, and much more. It can also directly flash Raspberry Pi devices that support USB device boot mode.
Etcher is offered through the Arch User Repository and can be installed on both Manjaro and Arch systems. You can compile it from the source code in this repository using balena-etcher. The following example uses a common AUR helper to install the latest release:
\n
yay -S balena-etcher
\n
Uninstall
\n
yay -R balena-etcher
\n
Brew (macOS)
\n
Note: Etcher has to be updated manually to point to new versions,\nso it might not refer to the latest version immediately after an Etcher\nrelease.
\n
brew install balenaetcher
\n
Uninstall
\n
brew uninstall balenaetcher
\n
Chocolatey (Windows)
\n
This package is maintained by @majkinetor, and\nis kept up to date automatically.
\n
choco install etcher
\n
Uninstall
\n
choco uninstall etcher
\n
Support
\n
If you're having any problem, please raise an issue on GitHub, and\nthe balena.io team will be happy to help.
\n
License
\n
Etcher is free software and may be redistributed under the terms specified in\nthe license.
This Explorer allows to perform various statistical analyses and data mining operations in a very easy and intuitive way. As the name implies, this software aims at exploring data and getting quick insight of the order of magnitude of the observed objects. That's why it does focus on graphical representation and mouse driven operations, unlike the traditional statistical tools cluttered with numerous dialog boxes and lists with five decimal figures. You can, however, have the detailed numbers once your analysis is completed.
Download the latest version corresponding to your system (32bit or 64bit) from the release page. The application is bundled into a single exe file, thanks to BoxedApp Packer .
\n
Linux
\n
Follow the \"Build from source\" instructions below.
\n
Build from Source
\n
Should you want to go the Build & Deploy route -you'll require node.js (developed\non v6.1.0, confirmed to work on v4.7.3) and npm (comes with node.js, developed using v3.9.5, confirmed to work on v2.15.11).
\n
Download and unzip the Source files (zip or tar.gz) from the the release page, or clone the repository:
Enter the Explorer's directory with cd explorer-1.x/app (if you downloaded it from Releases) or cd explorer/app (if you cloned the repository).
\n
Install the dependencies:
\n
npm install
\n
And launch the app:
\n
npm start
\n
Data loading
\n
At launch time, the Explorer shows a window to choose the dataset to use. You can either drag and drop a file from your computer desktop, or click the clipboard button.
\n
\n
Various file formats are accepted :
\n
\n
\n\t
Source
\n\t
File extension
\n\t
Remarks
\n
\n
\n\t
Access
\n\t
mdb , accdb
\n\t
Access 2000 or higher
\n
\n
\n\t
ARFF / KEEL
\n\t
*
\n\t
No comments at the beginning of the file. \n\tThe first line must be @relation \n\t
\n
\n
\n\t
BigQuery
\n\t
*
\n\t
A config file with a content like this: \nBigQuery \nclient_secret:/full/path/to/my_private_key.json \nquery:select * from lookerdata:cdc.project_tycho_reports limit 1000 \ntimeout:60000 \n\t
\n
\n
\n\t
dBase
\n\t
dbf
\n\t
\n
\n
\t\n\t
Excel
\n\t
xlsx
\n\t
The names of the fields are expected at the top of the columns
\nmysql \nhost:192.168.0.2 \nuser:bob \npassword:secret \ndatabase:test \nquery:select * from mytable \n\t
\n
\n
\n\t
Postgres
\n\t
*
\n\t
A config file with a content like this:
\npostgres \nhost:192.168.0.2 \nuser:bob \npassword:secret \ndatabase:test \nquery:select * from mytable \n \nor: \npostgres \nconnection:bob:secret@192.168.0.2/test \nquery:select * from mytable \n\t
\n
\n
\n\t
R
\n\t
rdb
\n\t
Binary format only
\n
\n
\n\t
SAS
\n\t
sas7bdat
\t\n\t
Uncompressed format only
\n
\n
\n\t
SPLUS
\n\t
sdd
\n\t
\n
\n
\n\t
SPSS
\n\t
sav
\n\t
Uncompressed format only
\n
\n
\n\t
SQL Server
\n\t
*
\n\t
A config file with a content like this:
\n\t\tmssql \n\t\thost:192.168.0.121 \n\t\tusername:bob \n\t\tpassword:secret \n\t\tquery:select * from mytable \n\t
\n
\n
\n\t
Stata
\n\t
dta
\t\n\t
Stata 8 or higher
\n
\n
\t\n\t
Tabular file
\n\t
*
\n\t
The names of the fields are expected on the first line
\n
\n
\n\t
Bzip2 file
\n\t
bz2
\n\t
The uncompressed file must be in one of the previous formats
\n
\n
\n\t
Gzip file
\n\t
gz
\n\t
The uncompressed file must be in one of the previous formats
\n
\n
\n\t
Web file
\n\t
*
\n\t
Contains the url of the data. The remote file must be in one of the previous formats
\n
\n
\n
If you click the clipboard button, the data must be in tabular form, with the name of the fields on the first line.
\n
Main window
\n
Once the data have been successfully loaded, the main window is displayed :
\n
\n
Here are the elements of the interface :
\n\n
\n
List of the categorical fields (aka \"the pink zone\"). By default only 10 fields are displayed. To resize the list, move the mouse just below the list and drag to shrink or extend the list. To scroll the list, move the mouse to the right of the list.
\n
\n
\n
Icons of the existing analyses (graphs). To run a new analysis, just drag its icon to the workspace.
\n
\n
\n
List of the numerical fields (aka \"the blue zone\"). By default only 10 fields are displayed. To resize the list, move the mouse just below the list and drag to shrink or extend the list. To scroll the list, move the mouse to the right of the list.
\n
\n
\n
Icons of the tools
\n
\n
\n
Status bar. This area gives at any time details about the object under the mouse, or the action your are about to do.
\n
\n
\n
Dock This area is used to keep graphs that are temporarily removed from the workspace.
\n
\n
\n
Version number
\n
\n
\n
Memory usage
\n
\n
\n
Workspace. This area is where the graphs are created and arranged.
\n
\n\n
Graph
\n
To create a new graph, drag its icon to the workspace. Alternatively if you dont know which icon to look at, you can right-click or control-click on the workspace to get a menu with all the possible analyses.
\n
A graph is represented by an area with different noticeable parts :\n
\n\n
\n
Close box. Click on this box to close the graph. All the computations done will be lost.
\n
\n
\n
Option menu. Some graphs have different ways of representing the results. In that case click on this sign to bring up the menu to choose from. Alternatively, right-click or control-click within the graph.
\n
\n
\n
Title bar. This area shows the current selection (see below). Click on this area to drag the graph around.
\n
\n
\n
Slots. These are the places where you can define the parameters of the analysis. Depending on the graph, different combinations of slots are shown. On a pink slot you can drag a categorical field. On a blue slot you can drag a numerical slot. Parameters can be swapped by dragging from one slot to another one ( of the same graph, and of the same color ).
\n
\n
\n
Resize box. Click on this box and drag to resize the graph.
\n
\n\n
To change the type of a graph, drag the icon of the new type onto the graph. The new analysis will retain the parameters and selection of the previous one.
\n
Selection
\n
Every analysis can be restricted to a part of the data only. The set of observations (records) currently processed by a graph is named the selection, and is displayed in the title bar .\nInitially, the selection consists of all the observations, and the title is blank.
\n
Selection based on a categorical field
\n
\n
Use a type of graph that allows to split the dataset into the desired groups : pie chart, bar chart, treemap.
\n
Drag the slice of the group to be processed out of the graph, onto the workspace.
\n
This creates a new pie chart with a selection equal to the slice's category.
\n
Drag the icon of the wanted analysis onto this second graph. It will change its type, but will retain the selection. The type of graph can be changed as many times as wished, all the analyses will be conducted on the same selection.
\n
\n
Conversely, the selection of an existing graph can be changed by dragging a pie slice onto its\ntitle. This allows to conduct successively the same analysis on different parts of the data.
\n
Selection based on a numerical field
\n
\n
Drag a numerical field from the blue zone to the title of an existing graph. The selection will consists of all the observations with a non-null value of the field. Typically a dummy variable (with values 0 or 1) would be used for this, but not necessarily.
\n
\n
Combining selections
\n
Dragging a slice to the title of a graph which already has a selection will combine the two\nsets.
\n
If the two variables are the same, the resulting selection will be the union of the two sets. Example: a pie graph splits the data into Apples, Pears, Peaches, and Apricots. If you drag the apple slice to the title of another graph, the selection will be Apples. If you then drag the peach slice to the title of the graph, the selection will be Apples + Peaches
\n
If the two variables are not the same, the resulting selection will be the intersection of the two sets. Example : a pie graph splits the data into Apples, Pears, Peaches and Apricots. If you drag the apple slice to the title of another graph, the selection will be Apples. If you change the variable defining the pie to split the data into Organic and Non-Organic, and drag the Organic\nslice to the title of the second graph, the selection will be Apples AND Organic.
\n
Conversions
\n
When loading the data, the Explorer identifies fields containing only numbers as numeric, and all others fields as categorical. Sometimes it is desirable to change this. Several possibilities exist.
\n
\n
\n
Drag a numerical field to the pink zone. The field is converted to categorical, the values are the same but as strings of characters.
\n
\n
\n
Drag a categorical field to the blue zone. Each category gives a dummy variable of the same name, Therefore, there are as many dummies as categories of the initial field, and all the dummies are exclusive. Example : COLOR is the categorical field converted:
\n
\n
\n
Original data:
\n
\n
ID
COLOR
\n
1
Blue
\n
2
Red
\n
3
Green
\n
4
Red
\n
\n
Data after the conversion
\n
\n
ID
Blue
Red
Green
\n
1
1
0
0
\n
2
0
1
0
\n
3
0
0
1
\n
4
0
1
0
\n
\n
\n
Drag the special numerical field \"1\" to the pink zone. This \"pivots\" the data. Each numerical field becomes a category of a new PIVOT field, whose value is in a new COUNT field.\nEach original record gives as many records as the number of numerical fields. Example: HEIGHT, WIDTH and DEPTH are the numerical fields.
\n
\n
Original data :
\n
\n
ID
COLOR
HEIGHT
WIDTH
DEPTH
\n
1
Blue
142
25
11
\n
2
Red
175
12
16
\n
3
Green
109
48
14
\n
\n
Data after the pivot :
\n
\n
ID
COLOR
PIVOT
COUNT
\n
1
Blue
HEIGHT
142
\n
1
Blue
WIDTH
25
\n
1
Blue
DEPTH
11
\n
2
Red
HEIGHT
175
\n
2
Red
WIDTH
12
\n
2
Red
DEPTH
16
\n
3
Green
HEIGHT
109
\n
3
Green
WIDTH
48
\n
3
Green
DEPTH
14
\n
Units
\n
\n
All the analyses applied to categorical fields (whose icon is pink) count the observations. For example in a pie chart the slices are proportional to the number of observations of each category. Sometimes the counts have to be weighted. This is done by changing the \"unit\" of the graph, by dragging a numerical field onto the graph. The title of the graph is turned blue to indicate that the counts are weighted. The status bar also shows the values or percentages in the new unit. To remove the unit and go back to the normal counting, drag the special field \"1\" onto the graph.
\n
\n
\n
All the analyses that represents datapoints in a 2D plane ( scatter plot, PCA, discriminant analysis, ternary plot, etc) can also be modified. If a numerical field is set as unit, the datapoints are displayed as circles whose size is proportional to the unit :
\n
\n
Tools
Here are the various tools proposed by the toolbar at the bottom of the screen :
\n
\n
Sort : drag this icon onto a field, or drag a field onto this icon to sort the data in ascending order. Do the same sort again to sort in descending order. The sort is stable : to sort the data by a key consisting of field1,field2,field3, you must sort by field3 first, then field2, and finally field1.
\n
\n
\n
Clone. Drag this icon onto a graph to get a copy of it, with the same parameters. If the computation is slow, this allows to bypass the second computation.
\n
\n
\n
Add : Drag this icon to the pink or blue zone to create a new field. See below.
\n
\n
\n
Help. Drag this icon onto a graph to get some informations about the analysis, the results produced, the representation options, and the possible actions.
\n
\n
\n
Picture : Drag this icon onto a graph to get its image in png format.
\n
\n
\n
Table : Drag this icon to the pink or blue zone to get a table of the values of the dataset.\nDrag this icon onto a graph to get a table of the numerical results. They can be copied to the clipboard ( with control-C or command-C ) and pasted into another software.
\n
\n
\n
Dustbin : Drag this icon onto a field, or drag a field onto this icon to permanently remove the field ( if the field is used by some graphs, it cannot be removed ). Drag a pie slice, a bar, or a tree map slice onto this icon to permanently remove the corresponding records. The original input file is not modified.
\n
\n
Types of analysis
\n
Pie chart
\n
Bar chart
\n
Line chart
\n
Association diagram
\n
Word cloud
\n
Arc diagram
\n
Contingency table
\n
Multiple Correspondence analysis
\n
3-variable graph
\n
Treemap
\n
Chi-2 tests\n
\n
Pearson' chi-square test
\n
Yates' chi-square test
\n
G-test
\n
Fisher's exact test
\n
\n
\n
Gini impurity
\n
Entropy
\n
Repartition curve
\n
Distribution curve
\n
Scatter plot
\n
Ternary plot
\n
Andrew's curves
\n
Survey plot
\n
3D plot
\n
Correlations
\n
Autocorrelation plot
\n
Probability plot
\n
Tukey-lambda PPCC plot
\n
Lag plot
\n
General statistics
\n
Normality tests\n
\n
Shapiro-Wilk test
\n
Anderson-Darling test
\n
Lilliefors test
\n
D'Agostino test
\n
Anscombe test
\n
Omnibus test
\n
Jarque-Bera test
\n
\n
\n
Analysis of variance\n
\n
Bartlett's test
\n
F-test
\n
Levene test
\n
Brown Forsythe test
\n
Box's M test
\n
Student's T-test
\n
Welch T-test
\n
Hotelling's test
\n
Wilk's lambda
\n
Lawley-Hotelling trace
\n
Pillai trace
\n
Two-way anova
\n
\n
\n
Non-parametric tests\n
\n
Kolmogorov-Smirnov test
\n
Kruskal-Wallis test
\n
Jonckheere test
\n
Cochran Q test
\n
Durbin test
\n
Friedman test
\n
Mantel-Haenszel test
\n
Breslow-Day test
\n
Woolf test
\n
\n
\n
Principal components
\n
Canonical correlation analysis
\n
K-means
\n
K-medoids
\n
Fuzzy C-means
\n
Huen diagram
\n
Dendogram
\n
Radviz
\n
Discriminant analysis
\n
Regressions\n
\n
Linear regression
\n
Poisson regression
\n
Negative binomial regression
\n
Logistic regression
\n
Least angle regression
\n
\n
\n
Influence plot
\n
QQ plot
\n
Box plot
\n
Parallel coordinates
\n
Neural network (perceptron)
\n
In the browser
The Explorer can also be executed in any modern browser. Open app/index.html,\npaste the data from the clipboard, and click OK.
Credits
The Explorer takes advantage of some very useful npm modules :
\n
gapitoken Node.js module for Google API service account authorization
This Explorer allows to perform various statistical analyses and data mining operations in a very easy and intuitive way. As the name implies, this software aims at exploring data and getting quick insight of the order of magnitude of the observed objects. That's why it does focus on graphical representation and mouse driven operations, unlike the traditional statistical tools cluttered with numerous dialog boxes and lists with five decimal figures. You can, however, have the detailed numbers once your analysis is completed.
Download the latest version corresponding to your system (32bit or 64bit) from the release page. The application is bundled into a single exe file, thanks to BoxedApp Packer .
\n
Linux
\n
Follow the \"Build from source\" instructions below.
\n
Build from Source
\n
Should you want to go the Build & Deploy route -you'll require node.js (developed\non v6.1.0, confirmed to work on v4.7.3) and npm (comes with node.js, developed using v3.9.5, confirmed to work on v2.15.11).
\n
Download and unzip the Source files (zip or tar.gz) from the the release page, or clone the repository:
Enter the Explorer's directory with cd explorer-1.x/app (if you downloaded it from Releases) or cd explorer/app (if you cloned the repository).
\n
Install the dependencies:
\n
npm install
\n
And launch the app:
\n
npm start
\n
Data loading
\n
At launch time, the Explorer shows a window to choose the dataset to use. You can either drag and drop a file from your computer desktop, or click the clipboard button.
\n
\n
Various file formats are accepted :
\n
\n
\n\t
Source
\n\t
File extension
\n\t
Remarks
\n
\n
\n\t
Access
\n\t
mdb , accdb
\n\t
Access 2000 or higher
\n
\n
\n\t
ARFF / KEEL
\n\t
*
\n\t
No comments at the beginning of the file. \n\tThe first line must be @relation \n\t
\n
\n
\n\t
BigQuery
\n\t
*
\n\t
A config file with a content like this: \nBigQuery \nclient_secret:/full/path/to/my_private_key.json \nquery:select * from lookerdata:cdc.project_tycho_reports limit 1000 \ntimeout:60000 \n\t
\n
\n
\n\t
dBase
\n\t
dbf
\n\t
\n
\n
\t\n\t
Excel
\n\t
xlsx
\n\t
The names of the fields are expected at the top of the columns
\nmysql \nhost:192.168.0.2 \nuser:bob \npassword:secret \ndatabase:test \nquery:select * from mytable \n\t
\n
\n
\n\t
Postgres
\n\t
*
\n\t
A config file with a content like this:
\npostgres \nhost:192.168.0.2 \nuser:bob \npassword:secret \ndatabase:test \nquery:select * from mytable \n \nor: \npostgres \nconnection:bob:secret@192.168.0.2/test \nquery:select * from mytable \n\t
\n
\n
\n\t
R
\n\t
rdb
\n\t
Binary format only
\n
\n
\n\t
SAS
\n\t
sas7bdat
\t\n\t
Uncompressed format only
\n
\n
\n\t
SPLUS
\n\t
sdd
\n\t
\n
\n
\n\t
SPSS
\n\t
sav
\n\t
Uncompressed format only
\n
\n
\n\t
SQL Server
\n\t
*
\n\t
A config file with a content like this:
\n\t\tmssql \n\t\thost:192.168.0.121 \n\t\tusername:bob \n\t\tpassword:secret \n\t\tquery:select * from mytable \n\t
\n
\n
\n\t
Stata
\n\t
dta
\t\n\t
Stata 8 or higher
\n
\n
\t\n\t
Tabular file
\n\t
*
\n\t
The names of the fields are expected on the first line
\n
\n
\n\t
Bzip2 file
\n\t
bz2
\n\t
The uncompressed file must be in one of the previous formats
\n
\n
\n\t
Gzip file
\n\t
gz
\n\t
The uncompressed file must be in one of the previous formats
\n
\n
\n\t
Web file
\n\t
*
\n\t
Contains the url of the data. The remote file must be in one of the previous formats
\n
\n
\n
If you click the clipboard button, the data must be in tabular form, with the name of the fields on the first line.
\n
Main window
\n
Once the data have been successfully loaded, the main window is displayed :
\n
\n
Here are the elements of the interface :
\n\n
\n
List of the categorical fields (aka \"the pink zone\"). By default only 10 fields are displayed. To resize the list, move the mouse just below the list and drag to shrink or extend the list. To scroll the list, move the mouse to the right of the list.
\n
\n
\n
Icons of the existing analyses (graphs). To run a new analysis, just drag its icon to the workspace.
\n
\n
\n
List of the numerical fields (aka \"the blue zone\"). By default only 10 fields are displayed. To resize the list, move the mouse just below the list and drag to shrink or extend the list. To scroll the list, move the mouse to the right of the list.
\n
\n
\n
Icons of the tools
\n
\n
\n
Status bar. This area gives at any time details about the object under the mouse, or the action your are about to do.
\n
\n
\n
Dock This area is used to keep graphs that are temporarily removed from the workspace.
\n
\n
\n
Version number
\n
\n
\n
Memory usage
\n
\n
\n
Workspace. This area is where the graphs are created and arranged.
\n
\n\n
Graph
\n
To create a new graph, drag its icon to the workspace. Alternatively if you dont know which icon to look at, you can right-click or control-click on the workspace to get a menu with all the possible analyses.
\n
A graph is represented by an area with different noticeable parts :\n
\n\n
\n
Close box. Click on this box to close the graph. All the computations done will be lost.
\n
\n
\n
Option menu. Some graphs have different ways of representing the results. In that case click on this sign to bring up the menu to choose from. Alternatively, right-click or control-click within the graph.
\n
\n
\n
Title bar. This area shows the current selection (see below). Click on this area to drag the graph around.
\n
\n
\n
Slots. These are the places where you can define the parameters of the analysis. Depending on the graph, different combinations of slots are shown. On a pink slot you can drag a categorical field. On a blue slot you can drag a numerical slot. Parameters can be swapped by dragging from one slot to another one ( of the same graph, and of the same color ).
\n
\n
\n
Resize box. Click on this box and drag to resize the graph.
\n
\n\n
To change the type of a graph, drag the icon of the new type onto the graph. The new analysis will retain the parameters and selection of the previous one.
\n
Selection
\n
Every analysis can be restricted to a part of the data only. The set of observations (records) currently processed by a graph is named the selection, and is displayed in the title bar .\nInitially, the selection consists of all the observations, and the title is blank.
\n
Selection based on a categorical field
\n
\n
Use a type of graph that allows to split the dataset into the desired groups : pie chart, bar chart, treemap.
\n
Drag the slice of the group to be processed out of the graph, onto the workspace.
\n
This creates a new pie chart with a selection equal to the slice's category.
\n
Drag the icon of the wanted analysis onto this second graph. It will change its type, but will retain the selection. The type of graph can be changed as many times as wished, all the analyses will be conducted on the same selection.
\n
\n
Conversely, the selection of an existing graph can be changed by dragging a pie slice onto its\ntitle. This allows to conduct successively the same analysis on different parts of the data.
\n
Selection based on a numerical field
\n
\n
Drag a numerical field from the blue zone to the title of an existing graph. The selection will consists of all the observations with a non-null value of the field. Typically a dummy variable (with values 0 or 1) would be used for this, but not necessarily.
\n
\n
Combining selections
\n
Dragging a slice to the title of a graph which already has a selection will combine the two\nsets.
\n
If the two variables are the same, the resulting selection will be the union of the two sets. Example: a pie graph splits the data into Apples, Pears, Peaches, and Apricots. If you drag the apple slice to the title of another graph, the selection will be Apples. If you then drag the peach slice to the title of the graph, the selection will be Apples + Peaches
\n
If the two variables are not the same, the resulting selection will be the intersection of the two sets. Example : a pie graph splits the data into Apples, Pears, Peaches and Apricots. If you drag the apple slice to the title of another graph, the selection will be Apples. If you change the variable defining the pie to split the data into Organic and Non-Organic, and drag the Organic\nslice to the title of the second graph, the selection will be Apples AND Organic.
\n
Conversions
\n
When loading the data, the Explorer identifies fields containing only numbers as numeric, and all others fields as categorical. Sometimes it is desirable to change this. Several possibilities exist.
\n
\n
\n
Drag a numerical field to the pink zone. The field is converted to categorical, the values are the same but as strings of characters.
\n
\n
\n
Drag a categorical field to the blue zone. Each category gives a dummy variable of the same name, Therefore, there are as many dummies as categories of the initial field, and all the dummies are exclusive. Example : COLOR is the categorical field converted:
\n
\n
\n
Original data:
\n
\n
ID
COLOR
\n
1
Blue
\n
2
Red
\n
3
Green
\n
4
Red
\n
\n
Data after the conversion
\n
\n
ID
Blue
Red
Green
\n
1
1
0
0
\n
2
0
1
0
\n
3
0
0
1
\n
4
0
1
0
\n
\n
\n
Drag the special numerical field \"1\" to the pink zone. This \"pivots\" the data. Each numerical field becomes a category of a new PIVOT field, whose value is in a new COUNT field.\nEach original record gives as many records as the number of numerical fields. Example: HEIGHT, WIDTH and DEPTH are the numerical fields.
\n
\n
Original data :
\n
\n
ID
COLOR
HEIGHT
WIDTH
DEPTH
\n
1
Blue
142
25
11
\n
2
Red
175
12
16
\n
3
Green
109
48
14
\n
\n
Data after the pivot :
\n
\n
ID
COLOR
PIVOT
COUNT
\n
1
Blue
HEIGHT
142
\n
1
Blue
WIDTH
25
\n
1
Blue
DEPTH
11
\n
2
Red
HEIGHT
175
\n
2
Red
WIDTH
12
\n
2
Red
DEPTH
16
\n
3
Green
HEIGHT
109
\n
3
Green
WIDTH
48
\n
3
Green
DEPTH
14
\n
Units
\n
\n
All the analyses applied to categorical fields (whose icon is pink) count the observations. For example in a pie chart the slices are proportional to the number of observations of each category. Sometimes the counts have to be weighted. This is done by changing the \"unit\" of the graph, by dragging a numerical field onto the graph. The title of the graph is turned blue to indicate that the counts are weighted. The status bar also shows the values or percentages in the new unit. To remove the unit and go back to the normal counting, drag the special field \"1\" onto the graph.
\n
\n
\n
All the analyses that represents datapoints in a 2D plane ( scatter plot, PCA, discriminant analysis, ternary plot, etc) can also be modified. If a numerical field is set as unit, the datapoints are displayed as circles whose size is proportional to the unit :
\n
\n
Tools
Here are the various tools proposed by the toolbar at the bottom of the screen :
\n
\n
Sort : drag this icon onto a field, or drag a field onto this icon to sort the data in ascending order. Do the same sort again to sort in descending order. The sort is stable : to sort the data by a key consisting of field1,field2,field3, you must sort by field3 first, then field2, and finally field1.
\n
\n
\n
Clone. Drag this icon onto a graph to get a copy of it, with the same parameters. If the computation is slow, this allows to bypass the second computation.
\n
\n
\n
Add : Drag this icon to the pink or blue zone to create a new field. See below.
\n
\n
\n
Help. Drag this icon onto a graph to get some informations about the analysis, the results produced, the representation options, and the possible actions.
\n
\n
\n
Picture : Drag this icon onto a graph to get its image in png format.
\n
\n
\n
Table : Drag this icon to the pink or blue zone to get a table of the values of the dataset.\nDrag this icon onto a graph to get a table of the numerical results. They can be copied to the clipboard ( with control-C or command-C ) and pasted into another software.
\n
\n
\n
Dustbin : Drag this icon onto a field, or drag a field onto this icon to permanently remove the field ( if the field is used by some graphs, it cannot be removed ). Drag a pie slice, a bar, or a tree map slice onto this icon to permanently remove the corresponding records. The original input file is not modified.
\n
\n
Types of analysis
\n
Pie chart
\n
Bar chart
\n
Line chart
\n
Association diagram
\n
Word cloud
\n
Arc diagram
\n
Contingency table
\n
Multiple Correspondence analysis
\n
3-variable graph
\n
Treemap
\n
Chi-2 tests\n
\n
Pearson' chi-square test
\n
Yates' chi-square test
\n
G-test
\n
Fisher's exact test
\n
\n
\n
Gini impurity
\n
Entropy
\n
Repartition curve
\n
Distribution curve
\n
Scatter plot
\n
Ternary plot
\n
Andrew's curves
\n
Survey plot
\n
3D plot
\n
Correlations
\n
Autocorrelation plot
\n
Probability plot
\n
Tukey-lambda PPCC plot
\n
Lag plot
\n
General statistics
\n
Normality tests\n
\n
Shapiro-Wilk test
\n
Anderson-Darling test
\n
Lilliefors test
\n
D'Agostino test
\n
Anscombe test
\n
Omnibus test
\n
Jarque-Bera test
\n
\n
\n
Analysis of variance\n
\n
Bartlett's test
\n
F-test
\n
Levene test
\n
Brown Forsythe test
\n
Box's M test
\n
Student's T-test
\n
Welch T-test
\n
Hotelling's test
\n
Wilk's lambda
\n
Lawley-Hotelling trace
\n
Pillai trace
\n
Two-way anova
\n
\n
\n
Non-parametric tests\n
\n
Kolmogorov-Smirnov test
\n
Kruskal-Wallis test
\n
Jonckheere test
\n
Cochran Q test
\n
Durbin test
\n
Friedman test
\n
Mantel-Haenszel test
\n
Breslow-Day test
\n
Woolf test
\n
\n
\n
Principal components
\n
Canonical correlation analysis
\n
K-means
\n
K-medoids
\n
Fuzzy C-means
\n
Huen diagram
\n
Dendogram
\n
Radviz
\n
Discriminant analysis
\n
Regressions\n
\n
Linear regression
\n
Poisson regression
\n
Negative binomial regression
\n
Logistic regression
\n
Least angle regression
\n
\n
\n
Influence plot
\n
QQ plot
\n
Box plot
\n
Parallel coordinates
\n
Neural network (perceptron)
\n
In the browser
The Explorer can also be executed in any modern browser. Open app/index.html,\npaste the data from the clipboard, and click OK.
Credits
The Explorer takes advantage of some very useful npm modules :
\n
gapitoken Node.js module for Google API service account authorization
Extraterm is an open source project to build a terminal emulator and expand it with new features to support modern workflows and do more than just act like a glorified teletype.
\n
More background information is in the Why document.
\n
\n
Capture and reuse command output as new command input
\n
Manipulate and copy text without leaving the keyboard
⚠️ Extraterm is in development and roughly 'beta' in quality. It is generally stable, but don't be too surprised if you encounter a few bugs. Use at your own risk. ⚠️
\n
With that out of the way, the primary author does use it as their main terminal emulator on a daily basis. The basics are in place and it will run most common terminal applications such as vi, emacs and joe without problems and even more demanding applications such as midnight commander.
Extraterm is an open source project to build a terminal emulator and expand it with new features to support modern workflows and do more than just act like a glorified teletype.
\n
More background information is in the Why document.
\n
\n
Capture and reuse command output as new command input
\n
Manipulate and copy text without leaving the keyboard
⚠️ Extraterm is in development and roughly 'beta' in quality. It is generally stable, but don't be too surprised if you encounter a few bugs. Use at your own risk. ⚠️
\n
With that out of the way, the primary author does use it as their main terminal emulator on a daily basis. The basics are in place and it will run most common terminal applications such as vi, emacs and joe without problems and even more demanding applications such as midnight commander.
This Explorer allows to perform various statistical analyses and data mining operations in a very easy and intuitive way. As the name implies, this software aims at exploring data and getting quick insight of the order of magnitude of the observed objects. That's why it does focus on graphical representation and mouse driven operations, unlike the traditional statistical tools cluttered with numerous dialog boxes and lists with five decimal figures. You can, however, have the detailed numbers once your analysis is completed.
Download the latest version corresponding to your system (32bit or 64bit) from the release page. The application is bundled into a single exe file, thanks to BoxedApp Packer .
\n
Linux
\n
Follow the \"Build from source\" instructions below.
\n
Build from Source
\n
Should you want to go the Build & Deploy route -you'll require node.js (developed\non v6.1.0, confirmed to work on v4.7.3) and npm (comes with node.js, developed using v3.9.5, confirmed to work on v2.15.11).
\n
Download and unzip the Source files (zip or tar.gz) from the the release page, or clone the repository:
Enter the Explorer's directory with cd explorer-1.x/app (if you downloaded it from Releases) or cd explorer/app (if you cloned the repository).
\n
Install the dependencies:
\n
npm install
\n
And launch the app:
\n
npm start
\n
Data loading
\n
At launch time, the Explorer shows a window to choose the dataset to use. You can either drag and drop a file from your computer desktop, or click the clipboard button.
\n
\n
Various file formats are accepted :
\n
\n
\n\t
Source
\n\t
File extension
\n\t
Remarks
\n
\n
\n\t
Access
\n\t
mdb , accdb
\n\t
Access 2000 or higher
\n
\n
\n\t
ARFF / KEEL
\n\t
*
\n\t
No comments at the beginning of the file. \n\tThe first line must be @relation \n\t
\n
\n
\n\t
BigQuery
\n\t
*
\n\t
A config file with a content like this: \nBigQuery \nclient_secret:/full/path/to/my_private_key.json \nquery:select * from lookerdata:cdc.project_tycho_reports limit 1000 \ntimeout:60000 \n\t
\n
\n
\n\t
dBase
\n\t
dbf
\n\t
\n
\n
\t\n\t
Excel
\n\t
xlsx
\n\t
The names of the fields are expected at the top of the columns
\nmysql \nhost:192.168.0.2 \nuser:bob \npassword:secret \ndatabase:test \nquery:select * from mytable \n\t
\n
\n
\n\t
Postgres
\n\t
*
\n\t
A config file with a content like this:
\npostgres \nhost:192.168.0.2 \nuser:bob \npassword:secret \ndatabase:test \nquery:select * from mytable \n \nor: \npostgres \nconnection:bob:secret@192.168.0.2/test \nquery:select * from mytable \n\t
\n
\n
\n\t
R
\n\t
rdb
\n\t
Binary format only
\n
\n
\n\t
SAS
\n\t
sas7bdat
\t\n\t
Uncompressed format only
\n
\n
\n\t
SPLUS
\n\t
sdd
\n\t
\n
\n
\n\t
SPSS
\n\t
sav
\n\t
Uncompressed format only
\n
\n
\n\t
SQL Server
\n\t
*
\n\t
A config file with a content like this:
\n\t\tmssql \n\t\thost:192.168.0.121 \n\t\tusername:bob \n\t\tpassword:secret \n\t\tquery:select * from mytable \n\t
\n
\n
\n\t
Stata
\n\t
dta
\t\n\t
Stata 8 or higher
\n
\n
\t\n\t
Tabular file
\n\t
*
\n\t
The names of the fields are expected on the first line
\n
\n
\n\t
Bzip2 file
\n\t
bz2
\n\t
The uncompressed file must be in one of the previous formats
\n
\n
\n\t
Gzip file
\n\t
gz
\n\t
The uncompressed file must be in one of the previous formats
\n
\n
\n\t
Web file
\n\t
*
\n\t
Contains the url of the data. The remote file must be in one of the previous formats
\n
\n
\n
If you click the clipboard button, the data must be in tabular form, with the name of the fields on the first line.
\n
Main window
\n
Once the data have been successfully loaded, the main window is displayed :
\n
\n
Here are the elements of the interface :
\n\n
\n
List of the categorical fields (aka \"the pink zone\"). By default only 10 fields are displayed. To resize the list, move the mouse just below the list and drag to shrink or extend the list. To scroll the list, move the mouse to the right of the list.
\n
\n
\n
Icons of the existing analyses (graphs). To run a new analysis, just drag its icon to the workspace.
\n
\n
\n
List of the numerical fields (aka \"the blue zone\"). By default only 10 fields are displayed. To resize the list, move the mouse just below the list and drag to shrink or extend the list. To scroll the list, move the mouse to the right of the list.
\n
\n
\n
Icons of the tools
\n
\n
\n
Status bar. This area gives at any time details about the object under the mouse, or the action your are about to do.
\n
\n
\n
Dock This area is used to keep graphs that are temporarily removed from the workspace.
\n
\n
\n
Version number
\n
\n
\n
Memory usage
\n
\n
\n
Workspace. This area is where the graphs are created and arranged.
\n
\n\n
Graph
\n
To create a new graph, drag its icon to the workspace. Alternatively if you dont know which icon to look at, you can right-click or control-click on the workspace to get a menu with all the possible analyses.
\n
A graph is represented by an area with different noticeable parts :\n
\n\n
\n
Close box. Click on this box to close the graph. All the computations done will be lost.
\n
\n
\n
Option menu. Some graphs have different ways of representing the results. In that case click on this sign to bring up the menu to choose from. Alternatively, right-click or control-click within the graph.
\n
\n
\n
Title bar. This area shows the current selection (see below). Click on this area to drag the graph around.
\n
\n
\n
Slots. These are the places where you can define the parameters of the analysis. Depending on the graph, different combinations of slots are shown. On a pink slot you can drag a categorical field. On a blue slot you can drag a numerical slot. Parameters can be swapped by dragging from one slot to another one ( of the same graph, and of the same color ).
\n
\n
\n
Resize box. Click on this box and drag to resize the graph.
\n
\n\n
To change the type of a graph, drag the icon of the new type onto the graph. The new analysis will retain the parameters and selection of the previous one.
\n
Selection
\n
Every analysis can be restricted to a part of the data only. The set of observations (records) currently processed by a graph is named the selection, and is displayed in the title bar .\nInitially, the selection consists of all the observations, and the title is blank.
\n
Selection based on a categorical field
\n
\n
Use a type of graph that allows to split the dataset into the desired groups : pie chart, bar chart, treemap.
\n
Drag the slice of the group to be processed out of the graph, onto the workspace.
\n
This creates a new pie chart with a selection equal to the slice's category.
\n
Drag the icon of the wanted analysis onto this second graph. It will change its type, but will retain the selection. The type of graph can be changed as many times as wished, all the analyses will be conducted on the same selection.
\n
\n
Conversely, the selection of an existing graph can be changed by dragging a pie slice onto its\ntitle. This allows to conduct successively the same analysis on different parts of the data.
\n
Selection based on a numerical field
\n
\n
Drag a numerical field from the blue zone to the title of an existing graph. The selection will consists of all the observations with a non-null value of the field. Typically a dummy variable (with values 0 or 1) would be used for this, but not necessarily.
\n
\n
Combining selections
\n
Dragging a slice to the title of a graph which already has a selection will combine the two\nsets.
\n
If the two variables are the same, the resulting selection will be the union of the two sets. Example: a pie graph splits the data into Apples, Pears, Peaches, and Apricots. If you drag the apple slice to the title of another graph, the selection will be Apples. If you then drag the peach slice to the title of the graph, the selection will be Apples + Peaches
\n
If the two variables are not the same, the resulting selection will be the intersection of the two sets. Example : a pie graph splits the data into Apples, Pears, Peaches and Apricots. If you drag the apple slice to the title of another graph, the selection will be Apples. If you change the variable defining the pie to split the data into Organic and Non-Organic, and drag the Organic\nslice to the title of the second graph, the selection will be Apples AND Organic.
\n
Conversions
\n
When loading the data, the Explorer identifies fields containing only numbers as numeric, and all others fields as categorical. Sometimes it is desirable to change this. Several possibilities exist.
\n
\n
\n
Drag a numerical field to the pink zone. The field is converted to categorical, the values are the same but as strings of characters.
\n
\n
\n
Drag a categorical field to the blue zone. Each category gives a dummy variable of the same name, Therefore, there are as many dummies as categories of the initial field, and all the dummies are exclusive. Example : COLOR is the categorical field converted:
\n
\n
\n
Original data:
\n
\n
ID
COLOR
\n
1
Blue
\n
2
Red
\n
3
Green
\n
4
Red
\n
\n
Data after the conversion
\n
\n
ID
Blue
Red
Green
\n
1
1
0
0
\n
2
0
1
0
\n
3
0
0
1
\n
4
0
1
0
\n
\n
\n
Drag the special numerical field \"1\" to the pink zone. This \"pivots\" the data. Each numerical field becomes a category of a new PIVOT field, whose value is in a new COUNT field.\nEach original record gives as many records as the number of numerical fields. Example: HEIGHT, WIDTH and DEPTH are the numerical fields.
\n
\n
Original data :
\n
\n
ID
COLOR
HEIGHT
WIDTH
DEPTH
\n
1
Blue
142
25
11
\n
2
Red
175
12
16
\n
3
Green
109
48
14
\n
\n
Data after the pivot :
\n
\n
ID
COLOR
PIVOT
COUNT
\n
1
Blue
HEIGHT
142
\n
1
Blue
WIDTH
25
\n
1
Blue
DEPTH
11
\n
2
Red
HEIGHT
175
\n
2
Red
WIDTH
12
\n
2
Red
DEPTH
16
\n
3
Green
HEIGHT
109
\n
3
Green
WIDTH
48
\n
3
Green
DEPTH
14
\n
Units
\n
\n
All the analyses applied to categorical fields (whose icon is pink) count the observations. For example in a pie chart the slices are proportional to the number of observations of each category. Sometimes the counts have to be weighted. This is done by changing the \"unit\" of the graph, by dragging a numerical field onto the graph. The title of the graph is turned blue to indicate that the counts are weighted. The status bar also shows the values or percentages in the new unit. To remove the unit and go back to the normal counting, drag the special field \"1\" onto the graph.
\n
\n
\n
All the analyses that represents datapoints in a 2D plane ( scatter plot, PCA, discriminant analysis, ternary plot, etc) can also be modified. If a numerical field is set as unit, the datapoints are displayed as circles whose size is proportional to the unit :
\n
\n
Tools
Here are the various tools proposed by the toolbar at the bottom of the screen :
\n
\n
Sort : drag this icon onto a field, or drag a field onto this icon to sort the data in ascending order. Do the same sort again to sort in descending order. The sort is stable : to sort the data by a key consisting of field1,field2,field3, you must sort by field3 first, then field2, and finally field1.
\n
\n
\n
Clone. Drag this icon onto a graph to get a copy of it, with the same parameters. If the computation is slow, this allows to bypass the second computation.
\n
\n
\n
Add : Drag this icon to the pink or blue zone to create a new field. See below.
\n
\n
\n
Help. Drag this icon onto a graph to get some informations about the analysis, the results produced, the representation options, and the possible actions.
\n
\n
\n
Picture : Drag this icon onto a graph to get its image in png format.
\n
\n
\n
Table : Drag this icon to the pink or blue zone to get a table of the values of the dataset.\nDrag this icon onto a graph to get a table of the numerical results. They can be copied to the clipboard ( with control-C or command-C ) and pasted into another software.
\n
\n
\n
Dustbin : Drag this icon onto a field, or drag a field onto this icon to permanently remove the field ( if the field is used by some graphs, it cannot be removed ). Drag a pie slice, a bar, or a tree map slice onto this icon to permanently remove the corresponding records. The original input file is not modified.
\n
\n
Types of analysis
\n
Pie chart
\n
Bar chart
\n
Line chart
\n
Association diagram
\n
Word cloud
\n
Arc diagram
\n
Contingency table
\n
Multiple Correspondence analysis
\n
3-variable graph
\n
Treemap
\n
Chi-2 tests\n
\n
Pearson' chi-square test
\n
Yates' chi-square test
\n
G-test
\n
Fisher's exact test
\n
\n
\n
Gini impurity
\n
Entropy
\n
Repartition curve
\n
Distribution curve
\n
Scatter plot
\n
Ternary plot
\n
Andrew's curves
\n
Survey plot
\n
3D plot
\n
Correlations
\n
Autocorrelation plot
\n
Probability plot
\n
Tukey-lambda PPCC plot
\n
Lag plot
\n
General statistics
\n
Normality tests\n
\n
Shapiro-Wilk test
\n
Anderson-Darling test
\n
Lilliefors test
\n
D'Agostino test
\n
Anscombe test
\n
Omnibus test
\n
Jarque-Bera test
\n
\n
\n
Analysis of variance\n
\n
Bartlett's test
\n
F-test
\n
Levene test
\n
Brown Forsythe test
\n
Box's M test
\n
Student's T-test
\n
Welch T-test
\n
Hotelling's test
\n
Wilk's lambda
\n
Lawley-Hotelling trace
\n
Pillai trace
\n
Two-way anova
\n
\n
\n
Non-parametric tests\n
\n
Kolmogorov-Smirnov test
\n
Kruskal-Wallis test
\n
Jonckheere test
\n
Cochran Q test
\n
Durbin test
\n
Friedman test
\n
Mantel-Haenszel test
\n
Breslow-Day test
\n
Woolf test
\n
\n
\n
Principal components
\n
Canonical correlation analysis
\n
K-means
\n
K-medoids
\n
Fuzzy C-means
\n
Huen diagram
\n
Dendogram
\n
Radviz
\n
Discriminant analysis
\n
Regressions\n
\n
Linear regression
\n
Poisson regression
\n
Negative binomial regression
\n
Logistic regression
\n
Least angle regression
\n
\n
\n
Influence plot
\n
QQ plot
\n
Box plot
\n
Parallel coordinates
\n
Neural network (perceptron)
\n
In the browser
The Explorer can also be executed in any modern browser. Open app/index.html,\npaste the data from the clipboard, and click OK.
Credits
The Explorer takes advantage of some very useful npm modules :
\n
gapitoken Node.js module for Google API service account authorization
This Explorer allows to perform various statistical analyses and data mining operations in a very easy and intuitive way. As the name implies, this software aims at exploring data and getting quick insight of the order of magnitude of the observed objects. That's why it does focus on graphical representation and mouse driven operations, unlike the traditional statistical tools cluttered with numerous dialog boxes and lists with five decimal figures. You can, however, have the detailed numbers once your analysis is completed.
Download the latest version corresponding to your system (32bit or 64bit) from the release page. The application is bundled into a single exe file, thanks to BoxedApp Packer .
\n
Linux
\n
Follow the \"Build from source\" instructions below.
\n
Build from Source
\n
Should you want to go the Build & Deploy route -you'll require node.js (developed\non v6.1.0, confirmed to work on v4.7.3) and npm (comes with node.js, developed using v3.9.5, confirmed to work on v2.15.11).
\n
Download and unzip the Source files (zip or tar.gz) from the the release page, or clone the repository:
Enter the Explorer's directory with cd explorer-1.x/app (if you downloaded it from Releases) or cd explorer/app (if you cloned the repository).
\n
Install the dependencies:
\n
npm install
\n
And launch the app:
\n
npm start
\n
Data loading
\n
At launch time, the Explorer shows a window to choose the dataset to use. You can either drag and drop a file from your computer desktop, or click the clipboard button.
\n
\n
Various file formats are accepted :
\n
\n
\n\t
Source
\n\t
File extension
\n\t
Remarks
\n
\n
\n\t
Access
\n\t
mdb , accdb
\n\t
Access 2000 or higher
\n
\n
\n\t
ARFF / KEEL
\n\t
*
\n\t
No comments at the beginning of the file. \n\tThe first line must be @relation \n\t
\n
\n
\n\t
BigQuery
\n\t
*
\n\t
A config file with a content like this: \nBigQuery \nclient_secret:/full/path/to/my_private_key.json \nquery:select * from lookerdata:cdc.project_tycho_reports limit 1000 \ntimeout:60000 \n\t
\n
\n
\n\t
dBase
\n\t
dbf
\n\t
\n
\n
\t\n\t
Excel
\n\t
xlsx
\n\t
The names of the fields are expected at the top of the columns
\nmysql \nhost:192.168.0.2 \nuser:bob \npassword:secret \ndatabase:test \nquery:select * from mytable \n\t
\n
\n
\n\t
Postgres
\n\t
*
\n\t
A config file with a content like this:
\npostgres \nhost:192.168.0.2 \nuser:bob \npassword:secret \ndatabase:test \nquery:select * from mytable \n \nor: \npostgres \nconnection:bob:secret@192.168.0.2/test \nquery:select * from mytable \n\t
\n
\n
\n\t
R
\n\t
rdb
\n\t
Binary format only
\n
\n
\n\t
SAS
\n\t
sas7bdat
\t\n\t
Uncompressed format only
\n
\n
\n\t
SPLUS
\n\t
sdd
\n\t
\n
\n
\n\t
SPSS
\n\t
sav
\n\t
Uncompressed format only
\n
\n
\n\t
SQL Server
\n\t
*
\n\t
A config file with a content like this:
\n\t\tmssql \n\t\thost:192.168.0.121 \n\t\tusername:bob \n\t\tpassword:secret \n\t\tquery:select * from mytable \n\t
\n
\n
\n\t
Stata
\n\t
dta
\t\n\t
Stata 8 or higher
\n
\n
\t\n\t
Tabular file
\n\t
*
\n\t
The names of the fields are expected on the first line
\n
\n
\n\t
Bzip2 file
\n\t
bz2
\n\t
The uncompressed file must be in one of the previous formats
\n
\n
\n\t
Gzip file
\n\t
gz
\n\t
The uncompressed file must be in one of the previous formats
\n
\n
\n\t
Web file
\n\t
*
\n\t
Contains the url of the data. The remote file must be in one of the previous formats
\n
\n
\n
If you click the clipboard button, the data must be in tabular form, with the name of the fields on the first line.
\n
Main window
\n
Once the data have been successfully loaded, the main window is displayed :
\n
\n
Here are the elements of the interface :
\n\n
\n
List of the categorical fields (aka \"the pink zone\"). By default only 10 fields are displayed. To resize the list, move the mouse just below the list and drag to shrink or extend the list. To scroll the list, move the mouse to the right of the list.
\n
\n
\n
Icons of the existing analyses (graphs). To run a new analysis, just drag its icon to the workspace.
\n
\n
\n
List of the numerical fields (aka \"the blue zone\"). By default only 10 fields are displayed. To resize the list, move the mouse just below the list and drag to shrink or extend the list. To scroll the list, move the mouse to the right of the list.
\n
\n
\n
Icons of the tools
\n
\n
\n
Status bar. This area gives at any time details about the object under the mouse, or the action your are about to do.
\n
\n
\n
Dock This area is used to keep graphs that are temporarily removed from the workspace.
\n
\n
\n
Version number
\n
\n
\n
Memory usage
\n
\n
\n
Workspace. This area is where the graphs are created and arranged.
\n
\n\n
Graph
\n
To create a new graph, drag its icon to the workspace. Alternatively if you dont know which icon to look at, you can right-click or control-click on the workspace to get a menu with all the possible analyses.
\n
A graph is represented by an area with different noticeable parts :\n
\n\n
\n
Close box. Click on this box to close the graph. All the computations done will be lost.
\n
\n
\n
Option menu. Some graphs have different ways of representing the results. In that case click on this sign to bring up the menu to choose from. Alternatively, right-click or control-click within the graph.
\n
\n
\n
Title bar. This area shows the current selection (see below). Click on this area to drag the graph around.
\n
\n
\n
Slots. These are the places where you can define the parameters of the analysis. Depending on the graph, different combinations of slots are shown. On a pink slot you can drag a categorical field. On a blue slot you can drag a numerical slot. Parameters can be swapped by dragging from one slot to another one ( of the same graph, and of the same color ).
\n
\n
\n
Resize box. Click on this box and drag to resize the graph.
\n
\n\n
To change the type of a graph, drag the icon of the new type onto the graph. The new analysis will retain the parameters and selection of the previous one.
\n
Selection
\n
Every analysis can be restricted to a part of the data only. The set of observations (records) currently processed by a graph is named the selection, and is displayed in the title bar .\nInitially, the selection consists of all the observations, and the title is blank.
\n
Selection based on a categorical field
\n
\n
Use a type of graph that allows to split the dataset into the desired groups : pie chart, bar chart, treemap.
\n
Drag the slice of the group to be processed out of the graph, onto the workspace.
\n
This creates a new pie chart with a selection equal to the slice's category.
\n
Drag the icon of the wanted analysis onto this second graph. It will change its type, but will retain the selection. The type of graph can be changed as many times as wished, all the analyses will be conducted on the same selection.
\n
\n
Conversely, the selection of an existing graph can be changed by dragging a pie slice onto its\ntitle. This allows to conduct successively the same analysis on different parts of the data.
\n
Selection based on a numerical field
\n
\n
Drag a numerical field from the blue zone to the title of an existing graph. The selection will consists of all the observations with a non-null value of the field. Typically a dummy variable (with values 0 or 1) would be used for this, but not necessarily.
\n
\n
Combining selections
\n
Dragging a slice to the title of a graph which already has a selection will combine the two\nsets.
\n
If the two variables are the same, the resulting selection will be the union of the two sets. Example: a pie graph splits the data into Apples, Pears, Peaches, and Apricots. If you drag the apple slice to the title of another graph, the selection will be Apples. If you then drag the peach slice to the title of the graph, the selection will be Apples + Peaches
\n
If the two variables are not the same, the resulting selection will be the intersection of the two sets. Example : a pie graph splits the data into Apples, Pears, Peaches and Apricots. If you drag the apple slice to the title of another graph, the selection will be Apples. If you change the variable defining the pie to split the data into Organic and Non-Organic, and drag the Organic\nslice to the title of the second graph, the selection will be Apples AND Organic.
\n
Conversions
\n
When loading the data, the Explorer identifies fields containing only numbers as numeric, and all others fields as categorical. Sometimes it is desirable to change this. Several possibilities exist.
\n
\n
\n
Drag a numerical field to the pink zone. The field is converted to categorical, the values are the same but as strings of characters.
\n
\n
\n
Drag a categorical field to the blue zone. Each category gives a dummy variable of the same name, Therefore, there are as many dummies as categories of the initial field, and all the dummies are exclusive. Example : COLOR is the categorical field converted:
\n
\n
\n
Original data:
\n
\n
ID
COLOR
\n
1
Blue
\n
2
Red
\n
3
Green
\n
4
Red
\n
\n
Data after the conversion
\n
\n
ID
Blue
Red
Green
\n
1
1
0
0
\n
2
0
1
0
\n
3
0
0
1
\n
4
0
1
0
\n
\n
\n
Drag the special numerical field \"1\" to the pink zone. This \"pivots\" the data. Each numerical field becomes a category of a new PIVOT field, whose value is in a new COUNT field.\nEach original record gives as many records as the number of numerical fields. Example: HEIGHT, WIDTH and DEPTH are the numerical fields.
\n
\n
Original data :
\n
\n
ID
COLOR
HEIGHT
WIDTH
DEPTH
\n
1
Blue
142
25
11
\n
2
Red
175
12
16
\n
3
Green
109
48
14
\n
\n
Data after the pivot :
\n
\n
ID
COLOR
PIVOT
COUNT
\n
1
Blue
HEIGHT
142
\n
1
Blue
WIDTH
25
\n
1
Blue
DEPTH
11
\n
2
Red
HEIGHT
175
\n
2
Red
WIDTH
12
\n
2
Red
DEPTH
16
\n
3
Green
HEIGHT
109
\n
3
Green
WIDTH
48
\n
3
Green
DEPTH
14
\n
Units
\n
\n
All the analyses applied to categorical fields (whose icon is pink) count the observations. For example in a pie chart the slices are proportional to the number of observations of each category. Sometimes the counts have to be weighted. This is done by changing the \"unit\" of the graph, by dragging a numerical field onto the graph. The title of the graph is turned blue to indicate that the counts are weighted. The status bar also shows the values or percentages in the new unit. To remove the unit and go back to the normal counting, drag the special field \"1\" onto the graph.
\n
\n
\n
All the analyses that represents datapoints in a 2D plane ( scatter plot, PCA, discriminant analysis, ternary plot, etc) can also be modified. If a numerical field is set as unit, the datapoints are displayed as circles whose size is proportional to the unit :
\n
\n
Tools
Here are the various tools proposed by the toolbar at the bottom of the screen :
\n
\n
Sort : drag this icon onto a field, or drag a field onto this icon to sort the data in ascending order. Do the same sort again to sort in descending order. The sort is stable : to sort the data by a key consisting of field1,field2,field3, you must sort by field3 first, then field2, and finally field1.
\n
\n
\n
Clone. Drag this icon onto a graph to get a copy of it, with the same parameters. If the computation is slow, this allows to bypass the second computation.
\n
\n
\n
Add : Drag this icon to the pink or blue zone to create a new field. See below.
\n
\n
\n
Help. Drag this icon onto a graph to get some informations about the analysis, the results produced, the representation options, and the possible actions.
\n
\n
\n
Picture : Drag this icon onto a graph to get its image in png format.
\n
\n
\n
Table : Drag this icon to the pink or blue zone to get a table of the values of the dataset.\nDrag this icon onto a graph to get a table of the numerical results. They can be copied to the clipboard ( with control-C or command-C ) and pasted into another software.
\n
\n
\n
Dustbin : Drag this icon onto a field, or drag a field onto this icon to permanently remove the field ( if the field is used by some graphs, it cannot be removed ). Drag a pie slice, a bar, or a tree map slice onto this icon to permanently remove the corresponding records. The original input file is not modified.
\n
\n
Types of analysis
\n
Pie chart
\n
Bar chart
\n
Line chart
\n
Association diagram
\n
Word cloud
\n
Arc diagram
\n
Contingency table
\n
Multiple Correspondence analysis
\n
3-variable graph
\n
Treemap
\n
Chi-2 tests\n
\n
Pearson' chi-square test
\n
Yates' chi-square test
\n
G-test
\n
Fisher's exact test
\n
\n
\n
Gini impurity
\n
Entropy
\n
Repartition curve
\n
Distribution curve
\n
Scatter plot
\n
Ternary plot
\n
Andrew's curves
\n
Survey plot
\n
3D plot
\n
Correlations
\n
Autocorrelation plot
\n
Probability plot
\n
Tukey-lambda PPCC plot
\n
Lag plot
\n
General statistics
\n
Normality tests\n
\n
Shapiro-Wilk test
\n
Anderson-Darling test
\n
Lilliefors test
\n
D'Agostino test
\n
Anscombe test
\n
Omnibus test
\n
Jarque-Bera test
\n
\n
\n
Analysis of variance\n
\n
Bartlett's test
\n
F-test
\n
Levene test
\n
Brown Forsythe test
\n
Box's M test
\n
Student's T-test
\n
Welch T-test
\n
Hotelling's test
\n
Wilk's lambda
\n
Lawley-Hotelling trace
\n
Pillai trace
\n
Two-way anova
\n
\n
\n
Non-parametric tests\n
\n
Kolmogorov-Smirnov test
\n
Kruskal-Wallis test
\n
Jonckheere test
\n
Cochran Q test
\n
Durbin test
\n
Friedman test
\n
Mantel-Haenszel test
\n
Breslow-Day test
\n
Woolf test
\n
\n
\n
Principal components
\n
Canonical correlation analysis
\n
K-means
\n
K-medoids
\n
Fuzzy C-means
\n
Huen diagram
\n
Dendogram
\n
Radviz
\n
Discriminant analysis
\n
Regressions\n
\n
Linear regression
\n
Poisson regression
\n
Negative binomial regression
\n
Logistic regression
\n
Least angle regression
\n
\n
\n
Influence plot
\n
QQ plot
\n
Box plot
\n
Parallel coordinates
\n
Neural network (perceptron)
\n
In the browser
The Explorer can also be executed in any modern browser. Open app/index.html,\npaste the data from the clipboard, and click OK.
Credits
The Explorer takes advantage of some very useful npm modules :
\n
gapitoken Node.js module for Google API service account authorization
Fastlane - Book Uber from your menubar, fast and simple.
\n
\n
\n
Why?
\n
I wanted to build something with React and Electron so I started thinking during Christmas what I wanted to build and I realized when I sat at the computer and did not know where my cell phone was to be able to book an Uber then it hit me that an Mac App for Uber would be fun to build and Uber pretty recently released their API endpoint for requests. Success!
\n
I started of using Sketch and moked everything up in Html, Css and then React. I have noticed that the code and structure could easily be rewritten to be more easy to understand and use.
\n
Installation
\n
Run npm-install to install all dependencies and rename config-template.json to config.json and add your API-keys from (https://developer.uber.com).
\n
Start the app by running npm run start and to build the packade npm run build.
\n
TODO
\n
\n
Reduce bundle size
\n
Refactor code
\n
Remove Api-server and use client only (CORS support)
Fastlane - Book Uber from your menubar, fast and simple.
\n
\n
\n
Why?
\n
I wanted to build something with React and Electron so I started thinking during Christmas what I wanted to build and I realized when I sat at the computer and did not know where my cell phone was to be able to book an Uber then it hit me that an Mac App for Uber would be fun to build and Uber pretty recently released their API endpoint for requests. Success!
\n
I started of using Sketch and moked everything up in Html, Css and then React. I have noticed that the code and structure could easily be rewritten to be more easy to understand and use.
\n
Installation
\n
Run npm-install to install all dependencies and rename config-template.json to config.json and add your API-keys from (https://developer.uber.com).
\n
Start the app by running npm run start and to build the packade npm run build.
\n
TODO
\n
\n
Reduce bundle size
\n
Refactor code
\n
Remove Api-server and use client only (CORS support)
Flash OS images to SD cards & USB drives, safely and easily.
\n
\n
Etcher is a powerful OS image flasher built with web technologies to ensure\nflashing an SDCard or USB drive is a pleasant and safe experience. It protects\nyou from accidentally writing to your hard-drives, ensures every byte of data\nwas written correctly, and much more. It can also directly flash Raspberry Pi devices that support USB device boot mode.
Etcher is offered through the Arch User Repository and can be installed on both Manjaro and Arch systems. You can compile it from the source code in this repository using balena-etcher. The following example uses a common AUR helper to install the latest release:
\n
yay -S balena-etcher
\n
Uninstall
\n
yay -R balena-etcher
\n
Brew (macOS)
\n
Note: Etcher has to be updated manually to point to new versions,\nso it might not refer to the latest version immediately after an Etcher\nrelease.
\n
brew install balenaetcher
\n
Uninstall
\n
brew uninstall balenaetcher
\n
Chocolatey (Windows)
\n
This package is maintained by @majkinetor, and\nis kept up to date automatically.
\n
choco install etcher
\n
Uninstall
\n
choco uninstall etcher
\n
Support
\n
If you're having any problem, please raise an issue on GitHub, and\nthe balena.io team will be happy to help.
\n
License
\n
Etcher is free software and may be redistributed under the terms specified in\nthe license.
\n
",
+ "readmeOriginal": "
Etcher
\n
\n
Flash OS images to SD cards & USB drives, safely and easily.
\n
\n
Etcher is a powerful OS image flasher built with web technologies to ensure\nflashing an SDCard or USB drive is a pleasant and safe experience. It protects\nyou from accidentally writing to your hard-drives, ensures every byte of data\nwas written correctly, and much more. It can also directly flash Raspberry Pi devices that support USB device boot mode.
Etcher is offered through the Arch User Repository and can be installed on both Manjaro and Arch systems. You can compile it from the source code in this repository using balena-etcher. The following example uses a common AUR helper to install the latest release:
\n
yay -S balena-etcher
\n
Uninstall
\n
yay -R balena-etcher
\n
Brew (macOS)
\n
Note: Etcher has to be updated manually to point to new versions,\nso it might not refer to the latest version immediately after an Etcher\nrelease.
\n
brew install balenaetcher
\n
Uninstall
\n
brew uninstall balenaetcher
\n
Chocolatey (Windows)
\n
This package is maintained by @majkinetor, and\nis kept up to date automatically.
\n
choco install etcher
\n
Uninstall
\n
choco uninstall etcher
\n
Support
\n
If you're having any problem, please raise an issue on GitHub, and\nthe balena.io team will be happy to help.
\n
License
\n
Etcher is free software and may be redistributed under the terms specified in\nthe license.
I understand that using one line of code, in this case a link to the Font Awesome script, will do the trick. Yes, you can do that, but the reason why I'm including Font Awesome locally with the software is for offline usage.
\n
If the user is offline, the icons in the software won't load unless Font Awesome is included locally.
\n
Why all these requirements to just build it?
\n
The reason why the software needs all these requirements like Python and Visual Studio(Desktop Development with C++) is because of technology that was coded into the software like Glasstron for visual appeal and XTerm for the built-in terminal to use FalixCoins Miner with.
\n
Why Electron?
\n
What is it?
\n
Electron is an open-source software framework developed and maintained by GitHub. It allows for the development of desktop GUI applications using web technologie. It combines the Chromium rendering engine and the Node.js runtime. - Wikipedia
\n
Why I use it
\n
I, Korbs, am mostly comfortable and knowledgeable with web coding languages such as HTML, CSS, and JavaScript. Using Electron was the right approach for me, and I've acquired a huge amount of experience with it over the last three years. The process of doing cross-platform support was also shortened and easier for me to do.
\n
There are tons of other good reasons why to use Electron, you can read more about that here on Alibaba Cloud (Article).
\n\n
Push Notification
\n
What is it?
\n
A push notification works simiar to a native notification, where it pops up like any other notification. With push notifcations, the developer can send a notification at any time he or she wants. Since we're doing this in Electron, the app has to be opened to see the notification. I could let the app run in the background after it closes, but I refuse to, as that could have an impact on performance.
\n
How to use it?
\n
Falix Software is using a service called Pushy, which is a reliable push notification delivery system. It's also cross-platform and supports Electron application, meaning we can use Pushy API in the main file of Falix Software.
\n
Everything is already setup in the main file, I've had it setup where can you send the title, message, and url for the push notification. You just need to use it right.
\n
In the notification data, when sending a notification, it should look like this:
\n
{\n \"title\": \"Title of Notification\",\n \"message\": \"This is a message, with a brief explanation or a short description.\",\n \"url\": \"https://example.com/\"\n}\n
\n
In Pushy's API, the data is set out like this:
\n
title - ${data.title}
\n
message - ${data.message}
\n
url - ${data.url}
\n
You can see these used in the main file.
\n
A notification is clicked, a invisible window will open and will trigger the shell.openExternal('') command. The reason why we use a URL that has this command seperately, is because using shell.openExternal doesn't seem to work in the main file on the Linux platform, but has been tested to work fine on Windows 10.
\n
If a URL isn't used in the notification, you'll be fine. The invisible window will load nothing at all, making it a dummy window.
\n
If a message or title isn't used, it will default to undefined.
If you have GitHub CLI already installed, run the following command to download and automatically extract the source code from our GitHub:
\n
gh repo clone FalixNodes-Software/Desktop-App\n
\n
If you don't have Git or GitHub CLI installed, you can download it manually from our GitHub or install Git or install GitHub CLI.
\n
You can also download the source code manually and go from there.
\n
Other Modifications
\n
There are some other assets you may need to change if you're forking this repo for another host or for a simliar project. Assets for the background images, names, etc need to be changed as they may contain resources from Falix or the name \"Falix\" in general. You also need to update other stuff like the update server provider and learn how it works if you do plan to include auto updating like we did.
\n
Pushy Notifications
\n
To make sure your fork of the software doesn't recieve notifications for Falix Inc, you'll need to either remove Pushy all together or change the app ID of Pushy.
\n
If this isn't changed, your customers who'll use the software may recieve push notifications from the forked version of the software and may be confused.
The file structure is simply, you're required to have a \"latest\" file in there like latest.yml, latest-mac.yml, and a latest-linux.yml file along with a setup file for the software.
\n
If you don't plan to self host your own update server, then GitHub Releases is recommended.\nSimply change the publish area of the package.json file to this:
Make sure to restart your terminal after doing the export command.
\n
NSIS Setup
\n
\n
As shown above, there is an image shown in the left sidebar of installer. This can be changed by updating the image in /build/installerSidebar.bmp. Image size has to be 164x314 pixels.
What's a BMP file? The BMP file format, also known as bitmap image file, device independent bitmap file format and bitmap, is a raster graphics image file format used to store bitmap digital images, independently of the display device, especially on Microsoft Windows and OS/2 operating systems. In this case, we're using NSIS, which requires the use of BMP.
As shown above, there is background image shown in the DMG installer. This can be changed by updating the image in /build/background.png. Image size has to be 540x380 pixels. The only objects in the image above that isn't part of the background image is the falixnodes.app file and the Applications folder shown in the center.
\n
Building
\n
Installing Dependencies
\n
FalixNodes Software uses Electron and other required packages to run the app and uses Electron Builder to package it up nicely. Run the following commands to install them:
\n
npm install install\n
\n
Running
\n
After all required dependencies are installed, you should be able to run the software with the start command provided in package.json.
\n
To run the start command, simply run the following command:
\n
npm start\n
\n
Create a Package
\n
Wanna create an installer? You can do this with Electron Builder, there is already a build command ready which is provided in package.json.
\n
To start building the installer, run the following command:
\n
npm run build\n
\n
After installer is done building, check the /dist/ folder.
\n\n
📊 Benchmark Testing
\n
What is this?
\n
This will show data and timing of Falix Software being ran on my machines. This will show how well the computer performs running the software, as we're still improving performance in v3.
\n
Machines
\n
HP All In One 24-e014
\n
\n
CPU: Intel Core i3 7100u | 2.24GHz | 4 Cores
\n
Memory: 16GB DDR4
\n
Graphics Card: Intel HD 620 Kaby Lake GT2
\n
Storage: 120GB SSD
\n
Operating System: Fedora 34
\n
Desktop Environment: GNOME 40 Wayland
\n
Node Version: v14.17.1
\n
\n
Dell Inspiron 15-3552
\n
Note: This low end laptop appears to have no fans.
\n
\n
CPU: Intel Celeron N3060 | 1.60GHz | 2 Cores
\n
Memory: 4GB DDR3L
\n
Graphics Card: Intel HD (Unknown model)
\n
Storage: 320GB HDD
\n
Operating System: Windows 10 v1909
\n
DirectX: 12
\n
Node Version: v14.17.1
\n
\n
HP Omni-100 5050
\n
\n
CPU: AMD Althon | 1.80Ghz | 2 Cores
\n
Memory: 8GB DDR3L
\n
Graphics Card:
\n
Storage: 320GB HDD
\n
Operating System: Windows 10 v21H1
\n
DirectX: 12
\n
Node Version: v14.17.1
\n
\n
Running
\n
Running software after intended install (Not building)
\n
HP All In One 24-e014
\n
\n
Start software | 01s
\n
\n
Dell Inspiron 15-3552
\n
\n
Start software | 09s
\n
\n
HP Omni-100 5050
\n
\n
Start software | 07s
\n
\n
Building
\n
Running commands from package.json in the following order:
\n
\n
Install node packages: npm i
\n
Rebuild modules like node-pty and Glasstron: npm run rebuild
I understand that using one line of code, in this case a link to the Font Awesome script, will do the trick. Yes, you can do that, but the reason why I'm including Font Awesome locally with the software is for offline usage.
\n
If the user is offline, the icons in the software won't load unless Font Awesome is included locally.
\n
Why all these requirements to just build it?
\n
The reason why the software needs all these requirements like Python and Visual Studio(Desktop Development with C++) is because of technology that was coded into the software like Glasstron for visual appeal and XTerm for the built-in terminal to use FalixCoins Miner with.
\n
Why Electron?
\n
What is it?
\n
Electron is an open-source software framework developed and maintained by GitHub. It allows for the development of desktop GUI applications using web technologie. It combines the Chromium rendering engine and the Node.js runtime. - Wikipedia
\n
Why I use it
\n
I, Korbs, am mostly comfortable and knowledgeable with web coding languages such as HTML, CSS, and JavaScript. Using Electron was the right approach for me, and I've acquired a huge amount of experience with it over the last three years. The process of doing cross-platform support was also shortened and easier for me to do.
\n
There are tons of other good reasons why to use Electron, you can read more about that here on Alibaba Cloud (Article).
\n\n
Push Notification
\n
What is it?
\n
A push notification works simiar to a native notification, where it pops up like any other notification. With push notifcations, the developer can send a notification at any time he or she wants. Since we're doing this in Electron, the app has to be opened to see the notification. I could let the app run in the background after it closes, but I refuse to, as that could have an impact on performance.
\n
How to use it?
\n
Falix Software is using a service called Pushy, which is a reliable push notification delivery system. It's also cross-platform and supports Electron application, meaning we can use Pushy API in the main file of Falix Software.
\n
Everything is already setup in the main file, I've had it setup where can you send the title, message, and url for the push notification. You just need to use it right.
\n
In the notification data, when sending a notification, it should look like this:
\n
{\n \"title\": \"Title of Notification\",\n \"message\": \"This is a message, with a brief explanation or a short description.\",\n \"url\": \"https://example.com/\"\n}\n
\n
In Pushy's API, the data is set out like this:
\n
title - ${data.title}
\n
message - ${data.message}
\n
url - ${data.url}
\n
You can see these used in the main file.
\n
A notification is clicked, a invisible window will open and will trigger the shell.openExternal('') command. The reason why we use a URL that has this command seperately, is because using shell.openExternal doesn't seem to work in the main file on the Linux platform, but has been tested to work fine on Windows 10.
\n
If a URL isn't used in the notification, you'll be fine. The invisible window will load nothing at all, making it a dummy window.
\n
If a message or title isn't used, it will default to undefined.
If you have GitHub CLI already installed, run the following command to download and automatically extract the source code from our GitHub:
\n
gh repo clone FalixNodes-Software/Desktop-App\n
\n
If you don't have Git or GitHub CLI installed, you can download it manually from our GitHub or install Git or install GitHub CLI.
\n
You can also download the source code manually and go from there.
\n
Other Modifications
\n
There are some other assets you may need to change if you're forking this repo for another host or for a simliar project. Assets for the background images, names, etc need to be changed as they may contain resources from Falix or the name \"Falix\" in general. You also need to update other stuff like the update server provider and learn how it works if you do plan to include auto updating like we did.
\n
Pushy Notifications
\n
To make sure your fork of the software doesn't recieve notifications for Falix Inc, you'll need to either remove Pushy all together or change the app ID of Pushy.
\n
If this isn't changed, your customers who'll use the software may recieve push notifications from the forked version of the software and may be confused.
The file structure is simply, you're required to have a \"latest\" file in there like latest.yml, latest-mac.yml, and a latest-linux.yml file along with a setup file for the software.
\n
If you don't plan to self host your own update server, then GitHub Releases is recommended.\nSimply change the publish area of the package.json file to this:
Make sure to restart your terminal after doing the export command.
\n
NSIS Setup
\n
\n
As shown above, there is an image shown in the left sidebar of installer. This can be changed by updating the image in /build/installerSidebar.bmp. Image size has to be 164x314 pixels.
What's a BMP file? The BMP file format, also known as bitmap image file, device independent bitmap file format and bitmap, is a raster graphics image file format used to store bitmap digital images, independently of the display device, especially on Microsoft Windows and OS/2 operating systems. In this case, we're using NSIS, which requires the use of BMP.
As shown above, there is background image shown in the DMG installer. This can be changed by updating the image in /build/background.png. Image size has to be 540x380 pixels. The only objects in the image above that isn't part of the background image is the falixnodes.app file and the Applications folder shown in the center.
\n
Building
\n
Installing Dependencies
\n
FalixNodes Software uses Electron and other required packages to run the app and uses Electron Builder to package it up nicely. Run the following commands to install them:
\n
npm install install\n
\n
Running
\n
After all required dependencies are installed, you should be able to run the software with the start command provided in package.json.
\n
To run the start command, simply run the following command:
\n
npm start\n
\n
Create a Package
\n
Wanna create an installer? You can do this with Electron Builder, there is already a build command ready which is provided in package.json.
\n
To start building the installer, run the following command:
\n
npm run build\n
\n
After installer is done building, check the /dist/ folder.
\n\n
📊 Benchmark Testing
\n
What is this?
\n
This will show data and timing of Falix Software being ran on my machines. This will show how well the computer performs running the software, as we're still improving performance in v3.
\n
Machines
\n
HP All In One 24-e014
\n
\n
CPU: Intel Core i3 7100u | 2.24GHz | 4 Cores
\n
Memory: 16GB DDR4
\n
Graphics Card: Intel HD 620 Kaby Lake GT2
\n
Storage: 120GB SSD
\n
Operating System: Fedora 34
\n
Desktop Environment: GNOME 40 Wayland
\n
Node Version: v14.17.1
\n
\n
Dell Inspiron 15-3552
\n
Note: This low end laptop appears to have no fans.
\n
\n
CPU: Intel Celeron N3060 | 1.60GHz | 2 Cores
\n
Memory: 4GB DDR3L
\n
Graphics Card: Intel HD (Unknown model)
\n
Storage: 320GB HDD
\n
Operating System: Windows 10 v1909
\n
DirectX: 12
\n
Node Version: v14.17.1
\n
\n
HP Omni-100 5050
\n
\n
CPU: AMD Althon | 1.80Ghz | 2 Cores
\n
Memory: 8GB DDR3L
\n
Graphics Card:
\n
Storage: 320GB HDD
\n
Operating System: Windows 10 v21H1
\n
DirectX: 12
\n
Node Version: v14.17.1
\n
\n
Running
\n
Running software after intended install (Not building)
\n
HP All In One 24-e014
\n
\n
Start software | 01s
\n
\n
Dell Inspiron 15-3552
\n
\n
Start software | 09s
\n
\n
HP Omni-100 5050
\n
\n
Start software | 07s
\n
\n
Building
\n
Running commands from package.json in the following order:
\n
\n
Install node packages: npm i
\n
Rebuild modules like node-pty and Glasstron: npm run rebuild
Fastlane - Book Uber from your menubar, fast and simple.
\n
\n
\n
Why?
\n
I wanted to build something with React and Electron so I started thinking during Christmas what I wanted to build and I realized when I sat at the computer and did not know where my cell phone was to be able to book an Uber then it hit me that an Mac App for Uber would be fun to build and Uber pretty recently released their API endpoint for requests. Success!
\n
I started of using Sketch and moked everything up in Html, Css and then React. I have noticed that the code and structure could easily be rewritten to be more easy to understand and use.
\n
Installation
\n
Run npm-install to install all dependencies and rename config-template.json to config.json and add your API-keys from (https://developer.uber.com).
\n
Start the app by running npm run start and to build the packade npm run build.
\n
TODO
\n
\n
Reduce bundle size
\n
Refactor code
\n
Remove Api-server and use client only (CORS support)
Fastlane - Book Uber from your menubar, fast and simple.
\n
\n
\n
Why?
\n
I wanted to build something with React and Electron so I started thinking during Christmas what I wanted to build and I realized when I sat at the computer and did not know where my cell phone was to be able to book an Uber then it hit me that an Mac App for Uber would be fun to build and Uber pretty recently released their API endpoint for requests. Success!
\n
I started of using Sketch and moked everything up in Html, Css and then React. I have noticed that the code and structure could easily be rewritten to be more easy to understand and use.
\n
Installation
\n
Run npm-install to install all dependencies and rename config-template.json to config.json and add your API-keys from (https://developer.uber.com).
\n
Start the app by running npm run start and to build the packade npm run build.
\n
TODO
\n
\n
Reduce bundle size
\n
Refactor code
\n
Remove Api-server and use client only (CORS support)
The Final Countdown is a desktop application that uses demographic information, health metrics, and the World Population API to generate a running clock counting down to the precise moment you'll drop dead. Make every second count.
\n
The application logic is written in JavaScript and rendered with the Electron framework.
The Final Countdown is a desktop application that uses demographic information, health metrics, and the World Population API to generate a running clock counting down to the precise moment you'll drop dead. Make every second count.
\n
The application logic is written in JavaScript and rendered with the Electron framework.
New feature suggestions or UI improvements are always welcome.
\n
This project is powered by open source volunteers, so we have a limited amount of development resource to address all requests. We will certainly make best efforts to progress (particularly for those with strong community upvotes).
\n
Code Contributions
\n
Code contributions are always welcome! Just try to follow our coding style: Coding Style Wiki coming soon.
\n
If you plan to contribute, please create a Github issue (or comment on the relevant existing issue) so we can help coordinate with upcoming release plans.
\n
For a general workflow, see Github's guide to Fork a Repo.
\n
Pull requests (PRs) should generally be for discrete issues (i.e. one issue per PR please) and be clean to merge against the current master branch. It would also be helpful if you can confirm what testing has been done (specific O/S targets if applicable).
\n
A usual naming approach for feature branches is issue-###. Include the issue number in your commit message / pull request description to link the PR to the original issue.
New feature suggestions or UI improvements are always welcome.
\n
This project is powered by open source volunteers, so we have a limited amount of development resource to address all requests. We will certainly make best efforts to progress (particularly for those with strong community upvotes).
\n
Code Contributions
\n
Code contributions are always welcome! Just try to follow our coding style: Coding Style Wiki coming soon.
\n
If you plan to contribute, please create a Github issue (or comment on the relevant existing issue) so we can help coordinate with upcoming release plans.
\n
For a general workflow, see Github's guide to Fork a Repo.
\n
Pull requests (PRs) should generally be for discrete issues (i.e. one issue per PR please) and be clean to merge against the current master branch. It would also be helpful if you can confirm what testing has been done (specific O/S targets if applicable).
\n
A usual naming approach for feature branches is issue-###. Include the issue number in your commit message / pull request description to link the PR to the original issue.
Ferdi is a desktop app that helps you organize how you use your favourite apps by combining them into one application. It is based on Franz - a software already used by thousands of people - with the difference that Ferdi gives you many additional features and doesn't restrict its usage! Ferdi is compatible with your existing Franz account so you can continue right where you left off. Find out more about Ferdi and its features on getferdi.com.
\n
Features
\n
\n
Ferdi puts all your web apps into one place
\n
Native support for 100+ services
\n
Workspaces to keep your personal and work life separated
\n
Support for multiple accounts on any service
\n
Dark Mode support for all of your services
\n
Optional cloud sync to keep your services synchronized between devices
\n
Better control over when you get which notifications
\n
Cross-platform so you can view your services on all your computers
\n
Full proxy support to work in every network environment
\n
Ferdi speaks your language: Support for 20+ languages
\n
\n
...and best of all:
\n
\n
Its completely free! There are no restrictions on features, no paywalls
\n
\n
What does Ferdi look like?
\n\nToggle screenshots\n
\n\n\"Keep all your messaging services in one place.\"\n\n\"Order your services with Ferdi Workspaces.\"\n\n\"Always keep your Todos list open with Ferdi Todos.\"\n\n\"Supporting all your services.\"\n
Ferdi has three separate AUR packages you can use:
\n
\n
ferdi: Uses your system electron version to run the latest release - this version will work best on most systems.
\n
ferdi-bin: Uses the latest Fedora release and extracts it to Arch. Use this version if you are having trouble with the ferdi package.
\n
ferdi-git: Uses your system electron version to run the latest commit from the develop branch and may be unstable but may also give you features that are not yet available in other versions. Please only use ferdi-git if you accept these risks.
\n
\n
If you use an AUR Helper e.g. yay, simply install it via yay -S ferdi.
\n
What makes Ferdi different from Franz?
\n
Removes unproductive paywalls and other other interruptions
\n
\n
Removes the counter-productive fullscreen app delay inviting users to upgrade
\n
Removes pages begging you to donate after registration
Runs utility scripts pre-commit instead of pre-push (#515)
\n
\n
\n
Thanks to all our contributors who helped realize all these amazing features! 💖
\n
\n
Contributing to Ferdi's development
\n
We welcome all contributors. Please read the contributing guidelines to setup your development machine and proceed.
\n
Nightly releases
\n
Nightly releases are automatically triggered every day (details) and available in getferdi/nightlies. Maintainers still need to manually publish the draft releases as pre-releases for now.
\n
Troubleshooting recipes (self-help)
\n
One of the issues being raised by the awesome users of Ferdi is that certain service-functionalities do not work. As good example of this is either the unread count (badge) stops working for specific services or the gmail logins don't work anymore. (These are just 2 of the most common problems reported).
\n
Since we (the contributors to Ferdi) also eat our own dog food, we use Ferdi as our day-to-day communication app - and most likely have faced the same/similar issue. As a first step before filing an issue, we request you to follow these simple steps to see if the issue gets fixed. These recipes will get automatically upgraded when you upgrade to the newer versions of Ferdi, but to get new recipes between Ferdi releases, this documentation is quite useful.
\n
\n
Make sure you are on the latest version of Ferdi. As of this writing, since the nightly CI packaging process is broken, we request you to download the latest nightly from the link in Nightly releases section.
\n
Stop Ferdi
\n
Navigate to the Ferdi profile folder in your respective installation in your file explorer application.
Delete the folder of the service that is causing your issue - in the file explorer application. (Please note that if you have manually modified any files here, it will be your responsibility to merge the changes with the latest version of the recipe (or you can submit a pull request for the same).
\n
Open a browser and navigate to the recipes repository page, and copy ALL the files for your erroneous service into your local machine at the location that you deleted in the previous step
\n
Restart Ferdi (this should upgrade your recipes to the latest working version that the contributors have fixed)
\n
If this process did not fix the issue, please log a detailed bug report here
\n
Note: An automated process to perform these steps is being ideated and tracked here
\n
\n
Contributors ✨
\n
Thanks goes to these awesome people:
\n\n\n\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n\n\n\n
This project follows the all-contributors specification. Contributions of any kind welcome!
\n
Backers via OpenCollective
\n
\n
Mention to the individuals backing us via GitHub Sponsors as well.
Ferdi is a desktop app that helps you organize how you use your favourite apps by combining them into one application. It is based on Franz - a software already used by thousands of people - with the difference that Ferdi gives you many additional features and doesn't restrict its usage! Ferdi is compatible with your existing Franz account so you can continue right where you left off. Find out more about Ferdi and its features on getferdi.com.
\n
Features
\n
\n
Ferdi puts all your web apps into one place
\n
Native support for 100+ services
\n
Workspaces to keep your personal and work life separated
\n
Support for multiple accounts on any service
\n
Dark Mode support for all of your services
\n
Optional cloud sync to keep your services synchronized between devices
\n
Better control over when you get which notifications
\n
Cross-platform so you can view your services on all your computers
\n
Full proxy support to work in every network environment
\n
Ferdi speaks your language: Support for 20+ languages
\n
\n
...and best of all:
\n
\n
Its completely free! There are no restrictions on features, no paywalls
\n
\n
What does Ferdi look like?
\n\nToggle screenshots\n
\n\n\"Keep all your messaging services in one place.\"\n\n\"Order your services with Ferdi Workspaces.\"\n\n\"Always keep your Todos list open with Ferdi Todos.\"\n\n\"Supporting all your services.\"\n
Ferdi has three separate AUR packages you can use:
\n
\n
ferdi: Uses your system electron version to run the latest release - this version will work best on most systems.
\n
ferdi-bin: Uses the latest Fedora release and extracts it to Arch. Use this version if you are having trouble with the ferdi package.
\n
ferdi-git: Uses your system electron version to run the latest commit from the develop branch and may be unstable but may also give you features that are not yet available in other versions. Please only use ferdi-git if you accept these risks.
\n
\n
If you use an AUR Helper e.g. yay, simply install it via yay -S ferdi.
\n
What makes Ferdi different from Franz?
\n
Removes unproductive paywalls and other other interruptions
\n
\n
Removes the counter-productive fullscreen app delay inviting users to upgrade
\n
Removes pages begging you to donate after registration
Runs utility scripts pre-commit instead of pre-push (#515)
\n
\n
\n
Thanks to all our contributors who helped realize all these amazing features! 💖
\n
\n
Contributing to Ferdi's development
\n
We welcome all contributors. Please read the contributing guidelines to setup your development machine and proceed.
\n
Nightly releases
\n
Nightly releases are automatically triggered every day (details) and available in getferdi/nightlies. Maintainers still need to manually publish the draft releases as pre-releases for now.
\n
Troubleshooting recipes (self-help)
\n
One of the issues being raised by the awesome users of Ferdi is that certain service-functionalities do not work. As good example of this is either the unread count (badge) stops working for specific services or the gmail logins don't work anymore. (These are just 2 of the most common problems reported).
\n
Since we (the contributors to Ferdi) also eat our own dog food, we use Ferdi as our day-to-day communication app - and most likely have faced the same/similar issue. As a first step before filing an issue, we request you to follow these simple steps to see if the issue gets fixed. These recipes will get automatically upgraded when you upgrade to the newer versions of Ferdi, but to get new recipes between Ferdi releases, this documentation is quite useful.
\n
\n
Make sure you are on the latest version of Ferdi. As of this writing, since the nightly CI packaging process is broken, we request you to download the latest nightly from the link in Nightly releases section.
\n
Stop Ferdi
\n
Navigate to the Ferdi profile folder in your respective installation in your file explorer application.
Delete the folder of the service that is causing your issue - in the file explorer application. (Please note that if you have manually modified any files here, it will be your responsibility to merge the changes with the latest version of the recipe (or you can submit a pull request for the same).
\n
Open a browser and navigate to the recipes repository page, and copy ALL the files for your erroneous service into your local machine at the location that you deleted in the previous step
\n
Restart Ferdi (this should upgrade your recipes to the latest working version that the contributors have fixed)
\n
If this process did not fix the issue, please log a detailed bug report here
\n
Note: An automated process to perform these steps is being ideated and tracked here
\n
\n
Contributors ✨
\n
Thanks goes to these awesome people:
\n\n\n\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n\n\n\n
This project follows the all-contributors specification. Contributions of any kind welcome!
\n
Backers via OpenCollective
\n
\n
Mention to the individuals backing us via GitHub Sponsors as well.
The Final Countdown is a desktop application that uses demographic information, health metrics, and the World Population API to generate a running clock counting down to the precise moment you'll drop dead. Make every second count.
\n
The application logic is written in JavaScript and rendered with the Electron framework.
The Final Countdown is a desktop application that uses demographic information, health metrics, and the World Population API to generate a running clock counting down to the precise moment you'll drop dead. Make every second count.
\n
The application logic is written in JavaScript and rendered with the Electron framework.
Flawesome (An Organiser With Diary Workflow) (v0.2.3 Pre-Release)
\n
Flawesome is a cross platform modern productivity tool that will help you organise your day-today work and thoughts.\n \nAll the three application components i.e. The Notebook, The Sticky Notes and The Todolist are driven by the Calendar.
GNU General Public License v3.0 (c) 2020 Ashish Bharadwaj J\nRefer to License.md file for details\n
\n
",
+ "readmeOriginal": "
Flawesome (An Organiser With Diary Workflow) (v0.2.3 Pre-Release)
\n
Flawesome is a cross platform modern productivity tool that will help you organise your day-today work and thoughts.\n \nAll the three application components i.e. The Notebook, The Sticky Notes and The Todolist are driven by the Calendar.
For Windows 10 users, the recommended way of installation is through Microsoft Store.\nThis enables auto-update and experimental ARM64 support.\nmacOS users can also get Fluent Reader from the Mac App Store.
If you enjoy using this app, consider supporting its development by donating through GitHub Sponsors, Paypal, or Alipay.
\n
Build from source
\n
# Install dependencies\nnpm install\n\n# Compile ts & dependencies\nnpm run build\n\n# Start the application\nnpm run electron\n\n# Generate certificate for signature\nelectron-builder create-self-signed-cert\n# Package the app for Windows\nnpm run package-win\n
For Windows 10 users, the recommended way of installation is through Microsoft Store.\nThis enables auto-update and experimental ARM64 support.\nmacOS users can also get Fluent Reader from the Mac App Store.
If you enjoy using this app, consider supporting its development by donating through GitHub Sponsors, Paypal, or Alipay.
\n
Build from source
\n
# Install dependencies\nnpm install\n\n# Compile ts & dependencies\nnpm run build\n\n# Start the application\nnpm run electron\n\n# Generate certificate for signature\nelectron-builder create-self-signed-cert\n# Package the app for Windows\nnpm run package-win\n
Flawesome (An Organiser With Diary Workflow) (v0.2.3 Pre-Release)
\n
Flawesome is a cross platform modern productivity tool that will help you organise your day-today work and thoughts.\n \nAll the three application components i.e. The Notebook, The Sticky Notes and The Todolist are driven by the Calendar.
GNU General Public License v3.0 (c) 2020 Ashish Bharadwaj J\nRefer to License.md file for details\n
\n
",
- "readmeOriginal": "
Flawesome (An Organiser With Diary Workflow) (v0.2.3 Pre-Release)
\n
Flawesome is a cross platform modern productivity tool that will help you organise your day-today work and thoughts.\n \nAll the three application components i.e. The Notebook, The Sticky Notes and The Todolist are driven by the Calendar.
MacOS menu bar app that helps you focus on a single task.\nBy splitting it into smaller todos and keeping all related information about it in one place.\nThe app is designed to get out of your way. Everything can be done via a shortcut.
\n
It is built with Electron and uses React and Redux.
MacOS menu bar app that helps you focus on a single task.\nBy splitting it into smaller todos and keeping all related information about it in one place.\nThe app is designed to get out of your way. Everything can be done via a shortcut.
\n
It is built with Electron and uses React and Redux.
Foco is a cross-platform desktop app 💻 which runs in menubar.\nFoco boosts your productivity 🚀 by creating perfect productive environment.\nIt has the best sounds for getting work done 🙌.
Foco is a cross-platform desktop app 💻 which runs in menubar.\nFoco boosts your productivity 🚀 by creating perfect productive environment.\nIt has the best sounds for getting work done 🙌.
A free, extensible, cross-platform file manager for power users
\n\n
\n
Features
\n
\n
Quick, clean, dual-paned file-system navigation with a strong keyboard-led\nfocus
\n
Integrated terminal per navigation pane for those things a file explorer just\ncan't do
\n
Focus on customisability to tailor it to the user's whims
\n
Quick navigation with a Go To box
\n
\n
Future
\n
\n
Tighter integration between navigation and integrated terminals
\n
Further behaviour to be customisable
\n
Extending usefulness of the Go To and Commands boxes
\n
\n
Roadmap
\n
\n
Core application ready for beta use
\n
Out-of-the-box plugins ready for beta use
\n
Core application ready for production use
\n
Out-of-the-box plugins ready for production use
\n
\n
The core application is ready for beta use, supporting Linux and Windows OS's. Feel free to set up\nelectron-builder for MacOS and make a PR.
\n
Getting started
\n
npm install\nnpm start\n
\n
If you want, you can add user-specific settings files, e.g. freeman.keys.json\nlike so:
\n
touch {userData}/freeman.keys.json\n
\n
{userData} above refers to Electron's app.getPath(\"userData\") location, (which\ndepends on whether the application is running in a development or production\nenvironment). Example files can be found in the ./resources/ folder.
\n
Packaging
\n
If you would like to package / install the program, on Windows and Linux you can:
\n
npm run package\n
\n
Then run the appropriate built executable.
\n
Running
\n
During development, after compiling you can:
\n
npm run start\n
\n
After packaging, you can run the system-dependent executable outputted by\nelectron-builder in the ./dist/ folder.
\n
Developing
\n
An overview of the codebase can be found in the docs.\nIf you find it helpful, you can npm run docs and open the generated\ndocs/generated/index.html file. Please let me know if you find this useful.
\n
Debugging
\n
Providing the --verbose or -V command-line argument will make the application\nlog in more detail, helping trace execution when using the packaged app. Logs of\nwarnings and errors can be found at {appData}/log.log.
\n
How to contribute
\n
Contributions are welcome! Work on the core application is still under way. There are\nnumerous areas with room for improvement in usability and stability. My\npriorities for development are currently:
\n
\n
Core functionality
\n
Plugin functionality (starting with out-of-the-box ones)
\n
Appearance
\n
\n
I'll take whatever pull requests, issues, contributors and PMs I can get! Please\nhave a look at the Contributing Guidelines before\nsubmitting a PR.
\n
",
- "readmeOriginal": "
FreeMAN
\n
\n\n\n\n\n
\n
A free, extensible, cross-platform file manager for power users
\n\n
\n
Features
\n
\n
Quick, clean, dual-paned file-system navigation with a strong keyboard-led\nfocus
\n
Integrated terminal per navigation pane for those things a file explorer just\ncan't do
\n
Focus on customisability to tailor it to the user's whims
\n
Quick navigation with a Go To box
\n
\n
Future
\n
\n
Tighter integration between navigation and integrated terminals
\n
Further behaviour to be customisable
\n
Extending usefulness of the Go To and Commands boxes
\n
\n
Roadmap
\n
\n
Core application ready for beta use
\n
Out-of-the-box plugins ready for beta use
\n
Core application ready for production use
\n
Out-of-the-box plugins ready for production use
\n
\n
The core application is ready for beta use, supporting Linux and Windows OS's. Feel free to set up\nelectron-builder for MacOS and make a PR.
\n
Getting started
\n
npm install\nnpm start\n
\n
If you want, you can add user-specific settings files, e.g. freeman.keys.json\nlike so:
\n
touch {userData}/freeman.keys.json\n
\n
{userData} above refers to Electron's app.getPath(\"userData\") location, (which\ndepends on whether the application is running in a development or production\nenvironment). Example files can be found in the ./resources/ folder.
\n
Packaging
\n
If you would like to package / install the program, on Windows and Linux you can:
\n
npm run package\n
\n
Then run the appropriate built executable.
\n
Running
\n
During development, after compiling you can:
\n
npm run start\n
\n
After packaging, you can run the system-dependent executable outputted by\nelectron-builder in the ./dist/ folder.
\n
Developing
\n
An overview of the codebase can be found in the docs.\nIf you find it helpful, you can npm run docs and open the generated\ndocs/generated/index.html file. Please let me know if you find this useful.
\n
Debugging
\n
Providing the --verbose or -V command-line argument will make the application\nlog in more detail, helping trace execution when using the packaged app. Logs of\nwarnings and errors can be found at {appData}/log.log.
\n
How to contribute
\n
Contributions are welcome! Work on the core application is still under way. There are\nnumerous areas with room for improvement in usability and stability. My\npriorities for development are currently:
\n
\n
Core functionality
\n
Plugin functionality (starting with out-of-the-box ones)
\n
Appearance
\n
\n
I'll take whatever pull requests, issues, contributors and PMs I can get! Please\nhave a look at the Contributing Guidelines before\nsubmitting a PR.
For macOS, you can also install FromScratch via Homebrew: $ brew cask install fromscratch
\n
Installation
\n
# Download from git\ngit clone https://github.com/kilian/fromscratch.git\n\n# Install dependencies\ncd fromscratch && npm install\n\n# build and run\nnpm start\n\n# or run dev version\nnpm run dev
\n
Command Line Arguments
\n
Portable Mode\n--portable
\n
Lets you store all the files FromScratch generates in a specified location, such as a USB-stick or\nother portable storage device. In this mode both the configuration files as well as your text content will be stored in\na \"userdata\" directory alongside the FromScratch executable, or when given a directory as an argument, will store\nthe files there.
\n
You can also use this to store the FromScratch configuration files, and the text content, in a synced cloud storage\nfolder.
\n
# run FromScratch in portable mode, saving data in application directory.\nfromscratch --portable\n
\n
# run FromScratch in portable mode, saving data in custom directory.\nfromscratch --portable ~/fromscratch_data\n
\n
help\n-h, --help
\n
Prints help information
\n
FAQ
\n
Where is my data saved?
\n
Your data is saved in a plain text file content.txt. On Mac and Linux, this file is saved in ~/.fromscratch. On Windows\nthis file is saved in a directory called \".fromscratch\" in your userprofile directory.
\n
Can my data be saved in an alternate directory?
\n
Yes! See the portable mode section under the Command Line Arguments heading above.
Thanks to @bittersweet for helping me set up IPC to work around a particularly nasty bug, @chentsulin for the electron-react-boilerplate, and @ctrauma for the portable bits.
For macOS, you can also install FromScratch via Homebrew: $ brew cask install fromscratch
\n
Installation
\n
# Download from git\ngit clone https://github.com/kilian/fromscratch.git\n\n# Install dependencies\ncd fromscratch && npm install\n\n# build and run\nnpm start\n\n# or run dev version\nnpm run dev
\n
Command Line Arguments
\n
Portable Mode\n--portable
\n
Lets you store all the files FromScratch generates in a specified location, such as a USB-stick or\nother portable storage device. In this mode both the configuration files as well as your text content will be stored in\na \"userdata\" directory alongside the FromScratch executable, or when given a directory as an argument, will store\nthe files there.
\n
You can also use this to store the FromScratch configuration files, and the text content, in a synced cloud storage\nfolder.
\n
# run FromScratch in portable mode, saving data in application directory.\nfromscratch --portable\n
\n
# run FromScratch in portable mode, saving data in custom directory.\nfromscratch --portable ~/fromscratch_data\n
\n
help\n-h, --help
\n
Prints help information
\n
FAQ
\n
Where is my data saved?
\n
Your data is saved in a plain text file content.txt. On Mac and Linux, this file is saved in ~/.fromscratch. On Windows\nthis file is saved in a directory called \".fromscratch\" in your userprofile directory.
\n
Can my data be saved in an alternate directory?
\n
Yes! See the portable mode section under the Command Line Arguments heading above.
Thanks to @bittersweet for helping me set up IPC to work around a particularly nasty bug, @chentsulin for the electron-react-boilerplate, and @ctrauma for the portable bits.
Control playback with keyboard media keys, even when not the frontmost app.
\n
\n
\n
Navigate episodes with ↓ and ↑ (or j and k).
\n
\n
\n
Keyboard shortcuts: ␣ pauses and resumes; ← rewinds; → fast-forwards; ⌫ goes back to home; ⌘⌫ deletes the current episode or podcast; ⌘↵ saves the current episode.
\n
\n
\n
“Permalink” opens in default browser.
\n
\n
\n
“Share link” and “Share link with timestamp” copy link directly to the clipboard.
\n
\n
\n
Automatically go back to home when episode ends.
\n
\n
\n
Go to specific episode by giving its URL on the command line.
\n
\n
\n
Tweaked user experience when copying and hovering over links.
Build for macOS and package as a zip: npm run package-macos
\n
Build for all platforms and package as a zip: npm run package
\n
\n
Currently, only macOS is supported. I do not intend to officially support other platforms in the near future since I cannot consistently and reliably test on them, but am willing to add support if someone wants to collaborate in doing the legwork.
Control playback with keyboard media keys, even when not the frontmost app.
\n
\n
\n
Navigate episodes with ↓ and ↑ (or j and k).
\n
\n
\n
Keyboard shortcuts: ␣ pauses and resumes; ← rewinds; → fast-forwards; ⌫ goes back to home; ⌘⌫ deletes the current episode or podcast; ⌘↵ saves the current episode.
\n
\n
\n
“Permalink” opens in default browser.
\n
\n
\n
“Share link” and “Share link with timestamp” copy link directly to the clipboard.
\n
\n
\n
Automatically go back to home when episode ends.
\n
\n
\n
Go to specific episode by giving its URL on the command line.
\n
\n
\n
Tweaked user experience when copying and hovering over links.
Build for macOS and package as a zip: npm run package-macos
\n
Build for all platforms and package as a zip: npm run package
\n
\n
Currently, only macOS is supported. I do not intend to officially support other platforms in the near future since I cannot consistently and reliably test on them, but am willing to add support if someone wants to collaborate in doing the legwork.
Frame is a web3 interface that lets you sign data, manage accounts, run your own connections to Ethereum/IPFS and securely and transparently interact with dapps and web3 protocols.
\n
Features
\n
\n
First-class Hardware Signer Support\n
\n
Use your Ledger and Trezor accounts with any dapp!
\n
\n
\n
Extensive Software Signer Support\n
\n
Use a mnemonic phrase, keystore.json or standalone private keys to create and backup accounts!
\n
\n
\n
Permissions\n
\n
You'll always have full control of which dapps have permission to access Frame and can monitor with full transparency what requests are being made to the network.
\n
\n
\n
Create your own connections to Ethereum/IPFS\n
\n
Run your own Ethereum light client or IPFS gateway without the command line!
\n
Seamlessly swap from local to remote nodes on the fly
\n
Never be locked into using a centralized gateway again!
\n
\n
\n
Menu Bar Support\n
\n
Frame stays out of the way and sits quietly in your menu bar until it's needed
On Ubuntu: Run sudo apt-get install build-essential libudev-devbefore running the demo.
\n
Build Apps
\n
› npm run bundle # Create app bundle\n› npm run build # Build apps for current platform
\n
Connect to Frame natively
\n
Frame exposes system-wide JSON-RPC endpoints ws://127.0.0.1:1248 and http://127.0.0.1:1248 that you can connect to from any app. We recommend using eth-provider to create a connection const provider = ethProvider('frame') as eth-provider will handle any connection edge cases across browsers and environments
\n
Frame's injected provider
\n
Frame also has a browser extension for injecting a Frame-connected EIP-1193 provider into web apps as window.etheruem. This can be used to inject a connection when an app does not provide the option to connect to Frame natively.
\n
Related
\n
\n
Frame Chat - Feel free to drop in and ask questions!
Frame is a web3 interface that lets you sign data, manage accounts, run your own connections to Ethereum/IPFS and securely and transparently interact with dapps and web3 protocols.
\n
Features
\n
\n
First-class Hardware Signer Support\n
\n
Use your Ledger and Trezor accounts with any dapp!
\n
\n
\n
Extensive Software Signer Support\n
\n
Use a mnemonic phrase, keystore.json or standalone private keys to create and backup accounts!
\n
\n
\n
Permissions\n
\n
You'll always have full control of which dapps have permission to access Frame and can monitor with full transparency what requests are being made to the network.
\n
\n
\n
Create your own connections to Ethereum/IPFS\n
\n
Run your own Ethereum light client or IPFS gateway without the command line!
\n
Seamlessly swap from local to remote nodes on the fly
\n
Never be locked into using a centralized gateway again!
\n
\n
\n
Menu Bar Support\n
\n
Frame stays out of the way and sits quietly in your menu bar until it's needed
On Ubuntu: Run sudo apt-get install build-essential libudev-devbefore running the demo.
\n
Build Apps
\n
› npm run bundle # Create app bundle\n› npm run build # Build apps for current platform
\n
Connect to Frame natively
\n
Frame exposes system-wide JSON-RPC endpoints ws://127.0.0.1:1248 and http://127.0.0.1:1248 that you can connect to from any app. We recommend using eth-provider to create a connection const provider = ethProvider('frame') as eth-provider will handle any connection edge cases across browsers and environments
\n
Frame's injected provider
\n
Frame also has a browser extension for injecting a Frame-connected EIP-1193 provider into web apps as window.etheruem. This can be used to inject a connection when an app does not provide the option to connect to Frame natively.
\n
Related
\n
\n
Frame Chat - Feel free to drop in and ask questions!
yarn serve:browser:app\nyarn serve:browser:wizard\nyarn serve:main-process\n\n// After build completed.\n\nyarn start
\n
Test
\n
yarn test
\n
Contributing
\n
❤️ Thanks for your interest!
\n
If you have suggestions for how this project could be improved, or want to report a bug, open an issue! We'd love all and any contributions. If you have questions, too, we'd love to hear them.
\n
Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.
\n
License
\n
MIT Licensed
\n
",
- "readmeOriginal": "
Geek's Diary
\n
\n
Geek's Diary is markdown editor with version control system integrated. It helps programmers to write TIL(Today I Learned).
yarn serve:browser:app\nyarn serve:browser:wizard\nyarn serve:main-process\n\n// After build completed.\n\nyarn start
\n
Test
\n
yarn test
\n
Contributing
\n
❤️ Thanks for your interest!
\n
If you have suggestions for how this project could be improved, or want to report a bug, open an issue! We'd love all and any contributions. If you have questions, too, we'd love to hear them.
\n
Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.
A free, extensible, cross-platform file manager for power users
\n\n
\n
Features
\n
\n
Quick, clean, dual-paned file-system navigation with a strong keyboard-led\nfocus
\n
Integrated terminal per navigation pane for those things a file explorer just\ncan't do
\n
Focus on customisability to tailor it to the user's whims
\n
Quick navigation with a Go To box
\n
\n
Future
\n
\n
Tighter integration between navigation and integrated terminals
\n
Further behaviour to be customisable
\n
Extending usefulness of the Go To and Commands boxes
\n
\n
Roadmap
\n
\n
Core application ready for beta use
\n
Out-of-the-box plugins ready for beta use
\n
Core application ready for production use
\n
Out-of-the-box plugins ready for production use
\n
\n
The core application is ready for beta use, supporting Linux and Windows OS's. Feel free to set up\nelectron-builder for MacOS and make a PR.
\n
Getting started
\n
npm install\nnpm start\n
\n
If you want, you can add user-specific settings files, e.g. freeman.keys.json\nlike so:
\n
touch {userData}/freeman.keys.json\n
\n
{userData} above refers to Electron's app.getPath(\"userData\") location, (which\ndepends on whether the application is running in a development or production\nenvironment). Example files can be found in the ./resources/ folder.
\n
Packaging
\n
If you would like to package / install the program, on Windows and Linux you can:
\n
npm run package\n
\n
Then run the appropriate built executable.
\n
Running
\n
During development, after compiling you can:
\n
npm run start\n
\n
After packaging, you can run the system-dependent executable outputted by\nelectron-builder in the ./dist/ folder.
\n
Developing
\n
An overview of the codebase can be found in the docs.\nIf you find it helpful, you can npm run docs and open the generated\ndocs/generated/index.html file. Please let me know if you find this useful.
\n
Debugging
\n
Providing the --verbose or -V command-line argument will make the application\nlog in more detail, helping trace execution when using the packaged app. Logs of\nwarnings and errors can be found at {appData}/log.log.
\n
How to contribute
\n
Contributions are welcome! Work on the core application is still under way. There are\nnumerous areas with room for improvement in usability and stability. My\npriorities for development are currently:
\n
\n
Core functionality
\n
Plugin functionality (starting with out-of-the-box ones)
\n
Appearance
\n
\n
I'll take whatever pull requests, issues, contributors and PMs I can get! Please\nhave a look at the Contributing Guidelines before\nsubmitting a PR.
\n
",
+ "readmeOriginal": "
FreeMAN
\n
\n\n\n\n\n
\n
A free, extensible, cross-platform file manager for power users
\n\n
\n
Features
\n
\n
Quick, clean, dual-paned file-system navigation with a strong keyboard-led\nfocus
\n
Integrated terminal per navigation pane for those things a file explorer just\ncan't do
\n
Focus on customisability to tailor it to the user's whims
\n
Quick navigation with a Go To box
\n
\n
Future
\n
\n
Tighter integration between navigation and integrated terminals
\n
Further behaviour to be customisable
\n
Extending usefulness of the Go To and Commands boxes
\n
\n
Roadmap
\n
\n
Core application ready for beta use
\n
Out-of-the-box plugins ready for beta use
\n
Core application ready for production use
\n
Out-of-the-box plugins ready for production use
\n
\n
The core application is ready for beta use, supporting Linux and Windows OS's. Feel free to set up\nelectron-builder for MacOS and make a PR.
\n
Getting started
\n
npm install\nnpm start\n
\n
If you want, you can add user-specific settings files, e.g. freeman.keys.json\nlike so:
\n
touch {userData}/freeman.keys.json\n
\n
{userData} above refers to Electron's app.getPath(\"userData\") location, (which\ndepends on whether the application is running in a development or production\nenvironment). Example files can be found in the ./resources/ folder.
\n
Packaging
\n
If you would like to package / install the program, on Windows and Linux you can:
\n
npm run package\n
\n
Then run the appropriate built executable.
\n
Running
\n
During development, after compiling you can:
\n
npm run start\n
\n
After packaging, you can run the system-dependent executable outputted by\nelectron-builder in the ./dist/ folder.
\n
Developing
\n
An overview of the codebase can be found in the docs.\nIf you find it helpful, you can npm run docs and open the generated\ndocs/generated/index.html file. Please let me know if you find this useful.
\n
Debugging
\n
Providing the --verbose or -V command-line argument will make the application\nlog in more detail, helping trace execution when using the packaged app. Logs of\nwarnings and errors can be found at {appData}/log.log.
\n
How to contribute
\n
Contributions are welcome! Work on the core application is still under way. There are\nnumerous areas with room for improvement in usability and stability. My\npriorities for development are currently:
\n
\n
Core functionality
\n
Plugin functionality (starting with out-of-the-box ones)
\n
Appearance
\n
\n
I'll take whatever pull requests, issues, contributors and PMs I can get! Please\nhave a look at the Contributing Guidelines before\nsubmitting a PR.
For macOS, you can also install FromScratch via Homebrew: $ brew cask install fromscratch
\n
Installation
\n
# Download from git\ngit clone https://github.com/kilian/fromscratch.git\n\n# Install dependencies\ncd fromscratch && npm install\n\n# build and run\nnpm start\n\n# or run dev version\nnpm run dev
\n
Command Line Arguments
\n
Portable Mode\n--portable
\n
Lets you store all the files FromScratch generates in a specified location, such as a USB-stick or\nother portable storage device. In this mode both the configuration files as well as your text content will be stored in\na \"userdata\" directory alongside the FromScratch executable, or when given a directory as an argument, will store\nthe files there.
\n
You can also use this to store the FromScratch configuration files, and the text content, in a synced cloud storage\nfolder.
\n
# run FromScratch in portable mode, saving data in application directory.\nfromscratch --portable\n
\n
# run FromScratch in portable mode, saving data in custom directory.\nfromscratch --portable ~/fromscratch_data\n
\n
help\n-h, --help
\n
Prints help information
\n
FAQ
\n
Where is my data saved?
\n
Your data is saved in a plain text file content.txt. On Mac and Linux, this file is saved in ~/.fromscratch. On Windows\nthis file is saved in a directory called \".fromscratch\" in your userprofile directory.
\n
Can my data be saved in an alternate directory?
\n
Yes! See the portable mode section under the Command Line Arguments heading above.
Thanks to @bittersweet for helping me set up IPC to work around a particularly nasty bug, @chentsulin for the electron-react-boilerplate, and @ctrauma for the portable bits.
For macOS, you can also install FromScratch via Homebrew: $ brew cask install fromscratch
\n
Installation
\n
# Download from git\ngit clone https://github.com/kilian/fromscratch.git\n\n# Install dependencies\ncd fromscratch && npm install\n\n# build and run\nnpm start\n\n# or run dev version\nnpm run dev
\n
Command Line Arguments
\n
Portable Mode\n--portable
\n
Lets you store all the files FromScratch generates in a specified location, such as a USB-stick or\nother portable storage device. In this mode both the configuration files as well as your text content will be stored in\na \"userdata\" directory alongside the FromScratch executable, or when given a directory as an argument, will store\nthe files there.
\n
You can also use this to store the FromScratch configuration files, and the text content, in a synced cloud storage\nfolder.
\n
# run FromScratch in portable mode, saving data in application directory.\nfromscratch --portable\n
\n
# run FromScratch in portable mode, saving data in custom directory.\nfromscratch --portable ~/fromscratch_data\n
\n
help\n-h, --help
\n
Prints help information
\n
FAQ
\n
Where is my data saved?
\n
Your data is saved in a plain text file content.txt. On Mac and Linux, this file is saved in ~/.fromscratch. On Windows\nthis file is saved in a directory called \".fromscratch\" in your userprofile directory.
\n
Can my data be saved in an alternate directory?
\n
Yes! See the portable mode section under the Command Line Arguments heading above.
Thanks to @bittersweet for helping me set up IPC to work around a particularly nasty bug, @chentsulin for the electron-react-boilerplate, and @ctrauma for the portable bits.
Gaucho is organized through configurable tasks that belong to Suites. Each task can be easily configured by providing a name and command. Tasks can be executed independently, or the whole suite can be executed as once.
\n
Executing tasks
\n
On each suite, you will find the list of possible tasks to launch. By clicking on Run you will start that task. Clicking the same button again (now the Stop button) will stop the task.
\n
You can easily see the name, execution time and status of each task. The status (shown with the status icon) can be idle (black), running (blue), successful (green) or failed (red).
\n
Clicking in the task name the log will be displayed, allowing you to check the task output in real time.
\n
A task can also be scheduled through the context menu. This menu also allows to perform some of the actions described above.
\n
Creating and Editing tasks
\n
By clicking the Edit button (on the top right corner) you'll be able to edit the suites and tasks (edit mode).
\n
You can add new tasks to the current suite by clicking \"Add New Task\" at the bottom of the list. By clicking on a task name you'll be able to edit that task.
\n
While editing/creating a new tasks, you should add a name to the task and a command. The command can be any shell/terminal accepted command or an executable file. Optionally a path can be added as well, if no path is added, default user path will be used.
\n
The tasks can be deleted by clicking the Delete button. In this mode you can also move tasks (clicking on the drag handle), reorder suites, create suites (+ button), delete and rename suites and tasks (through the context menu)
\n
Context Menu
\n
The Context menu can be accessed by clicking on the secondary button of the mouse, depending on where is clicked (task or suite), different actions will appear. These actions will not change whether you are in edit mode or not.
\n
Main Menu
\n
Next to the edit button, is the menu button. When clicking the menu, several options will be shown, those options may change depending if the edit mode is active or not. This menu allows you to go to the settings menu, quit the application, or perform actions over the current selected suite.
\n
User and Tasks Configuration
\n
All tasks and user changes are saved automatically on real time. This includes all the tasks/suites information as well as the window size.
\n
Settings
\n
In the settings menu, you'll be able to configure how Gaucho looks (themes and some display options). You can also export and import all your suites to a file (useful to share or sync tasks between multiple Gaucho applications). Keep in mind that importing tasks will delete all currently existing tasks
\n
Development
\n
If you want to contribute to Gaucho, create a new different version of Gaucho, or compile it from source code, follow these instructions.
\n
\n
Node 10.16.0 or higher recommeded
\n
\n
Clone/download source code from the GitHub. Make sure you have node and npm already installed in your system:
\n\n
npm install to install electron and all the dependencies.
\n
npm run start-dev to run gaucho in dev mode with chrome dev tools enabled.
\n
npm run dist to build and package gaucho for your system. The artifacts are located in dist/.\n
\n
If you encounter a problem while building, please, check Common Issues
\n
\n
\n
npm run dist-all to build and package gaucho for all supported architectures and platforms, it will take a while.\n
\n
Some dependencies may need installing, depending on the system, check the troubleshooting page
Gaucho is organized through configurable tasks that belong to Suites. Each task can be easily configured by providing a name and command. Tasks can be executed independently, or the whole suite can be executed as once.
\n
Executing tasks
\n
On each suite, you will find the list of possible tasks to launch. By clicking on Run you will start that task. Clicking the same button again (now the Stop button) will stop the task.
\n
You can easily see the name, execution time and status of each task. The status (shown with the status icon) can be idle (black), running (blue), successful (green) or failed (red).
\n
Clicking in the task name the log will be displayed, allowing you to check the task output in real time.
\n
A task can also be scheduled through the context menu. This menu also allows to perform some of the actions described above.
\n
Creating and Editing tasks
\n
By clicking the Edit button (on the top right corner) you'll be able to edit the suites and tasks (edit mode).
\n
You can add new tasks to the current suite by clicking \"Add New Task\" at the bottom of the list. By clicking on a task name you'll be able to edit that task.
\n
While editing/creating a new tasks, you should add a name to the task and a command. The command can be any shell/terminal accepted command or an executable file. Optionally a path can be added as well, if no path is added, default user path will be used.
\n
The tasks can be deleted by clicking the Delete button. In this mode you can also move tasks (clicking on the drag handle), reorder suites, create suites (+ button), delete and rename suites and tasks (through the context menu)
\n
Context Menu
\n
The Context menu can be accessed by clicking on the secondary button of the mouse, depending on where is clicked (task or suite), different actions will appear. These actions will not change whether you are in edit mode or not.
\n
Main Menu
\n
Next to the edit button, is the menu button. When clicking the menu, several options will be shown, those options may change depending if the edit mode is active or not. This menu allows you to go to the settings menu, quit the application, or perform actions over the current selected suite.
\n
User and Tasks Configuration
\n
All tasks and user changes are saved automatically on real time. This includes all the tasks/suites information as well as the window size.
\n
Settings
\n
In the settings menu, you'll be able to configure how Gaucho looks (themes and some display options). You can also export and import all your suites to a file (useful to share or sync tasks between multiple Gaucho applications). Keep in mind that importing tasks will delete all currently existing tasks
\n
Development
\n
If you want to contribute to Gaucho, create a new different version of Gaucho, or compile it from source code, follow these instructions.
\n
\n
Node 10.16.0 or higher recommeded
\n
\n
Clone/download source code from the GitHub. Make sure you have node and npm already installed in your system:
\n\n
npm install to install electron and all the dependencies.
\n
npm run start-dev to run gaucho in dev mode with chrome dev tools enabled.
\n
npm run dist to build and package gaucho for your system. The artifacts are located in dist/.\n
\n
If you encounter a problem while building, please, check Common Issues
\n
\n
\n
npm run dist-all to build and package gaucho for all supported architectures and platforms, it will take a while.\n
\n
Some dependencies may need installing, depending on the system, check the troubleshooting page
GDevelop is a full-featured, open-source game development software, allowing to create desktop and mobile games without any knowledge in a specific programming language. All the game logic is built up using an intuitive and powerful event-based system.
The Core library, the native and HTML5 game engines, the IDE, and all extensions (respectively Core, GDCpp, GDJS, newIDE and Extensions folders) are under the MIT license.
\n
The name, GDevelop, and its logo are the exclusive property of Florian Rival.
\n
\n
Games exported with GDevelop are based on the native and/or HTML5 game engines (see Core, GDCpp and GDJS folders): these engines are distributed under the MIT license so that you can distribute, sell or do anything with the games you created with GDevelop. In particular, you are not forced to make your game open source.
\n
",
"readmeOriginal": "
\n
GDevelop is a full-featured, open-source game development software, allowing to create desktop and mobile games without any knowledge in a specific programming language. All the game logic is built up using an intuitive and powerful event-based system.
The Core library, the native and HTML5 game engines, the IDE, and all extensions (respectively Core, GDCpp, GDJS, newIDE and Extensions folders) are under the MIT license.
\n
The name, GDevelop, and its logo are the exclusive property of Florian Rival.
\n
\n
Games exported with GDevelop are based on the native and/or HTML5 game engines (see Core, GDCpp and GDJS folders): these engines are distributed under the MIT license so that you can distribute, sell or do anything with the games you created with GDevelop. In particular, you are not forced to make your game open source.
Geniemoji is an app that makes using emojis on desktop simpler than ever \nIt works on operating systems including Windows, MacOS, and Linux! \nIt is an open source, desktop app built using Electron \nIts purpose is to serve you with the most relevant emojis based on your command!
\n
How does it work?
\n
\n
Geniemoji lives in your Menu Bar once the app is launched
\n
The app doesn't show up in the dock or anywhere else
\n
You can summon Geniemoji using either the shortcut keys: Control + e or by pressing its icon in the menu bar
\n
The shortcut keys are the same across all operating systems
\n
\n
This is Geniemoji 🧞♂️
\n
\n
\n
Geniemoji lives in your menu bar 👆
\n
\n
\n
\n
Geniemoji start page 👆
\n
\n
\n
\n
Geniemoji emoji search 👆
\n
\n
\n
\n
Geniemoji emoji search 👆
\n
\n
Using the app
\n
\n
Go to the releases tab and download the latest version for your operating system\nOR
\n
clone the repo or download it as a zip
\n
Run npm install followed by npm start to run Geniemoji
Geniemoji is an app that makes using emojis on desktop simpler than ever \nIt works on operating systems including Windows, MacOS, and Linux! \nIt is an open source, desktop app built using Electron \nIts purpose is to serve you with the most relevant emojis based on your command!
\n
How does it work?
\n
\n
Geniemoji lives in your Menu Bar once the app is launched
\n
The app doesn't show up in the dock or anywhere else
\n
You can summon Geniemoji using either the shortcut keys: Control + e or by pressing its icon in the menu bar
\n
The shortcut keys are the same across all operating systems
\n
\n
This is Geniemoji 🧞♂️
\n
\n
\n
Geniemoji lives in your menu bar 👆
\n
\n
\n
\n
Geniemoji start page 👆
\n
\n
\n
\n
Geniemoji emoji search 👆
\n
\n
\n
\n
Geniemoji emoji search 👆
\n
\n
Using the app
\n
\n
Go to the releases tab and download the latest version for your operating system\nOR
\n
clone the repo or download it as a zip
\n
Run npm install followed by npm start to run Geniemoji
yarn serve:browser:app\nyarn serve:browser:wizard\nyarn serve:main-process\n\n// After build completed.\n\nyarn start
\n
Test
\n
yarn test
\n
Contributing
\n
❤️ Thanks for your interest!
\n
If you have suggestions for how this project could be improved, or want to report a bug, open an issue! We'd love all and any contributions. If you have questions, too, we'd love to hear them.
\n
Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.
\n
License
\n
MIT Licensed
\n
",
+ "readmeOriginal": "
Geek's Diary
\n
\n
Geek's Diary is markdown editor with version control system integrated. It helps programmers to write TIL(Today I Learned).
yarn serve:browser:app\nyarn serve:browser:wizard\nyarn serve:main-process\n\n// After build completed.\n\nyarn start
\n
Test
\n
yarn test
\n
Contributing
\n
❤️ Thanks for your interest!
\n
If you have suggestions for how this project could be improved, or want to report a bug, open an issue! We'd love all and any contributions. If you have questions, too, we'd love to hear them.
\n
Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.
Geppetto is a free and open animation tool to create and embed webGL animations in a web site. This is the repository for the desktop app to create the animations.\nMade with Create React App and Electron.
You need to create a texture file as .PNG. in Geppetto you will make layers from your texture, and compose them into your image. Next step is to add mutations to your layer tree to create motion. You can then create timelines to define multiple animations.
\n
These animations (the created .json file and your texture .png) can then be loaded using the geppetto player and embedded in a website or electron app.
\n
\n
Available Scripts
\n
Yarn scripts to get started with this repo:
\n
\n
yarn electron-dev Starts electron in develoment mode
Geppetto is a free and open animation tool to create and embed webGL animations in a web site. This is the repository for the desktop app to create the animations.\nMade with Create React App and Electron.
You need to create a texture file as .PNG. in Geppetto you will make layers from your texture, and compose them into your image. Next step is to add mutations to your layer tree to create motion. You can then create timelines to define multiple animations.
\n
These animations (the created .json file and your texture .png) can then be loaded using the geppetto player and embedded in a website or electron app.
\n
\n
Available Scripts
\n
Yarn scripts to get started with this repo:
\n
\n
yarn electron-dev Starts electron in develoment mode
The paper for Genotify is located here. Please cite it if you use Genotify in your research:
\n
Andrews et al., (2018). Genotify: Fast, lightweight gene lookup and summarization . Journal of Open Source Software, 3(28), 885, https://doi.org/10.21105/joss.00885
\n\n
Genotify is a light-weight, cross-platform desktop application for quick gene annotations. If you're a molecular biology researcher or bioinformaticist, you likely find yourself Googling gene names relatively frequently, especially when doing a heavy lit review or poring through tables of differentially expressed genes. Genotify provides up-to-date gene info and access to multiple interactive widgets without opening a browser. Simply copy a gene name, ID, or symbol to your clipboard and use ctrl+q (or cmd+q) to query for that gene. Limit by species if you so desire. Click any of the resulting text boxes to copy them to your clipboard.
\n
This program aims to give you access to all of the resources you could ever want for a gene, from links to all of the major databases to functional summaries. Hopefully it does it well.
Just download the release for your OS, unpack, and run. To build from source with node.js, you can clone the repo and run npm install followed by npm start.
\n
If you run into permissin denied errors during the postinstall script, try adding the --unsafe-perm=true --allow-root arguments.
\n
Basic Usage
\n
Genotify is dead simple to use. Type a query into the search box and click the search button, hit enter, or use the hotkey ctrl+q (or cmd+q) to query from clipboard (even if Genotify isn't focused!). Search for and select species with the species filter, or filter hits in the hits table dynamically. Clicking on a different hit in the hits table will show the information for that hit. Expand the various sections to read what said gene does, explore expression data, see disease associations, or view links out to various data sources. Clicking on a text box will copy its contents to your clipboard for easy copying.
\n
Our group frequently uses Genotify to facilitate:
\n
\n
rapid, efficient lookup of genes while reviewing literature or curating lists of significant genes,
\n
close investigation of families of related genes,
\n
quick ascertainment of the biological significance of differentially expressed genes or associating proteins,
\n
determination of known disease associations,
\n
exploration of protein structure, modifications, and variants,
\n
comparison of mRNA expression of a queried gene across diverse tissues, cell types, and species.
\n
\n
An Illustrative Example
\n
One of the situations where Genotify really shines is when you're digging through a table of results from some analysis. Say you just finished a differential expression analysis from a human cancer cell line treated with a novel compound identified as potentially efficacious and want to determine how the drug might be affecting the biology of these cells. You view the top 10 most downregulated genes after treatment and notice several that seem similar:
\n
\n
Finding Basic Gene Information
\n
A quick search for our top hit in the list (KMT2E) let's us determine it's genomic location, official name, aliases (the KMT2 family are frequently interchanged with their old MLL names to this day), and other basic information under the Gene Basics section. We could click on another hit in the Hits table to view information for the gene in another species. For more info, we can look at the Function section and see that the KMT2E protein functions as a histone methyltransferase, trimethylating histone H3 at Lysine 3 (a histone modification often seen near active gene promoters).
\n
\n
Let's try another hit - KMT2C, and limit the search to humans only.
\n
Finding Disease Associations, Accessions, and Viewing Protein Structure
\n
\n
Again, it's a histone methyltransferase (as are KMT2D and KMT2A). We can look at known Disease Associations, get Accessions to many other databases that will open in your default browser when clicked, and look at the actual structure of the KMT2C protein - domains, variants, post-translation modifications, and more - all with links to their data sources and publications via the ProtVista viewer.
\n
Investigating Gene Expression
\n
The Expression section provides a wealth of information regarding expression of KMT2C across many different tissues, experiments, and cell lines through the EBI Expression Atlas. The default view shows many experiments - not super helpful! But we can filter for a specific tissue or cell type easily by clicking the Filter button. We could also download the data with the download button.
\n
\n
We can also search for specific datasets by typing in the Search Experiments box. Maybe we want to know the expression of this gene in a variety of tissues, so we search for the GTEx dataset and can interactively compare the expression. It also has a boxplot view that sometimes makes it easier to compare between samples/tissues. The experiments table will update to show different experiments if a hit for a different species is shown. Sometimes, data won't be found for a given gene in a given experiment. This is usually due to the experiment being a differential expression analysis (Microarray or RNA-Seq Differential), which only contain data for genes that are differentially expressed between the two conditions. The RNA-Seq Baseline experiments are typically more reliable and are what most people will likely find most useful.
\n
\n
Now we know that the drug seems to be affecting histone methyltransferases and can easily determine what diseases these genes are associated with, any known variants that might affect their disease potential, and identify other cell lines that would make good candidates for investigating these genes due to their high expression. It also suggests that maybe some ChIP-seq experiments for histone methylation would be a good idea for next steps. Importantly, Genotify provides all this information and interactive exploratory widgets in a single place for convenience and time-saving.
\n
Issues and Feedback
\n
Hit up the issues pages here and describe the issue in detail. Screenshots may be helpful. I'm usually pretty quick to respond. We are also open to suggestions for new features.
\n
Contributing
\n
For developing, you will need node.js installed. Clone the repo and install with npm install and run with npm start. If you want to contribute, open a pull request that addresses a known issue or adds something of value.
\n
License
\n
This program is free software: you can redistribute it and/or modify\nit under the terms of the License.
\n
This program is distributed in the hope that it will be useful,\nbut WITHOUT ANY WARRANTY; without even the implied warranty of\nMERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\nLicense for more details.
\n
You should have received a copy of the License.
\n
Copyright 2018-2019, Washington University in St. Louis
\n
",
"readmeOriginal": "
Genotify
\n
\n
\n
The paper for Genotify is located here. Please cite it if you use Genotify in your research:
\n
Andrews et al., (2018). Genotify: Fast, lightweight gene lookup and summarization . Journal of Open Source Software, 3(28), 885, https://doi.org/10.21105/joss.00885
\n\n
Genotify is a light-weight, cross-platform desktop application for quick gene annotations. If you're a molecular biology researcher or bioinformaticist, you likely find yourself Googling gene names relatively frequently, especially when doing a heavy lit review or poring through tables of differentially expressed genes. Genotify provides up-to-date gene info and access to multiple interactive widgets without opening a browser. Simply copy a gene name, ID, or symbol to your clipboard and use ctrl+q (or cmd+q) to query for that gene. Limit by species if you so desire. Click any of the resulting text boxes to copy them to your clipboard.
\n
This program aims to give you access to all of the resources you could ever want for a gene, from links to all of the major databases to functional summaries. Hopefully it does it well.
Just download the release for your OS, unpack, and run. To build from source with node.js, you can clone the repo and run npm install followed by npm start.
\n
If you run into permissin denied errors during the postinstall script, try adding the --unsafe-perm=true --allow-root arguments.
\n
Basic Usage
\n
Genotify is dead simple to use. Type a query into the search box and click the search button, hit enter, or use the hotkey ctrl+q (or cmd+q) to query from clipboard (even if Genotify isn't focused!). Search for and select species with the species filter, or filter hits in the hits table dynamically. Clicking on a different hit in the hits table will show the information for that hit. Expand the various sections to read what said gene does, explore expression data, see disease associations, or view links out to various data sources. Clicking on a text box will copy its contents to your clipboard for easy copying.
\n
Our group frequently uses Genotify to facilitate:
\n
\n
rapid, efficient lookup of genes while reviewing literature or curating lists of significant genes,
\n
close investigation of families of related genes,
\n
quick ascertainment of the biological significance of differentially expressed genes or associating proteins,
\n
determination of known disease associations,
\n
exploration of protein structure, modifications, and variants,
\n
comparison of mRNA expression of a queried gene across diverse tissues, cell types, and species.
\n
\n
An Illustrative Example
\n
One of the situations where Genotify really shines is when you're digging through a table of results from some analysis. Say you just finished a differential expression analysis from a human cancer cell line treated with a novel compound identified as potentially efficacious and want to determine how the drug might be affecting the biology of these cells. You view the top 10 most downregulated genes after treatment and notice several that seem similar:
\n
\n
Finding Basic Gene Information
\n
A quick search for our top hit in the list (KMT2E) let's us determine it's genomic location, official name, aliases (the KMT2 family are frequently interchanged with their old MLL names to this day), and other basic information under the Gene Basics section. We could click on another hit in the Hits table to view information for the gene in another species. For more info, we can look at the Function section and see that the KMT2E protein functions as a histone methyltransferase, trimethylating histone H3 at Lysine 3 (a histone modification often seen near active gene promoters).
\n
\n
Let's try another hit - KMT2C, and limit the search to humans only.
\n
Finding Disease Associations, Accessions, and Viewing Protein Structure
\n
\n
Again, it's a histone methyltransferase (as are KMT2D and KMT2A). We can look at known Disease Associations, get Accessions to many other databases that will open in your default browser when clicked, and look at the actual structure of the KMT2C protein - domains, variants, post-translation modifications, and more - all with links to their data sources and publications via the ProtVista viewer.
\n
Investigating Gene Expression
\n
The Expression section provides a wealth of information regarding expression of KMT2C across many different tissues, experiments, and cell lines through the EBI Expression Atlas. The default view shows many experiments - not super helpful! But we can filter for a specific tissue or cell type easily by clicking the Filter button. We could also download the data with the download button.
\n
\n
We can also search for specific datasets by typing in the Search Experiments box. Maybe we want to know the expression of this gene in a variety of tissues, so we search for the GTEx dataset and can interactively compare the expression. It also has a boxplot view that sometimes makes it easier to compare between samples/tissues. The experiments table will update to show different experiments if a hit for a different species is shown. Sometimes, data won't be found for a given gene in a given experiment. This is usually due to the experiment being a differential expression analysis (Microarray or RNA-Seq Differential), which only contain data for genes that are differentially expressed between the two conditions. The RNA-Seq Baseline experiments are typically more reliable and are what most people will likely find most useful.
\n
\n
Now we know that the drug seems to be affecting histone methyltransferases and can easily determine what diseases these genes are associated with, any known variants that might affect their disease potential, and identify other cell lines that would make good candidates for investigating these genes due to their high expression. It also suggests that maybe some ChIP-seq experiments for histone methylation would be a good idea for next steps. Importantly, Genotify provides all this information and interactive exploratory widgets in a single place for convenience and time-saving.
\n
Issues and Feedback
\n
Hit up the issues pages here and describe the issue in detail. Screenshots may be helpful. I'm usually pretty quick to respond. We are also open to suggestions for new features.
\n
Contributing
\n
For developing, you will need node.js installed. Clone the repo and install with npm install and run with npm start. If you want to contribute, open a pull request that addresses a known issue or adds something of value.
\n
License
\n
This program is free software: you can redistribute it and/or modify\nit under the terms of the License.
\n
This program is distributed in the hope that it will be useful,\nbut WITHOUT ANY WARRANTY; without even the implied warranty of\nMERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\nLicense for more details.
\n
You should have received a copy of the License.
\n
Copyright 2018-2019, Washington University in St. Louis
\nGit-it is a desktop (Mac, Windows and Linux) app that teaches you how to use Git and GitHub on the command line.
\n
🚩The app includes translations in several languages: English, German, Spanish, French, Japanese, Korean, Kurdish, Polish, Portuguese, Ukrainian and traditional Chinese. 🚩\nDue to Code-Changes on handling translations, some translations are currently not visible as translated. The translations still need to be copied over to transifex, contributions are welcome! (see section 'Translations' and #77)
\n
The app was originally created by Jessica Lord (jlord) and it's current state is still strongly dependent on her Repositories and the operation of Reporobot on her servers. As the app seemed to be unmaintained, i (jotoeri) took it over and moved it to this organisation to update dependencies and content. It would just have been a pity to see such a great tutorial die. However, I would appreciate if Jessica wants to keep up this work together.
\n\n
Hello future Forkers, Branchers and Pull Requesters!
\n
This application contains challenges for learning Git and GitHub—by using real Git and GitHub, not emulators. You'll be learning the awesome (and not so scary) command line and GitHub which means when you finish all of the challenges you'll have real repositories on your GitHub account and green squares on your contribution chart.
\n
\n
What to Install
\n
You will need this app, Git-it as well as a text editor. You'll also of course need Git and the first challenge in Git-it helps you get that set up. But if you want to get a head start, go for it! You'll continue to use Git and your text editor throughout your bright social coding future.
\n
As a part of the challenges you'll also create a (free) account on GitHub. If you've already got one, high-five!
\n
Git
\n
We recommend installing Git on your computer by installing the latest version from the Git website.
\n
Note—If you're using Windows, you should use the Git Shell app as your terminal—it is installed with Git. In Mac and Linux you can use the app Terminal, which is already on your computer.
\n
Text Editor
\n
I'm quite partial (I'm on the team!) but Atom is a great text editor (also free) and it is built on Electron.js, just like Git-it. Visit the website and download the version for your operating system. Sublime, Microsoft VS Code and Adobe Brackets are other options.
\n
Git-it
\n
You can view the releases section of this repository to find the download for your operating system. Click to download your version. Once it has downloaded to your default Downloads directory, unzip the folder and run the Git-it executable. The executables for Mac, Windows and Linux:
\n
\n
\n
Mac Right (control) click the Git-it icon, select Open and then Open again. You can drag the icon into your Applications directory if you want, but it's not required. If needed, more detailed installation instructions can be found in this issue.
\n
Windows Double-click the executable.
\n
Linux Double-click the executable. If the app isn't running, see this issue.
\n
\n
Get Started!
\n
Open Git-it and click the button to begin the first challenge. Have your terminal and text editor open, too. Follow along with the instructions in each challenge and use the terminal or editor as instructed.
\n
When you've completed the steps in a challenge click 'Verify'. Depending on the challenge you may need to also select the folder you did your work in for Git-it to verify.
Code snippets often times look like $ some code-stuff --here. The dollar sign identifies the line as one a user would enter into the command line, but you don't actually include it when you type it into terminal. In this case, you'd actually just type some code-stuff --here.
\n
Variables are indicated by <VARIABLENAME> in code snippets. When you actually use the line of code, replace <VARIABLENAME>, with your variable. For instance to make a new folder in terminal the format is, mkdir <FOLDERNAME>, so if you wanted to make a folder named 'octocat', you'd type: mkdir octocat.
\n
Command line, terminal and bash all basically mean the same thing: the MS-DOS, Doogie Howser looking screen full of words and numbers. It's awesomely powerful and allows you to control your computer with text commands.
\n
You can do a lot of things from your terminal like delete, rename, copy or create files and folders; run scripts and send things back and forth between servers (like the ones storing things on GitHub.com) and your computer (also a server!).
\n
Translations
\n
You found some english text on the translated content? That might happen, if we changed some content on the english base but the appropriate translation is still missing. We are happy on every contribution, so feel free to head over to the Transifex Project to insert the right translations there! The next release will then be a bit more complete! ☺️🎉
\n
",
- "readmeOriginal": "
Git-it (Desktop App)
\n
\n\n
\n
\nGit-it is a desktop (Mac, Windows and Linux) app that teaches you how to use Git and GitHub on the command line.
\n
🚩The app includes translations in several languages: English, German, Spanish, French, Japanese, Korean, Kurdish, Polish, Portuguese, Ukrainian and traditional Chinese. 🚩\nDue to Code-Changes on handling translations, some translations are currently not visible as translated. The translations still need to be copied over to transifex, contributions are welcome! (see section 'Translations' and #77)
\n
The app was originally created by Jessica Lord (jlord) and it's current state is still strongly dependent on her Repositories and the operation of Reporobot on her servers. As the app seemed to be unmaintained, i (jotoeri) took it over and moved it to this organisation to update dependencies and content. It would just have been a pity to see such a great tutorial die. However, I would appreciate if Jessica wants to keep up this work together.
\n\n
Hello future Forkers, Branchers and Pull Requesters!
\n
This application contains challenges for learning Git and GitHub—by using real Git and GitHub, not emulators. You'll be learning the awesome (and not so scary) command line and GitHub which means when you finish all of the challenges you'll have real repositories on your GitHub account and green squares on your contribution chart.
\n
\n
What to Install
\n
You will need this app, Git-it as well as a text editor. You'll also of course need Git and the first challenge in Git-it helps you get that set up. But if you want to get a head start, go for it! You'll continue to use Git and your text editor throughout your bright social coding future.
\n
As a part of the challenges you'll also create a (free) account on GitHub. If you've already got one, high-five!
\n
Git
\n
We recommend installing Git on your computer by installing the latest version from the Git website.
\n
Note—If you're using Windows, you should use the Git Shell app as your terminal—it is installed with Git. In Mac and Linux you can use the app Terminal, which is already on your computer.
\n
Text Editor
\n
I'm quite partial (I'm on the team!) but Atom is a great text editor (also free) and it is built on Electron.js, just like Git-it. Visit the website and download the version for your operating system. Sublime, Microsoft VS Code and Adobe Brackets are other options.
\n
Git-it
\n
You can view the releases section of this repository to find the download for your operating system. Click to download your version. Once it has downloaded to your default Downloads directory, unzip the folder and run the Git-it executable. The executables for Mac, Windows and Linux:
\n
\n
\n
Mac Right (control) click the Git-it icon, select Open and then Open again. You can drag the icon into your Applications directory if you want, but it's not required. If needed, more detailed installation instructions can be found in this issue.
\n
Windows Double-click the executable.
\n
Linux Double-click the executable. If the app isn't running, see this issue.
\n
\n
Get Started!
\n
Open Git-it and click the button to begin the first challenge. Have your terminal and text editor open, too. Follow along with the instructions in each challenge and use the terminal or editor as instructed.
\n
When you've completed the steps in a challenge click 'Verify'. Depending on the challenge you may need to also select the folder you did your work in for Git-it to verify.
Code snippets often times look like $ some code-stuff --here. The dollar sign identifies the line as one a user would enter into the command line, but you don't actually include it when you type it into terminal. In this case, you'd actually just type some code-stuff --here.
\n
Variables are indicated by <VARIABLENAME> in code snippets. When you actually use the line of code, replace <VARIABLENAME>, with your variable. For instance to make a new folder in terminal the format is, mkdir <FOLDERNAME>, so if you wanted to make a folder named 'octocat', you'd type: mkdir octocat.
\n
Command line, terminal and bash all basically mean the same thing: the MS-DOS, Doogie Howser looking screen full of words and numbers. It's awesomely powerful and allows you to control your computer with text commands.
\n
You can do a lot of things from your terminal like delete, rename, copy or create files and folders; run scripts and send things back and forth between servers (like the ones storing things on GitHub.com) and your computer (also a server!).
\n
Translations
\n
You found some english text on the translated content? That might happen, if we changed some content on the english base but the appropriate translation is still missing. We are happy on every contribution, so feel free to head over to the Transifex Project to insert the right translations there! The next release will then be a bit more complete! ☺️🎉
Gitmoji is an initiative to standardize and explain the use of emojis on GitHub commit messages.
\n
Using emojis on commit messages provides an easy way of identifying the purpose or intention of a commit with only looking at the emojis used. As there are a lot of different emojis I found the need of creating a guide that can help to use emojis easier.
\n
The gitmojis are published on the following package in order to be used as a dependency 📦.
Gitmoji is an initiative to standardize and explain the use of emojis on GitHub commit messages.
\n
Using emojis on commit messages provides an easy way of identifying the purpose or intention of a commit with only looking at the emojis used. As there are a lot of different emojis I found the need of creating a guide that can help to use emojis easier.
\n
The gitmojis are published on the following package in order to be used as a dependency 📦.
GitHub Notifications on your menu bar. Available on macOS, Windows and Linux. Gitify Mobile has been deprecated in favour of the official GitHub mobile app.
Optional: If you prefer to use your own OAuth credentials, you can do so by passing them as environment variables when bundling the app. This is optional as the app has some default \"development\" keys (use at your own discretion).
To watch for changes(webpack) in the src directory:
\n
yarn run watch\n
\n
To run the electron app:
\n
yarn start\n
\n
Releases
\n
The release process is automated. Follow the steps below.
\n\n
Create a new draft release. Set the tag version to something with the format of v1.2.3. Save as a draft.
\n
Once everything is merged to main, create a branch that starts with release/vX.X.X (ie. release/v1.2.3).
\n
In the same branch, bump the version of the app in the package.json file and open a PR. GitHub Actions will build, sign and upload the release assets for each commit to that branch as long as a branch is named like release/vX.X.X and there is a draft release with the same version number(package.json).
\n
Merge your release branch into main.
\n
Publish the draft release once you've added notes to it and all assets are there.
\n\n
Tests
\n
There are 2 checks - one for prettier and one for the unit tests with jest.
\n
// Run prettier to check\nyarn run prettier:check\n\n// Run linter & unit tests with coverage\nyarn run test\n\n// Run jest directly - allows to pass arguments like `--watch`\nyarn run jest\n
\n
FAQ
\n
My notifications aren't showing?
\n
Some organisations require applications to request access before allowing access to any data (including notifications) about their repositories.
\n
To check if Gitify is approved by your organisation you can go to https://github.com/settings/applications, then click on Gitify and scroll to Organization access.
\n
Something looks wrong - How can I debug?
\n
You can debug Gitify by pressing alt + command + I. This will open the dev tools and then you can see any logs, network requests etc.
\n
Contributing
\n\n
Fork it!
\n
Create your feature branch: git checkout -b my-new-feature
\n
Commit your changes: git commit -am 'Add some feature'
\n
Push to the branch: git push origin my-new-feature
\n
Submit a pull request
\n
Make sure tests are passing
\n\n
License
\n
Gitify is licensed under the MIT Open Source license. For more information, see the LICENSE file in this repository.
\n
",
- "readmeOriginal": "
Gitify
\n
\n
GitHub Notifications on your menu bar. Available on macOS, Windows and Linux. Gitify Mobile has been deprecated in favour of the official GitHub mobile app.
Optional: If you prefer to use your own OAuth credentials, you can do so by passing them as environment variables when bundling the app. This is optional as the app has some default \"development\" keys (use at your own discretion).
To watch for changes(webpack) in the src directory:
\n
yarn run watch\n
\n
To run the electron app:
\n
yarn start\n
\n
Releases
\n
The release process is automated. Follow the steps below.
\n\n
Create a new draft release. Set the tag version to something with the format of v1.2.3. Save as a draft.
\n
Once everything is merged to main, create a branch that starts with release/vX.X.X (ie. release/v1.2.3).
\n
In the same branch, bump the version of the app in the package.json file and open a PR. GitHub Actions will build, sign and upload the release assets for each commit to that branch as long as a branch is named like release/vX.X.X and there is a draft release with the same version number(package.json).
\n
Merge your release branch into main.
\n
Publish the draft release once you've added notes to it and all assets are there.
\n\n
Tests
\n
There are 2 checks - one for prettier and one for the unit tests with jest.
\n
// Run prettier to check\nyarn run prettier:check\n\n// Run linter & unit tests with coverage\nyarn run test\n\n// Run jest directly - allows to pass arguments like `--watch`\nyarn run jest\n
\n
FAQ
\n
My notifications aren't showing?
\n
Some organisations require applications to request access before allowing access to any data (including notifications) about their repositories.
\n
To check if Gitify is approved by your organisation you can go to https://github.com/settings/applications, then click on Gitify and scroll to Organization access.
\n
Something looks wrong - How can I debug?
\n
You can debug Gitify by pressing alt + command + I. This will open the dev tools and then you can see any logs, network requests etc.
\n
Contributing
\n\n
Fork it!
\n
Create your feature branch: git checkout -b my-new-feature
\n
Commit your changes: git commit -am 'Add some feature'
\n
Push to the branch: git push origin my-new-feature
\n
Submit a pull request
\n
Make sure tests are passing
\n\n
License
\n
Gitify is licensed under the MIT Open Source license. For more information, see the LICENSE file in this repository.
\nGit-it is a desktop (Mac, Windows and Linux) app that teaches you how to use Git and GitHub on the command line.
\n
🚩The app includes translations in several languages: English, German, Spanish, French, Japanese, Korean, Kurdish, Polish, Portuguese, Ukrainian and traditional Chinese. 🚩\nDue to Code-Changes on handling translations, some translations are currently not visible as translated. The translations still need to be copied over to transifex, contributions are welcome! (see section 'Translations' and #77)
\n
The app was originally created by Jessica Lord (jlord) and it's current state is still strongly dependent on her Repositories and the operation of Reporobot on her servers. As the app seemed to be unmaintained, i (jotoeri) took it over and moved it to this organisation to update dependencies and content. It would just have been a pity to see such a great tutorial die. However, I would appreciate if Jessica wants to keep up this work together.
\n\n
Hello future Forkers, Branchers and Pull Requesters!
\n
This application contains challenges for learning Git and GitHub—by using real Git and GitHub, not emulators. You'll be learning the awesome (and not so scary) command line and GitHub which means when you finish all of the challenges you'll have real repositories on your GitHub account and green squares on your contribution chart.
\n
\n
What to Install
\n
You will need this app, Git-it as well as a text editor. You'll also of course need Git and the first challenge in Git-it helps you get that set up. But if you want to get a head start, go for it! You'll continue to use Git and your text editor throughout your bright social coding future.
\n
As a part of the challenges you'll also create a (free) account on GitHub. If you've already got one, high-five!
\n
Git
\n
We recommend installing Git on your computer by installing the latest version from the Git website.
\n
Note—If you're using Windows, you should use the Git Shell app as your terminal—it is installed with Git. In Mac and Linux you can use the app Terminal, which is already on your computer.
\n
Text Editor
\n
I'm quite partial (I'm on the team!) but Atom is a great text editor (also free) and it is built on Electron.js, just like Git-it. Visit the website and download the version for your operating system. Sublime, Microsoft VS Code and Adobe Brackets are other options.
\n
Git-it
\n
You can view the releases section of this repository to find the download for your operating system. Click to download your version. Once it has downloaded to your default Downloads directory, unzip the folder and run the Git-it executable. The executables for Mac, Windows and Linux:
\n
\n
\n
Mac Right (control) click the Git-it icon, select Open and then Open again. You can drag the icon into your Applications directory if you want, but it's not required. If needed, more detailed installation instructions can be found in this issue.
\n
Windows Double-click the executable.
\n
Linux Double-click the executable. If the app isn't running, see this issue.
\n
\n
Get Started!
\n
Open Git-it and click the button to begin the first challenge. Have your terminal and text editor open, too. Follow along with the instructions in each challenge and use the terminal or editor as instructed.
\n
When you've completed the steps in a challenge click 'Verify'. Depending on the challenge you may need to also select the folder you did your work in for Git-it to verify.
Code snippets often times look like $ some code-stuff --here. The dollar sign identifies the line as one a user would enter into the command line, but you don't actually include it when you type it into terminal. In this case, you'd actually just type some code-stuff --here.
\n
Variables are indicated by <VARIABLENAME> in code snippets. When you actually use the line of code, replace <VARIABLENAME>, with your variable. For instance to make a new folder in terminal the format is, mkdir <FOLDERNAME>, so if you wanted to make a folder named 'octocat', you'd type: mkdir octocat.
\n
Command line, terminal and bash all basically mean the same thing: the MS-DOS, Doogie Howser looking screen full of words and numbers. It's awesomely powerful and allows you to control your computer with text commands.
\n
You can do a lot of things from your terminal like delete, rename, copy or create files and folders; run scripts and send things back and forth between servers (like the ones storing things on GitHub.com) and your computer (also a server!).
\n
Translations
\n
You found some english text on the translated content? That might happen, if we changed some content on the english base but the appropriate translation is still missing. We are happy on every contribution, so feel free to head over to the Transifex Project to insert the right translations there! The next release will then be a bit more complete! ☺️🎉
\n
",
+ "readmeOriginal": "
Git-it (Desktop App)
\n
\n\n
\n
\nGit-it is a desktop (Mac, Windows and Linux) app that teaches you how to use Git and GitHub on the command line.
\n
🚩The app includes translations in several languages: English, German, Spanish, French, Japanese, Korean, Kurdish, Polish, Portuguese, Ukrainian and traditional Chinese. 🚩\nDue to Code-Changes on handling translations, some translations are currently not visible as translated. The translations still need to be copied over to transifex, contributions are welcome! (see section 'Translations' and #77)
\n
The app was originally created by Jessica Lord (jlord) and it's current state is still strongly dependent on her Repositories and the operation of Reporobot on her servers. As the app seemed to be unmaintained, i (jotoeri) took it over and moved it to this organisation to update dependencies and content. It would just have been a pity to see such a great tutorial die. However, I would appreciate if Jessica wants to keep up this work together.
\n\n
Hello future Forkers, Branchers and Pull Requesters!
\n
This application contains challenges for learning Git and GitHub—by using real Git and GitHub, not emulators. You'll be learning the awesome (and not so scary) command line and GitHub which means when you finish all of the challenges you'll have real repositories on your GitHub account and green squares on your contribution chart.
\n
\n
What to Install
\n
You will need this app, Git-it as well as a text editor. You'll also of course need Git and the first challenge in Git-it helps you get that set up. But if you want to get a head start, go for it! You'll continue to use Git and your text editor throughout your bright social coding future.
\n
As a part of the challenges you'll also create a (free) account on GitHub. If you've already got one, high-five!
\n
Git
\n
We recommend installing Git on your computer by installing the latest version from the Git website.
\n
Note—If you're using Windows, you should use the Git Shell app as your terminal—it is installed with Git. In Mac and Linux you can use the app Terminal, which is already on your computer.
\n
Text Editor
\n
I'm quite partial (I'm on the team!) but Atom is a great text editor (also free) and it is built on Electron.js, just like Git-it. Visit the website and download the version for your operating system. Sublime, Microsoft VS Code and Adobe Brackets are other options.
\n
Git-it
\n
You can view the releases section of this repository to find the download for your operating system. Click to download your version. Once it has downloaded to your default Downloads directory, unzip the folder and run the Git-it executable. The executables for Mac, Windows and Linux:
\n
\n
\n
Mac Right (control) click the Git-it icon, select Open and then Open again. You can drag the icon into your Applications directory if you want, but it's not required. If needed, more detailed installation instructions can be found in this issue.
\n
Windows Double-click the executable.
\n
Linux Double-click the executable. If the app isn't running, see this issue.
\n
\n
Get Started!
\n
Open Git-it and click the button to begin the first challenge. Have your terminal and text editor open, too. Follow along with the instructions in each challenge and use the terminal or editor as instructed.
\n
When you've completed the steps in a challenge click 'Verify'. Depending on the challenge you may need to also select the folder you did your work in for Git-it to verify.
Code snippets often times look like $ some code-stuff --here. The dollar sign identifies the line as one a user would enter into the command line, but you don't actually include it when you type it into terminal. In this case, you'd actually just type some code-stuff --here.
\n
Variables are indicated by <VARIABLENAME> in code snippets. When you actually use the line of code, replace <VARIABLENAME>, with your variable. For instance to make a new folder in terminal the format is, mkdir <FOLDERNAME>, so if you wanted to make a folder named 'octocat', you'd type: mkdir octocat.
\n
Command line, terminal and bash all basically mean the same thing: the MS-DOS, Doogie Howser looking screen full of words and numbers. It's awesomely powerful and allows you to control your computer with text commands.
\n
You can do a lot of things from your terminal like delete, rename, copy or create files and folders; run scripts and send things back and forth between servers (like the ones storing things on GitHub.com) and your computer (also a server!).
\n
Translations
\n
You found some english text on the translated content? That might happen, if we changed some content on the english base but the appropriate translation is still missing. We are happy on every contribution, so feel free to head over to the Transifex Project to insert the right translations there! The next release will then be a bit more complete! ☺️🎉
The goal of GitHoard is to trivialize cloning repositories for future offline review.
\n
Often, the process of copy & pasting a repository to the command line breaks focus and flow, and other Git GUI's perpetuate this problem by requiring the selecting of a directory before starting the clone process.
\n
GitHoard solves this by overriding the HTTP protocols associated with GitHub (github-mac:// and github-win://) and Sourcetree (sourcetree://) as well as creating a new protocol (githoard://) then automatically cloning when a link using that protocol is clicked.
\n
Download
\n
Download the latest version from the releases page.
\n
Demo
\n
Install
\n
\n
Get Addon
\n
\n
See Changes
\n
\n
Locate
\n
\n
Destroy
\n
\n
Build Setup
\n
# install dependencies\nnpm install\n\n# serve with hot reload at localhost:9080\nnpm run electron:serve\n\n# build electron application for production\nnpm run electron:build\n\n\n# run unit & end-to-end tests\nnpm run test:unit\n\n# lint all JS/Vue component files in `src/`\nnpm run lint\n
\n
Related
\n
Want to clone stuff even quicker? Check out our Firefox browser addon
GitHoard logo created by Beep Boop Bang Bang LLC.\nMakes use of Git Logo by Jason Long which is licensed under the Creative Commons Attribution 3.0 Unported License.\nSee https://git-scm.com/downloads/logos
\n
",
"readmeOriginal": "
\n\n
\n
\nGitHoard\n
\n
\nHoard git repositories with ease\n
\n
\n
\n\n
Overview
\n
The goal of GitHoard is to trivialize cloning repositories for future offline review.
\n
Often, the process of copy & pasting a repository to the command line breaks focus and flow, and other Git GUI's perpetuate this problem by requiring the selecting of a directory before starting the clone process.
\n
GitHoard solves this by overriding the HTTP protocols associated with GitHub (github-mac:// and github-win://) and Sourcetree (sourcetree://) as well as creating a new protocol (githoard://) then automatically cloning when a link using that protocol is clicked.
\n
Download
\n
Download the latest version from the releases page.
\n
Demo
\n
Install
\n
\n
Get Addon
\n
\n
See Changes
\n
\n
Locate
\n
\n
Destroy
\n
\n
Build Setup
\n
# install dependencies\nnpm install\n\n# serve with hot reload at localhost:9080\nnpm run electron:serve\n\n# build electron application for production\nnpm run electron:build\n\n\n# run unit & end-to-end tests\nnpm run test:unit\n\n# lint all JS/Vue component files in `src/`\nnpm run lint\n
\n
Related
\n
Want to clone stuff even quicker? Check out our Firefox browser addon
GitHoard logo created by Beep Boop Bang Bang LLC.\nMakes use of Git Logo by Jason Long which is licensed under the Creative Commons Attribution 3.0 Unported License.\nSee https://git-scm.com/downloads/logos
GitHub Notifications on your menu bar. Available on macOS, Windows and Linux. Gitify Mobile has been deprecated in favour of the official GitHub mobile app.
Optional: If you prefer to use your own OAuth credentials, you can do so by passing them as environment variables when bundling the app. This is optional as the app has some default \"development\" keys (use at your own discretion).
To watch for changes(webpack) in the src directory:
\n
yarn run watch\n
\n
To run the electron app:
\n
yarn start\n
\n
Releases
\n
The release process is automated. Follow the steps below.
\n\n
Create a new draft release. Set the tag version to something with the format of v1.2.3. Save as a draft.
\n
Once everything is merged to main, create a branch that starts with release/vX.X.X (ie. release/v1.2.3).
\n
In the same branch, bump the version of the app in the package.json file and open a PR. GitHub Actions will build, sign and upload the release assets for each commit to that branch as long as a branch is named like release/vX.X.X and there is a draft release with the same version number(package.json).
\n
Merge your release branch into main.
\n
Publish the draft release once you've added notes to it and all assets are there.
\n\n
Tests
\n
There are 2 checks - one for prettier and one for the unit tests with jest.
\n
// Run prettier to check\nyarn run prettier:check\n\n// Run linter & unit tests with coverage\nyarn run test\n\n// Run jest directly - allows to pass arguments like `--watch`\nyarn run jest\n
\n
FAQ
\n
My notifications aren't showing?
\n
Some organisations require applications to request access before allowing access to any data (including notifications) about their repositories.
\n
To check if Gitify is approved by your organisation you can go to https://github.com/settings/applications, then click on Gitify and scroll to Organization access.
\n
Something looks wrong - How can I debug?
\n
You can debug Gitify by pressing alt + command + I. This will open the dev tools and then you can see any logs, network requests etc.
\n
Contributing
\n\n
Fork it!
\n
Create your feature branch: git checkout -b my-new-feature
\n
Commit your changes: git commit -am 'Add some feature'
\n
Push to the branch: git push origin my-new-feature
\n
Submit a pull request
\n
Make sure tests are passing
\n\n
License
\n
Gitify is licensed under the MIT Open Source license. For more information, see the LICENSE file in this repository.
\n
",
+ "readmeOriginal": "
Gitify
\n
\n
GitHub Notifications on your menu bar. Available on macOS, Windows and Linux. Gitify Mobile has been deprecated in favour of the official GitHub mobile app.
Optional: If you prefer to use your own OAuth credentials, you can do so by passing them as environment variables when bundling the app. This is optional as the app has some default \"development\" keys (use at your own discretion).
To watch for changes(webpack) in the src directory:
\n
yarn run watch\n
\n
To run the electron app:
\n
yarn start\n
\n
Releases
\n
The release process is automated. Follow the steps below.
\n\n
Create a new draft release. Set the tag version to something with the format of v1.2.3. Save as a draft.
\n
Once everything is merged to main, create a branch that starts with release/vX.X.X (ie. release/v1.2.3).
\n
In the same branch, bump the version of the app in the package.json file and open a PR. GitHub Actions will build, sign and upload the release assets for each commit to that branch as long as a branch is named like release/vX.X.X and there is a draft release with the same version number(package.json).
\n
Merge your release branch into main.
\n
Publish the draft release once you've added notes to it and all assets are there.
\n\n
Tests
\n
There are 2 checks - one for prettier and one for the unit tests with jest.
\n
// Run prettier to check\nyarn run prettier:check\n\n// Run linter & unit tests with coverage\nyarn run test\n\n// Run jest directly - allows to pass arguments like `--watch`\nyarn run jest\n
\n
FAQ
\n
My notifications aren't showing?
\n
Some organisations require applications to request access before allowing access to any data (including notifications) about their repositories.
\n
To check if Gitify is approved by your organisation you can go to https://github.com/settings/applications, then click on Gitify and scroll to Organization access.
\n
Something looks wrong - How can I debug?
\n
You can debug Gitify by pressing alt + command + I. This will open the dev tools and then you can see any logs, network requests etc.
\n
Contributing
\n\n
Fork it!
\n
Create your feature branch: git checkout -b my-new-feature
\n
Commit your changes: git commit -am 'Add some feature'
\n
Push to the branch: git push origin my-new-feature
\n
Submit a pull request
\n
Make sure tests are passing
\n\n
License
\n
Gitify is licensed under the MIT Open Source license. For more information, see the LICENSE file in this repository.
Click the eye to enable click-through mode. It will ignore mouse clicks and let you interact with windows below.
\n
To disable click-through and interact with the window again, click the icon in the Windows dock/taskbar and minimize it, then click again to open it and it will be disabled.
\n
\n
Known Issues
\n
\n
Transparency seems to not be working on Linux - but it still floats above other windows.
Click the eye to enable click-through mode. It will ignore mouse clicks and let you interact with windows below.
\n
To disable click-through and interact with the window again, click the icon in the Windows dock/taskbar and minimize it, then click again to open it and it will be disabled.
\n
\n
Known Issues
\n
\n
Transparency seems to not be working on Linux - but it still floats above other windows.
Gitmoji is an initiative to standardize and explain the use of emojis on GitHub commit messages.
\n
Using emojis on commit messages provides an easy way of identifying the purpose or intention of a commit with only looking at the emojis used. As there are a lot of different emojis I found the need of creating a guide that can help to use emojis easier.
\n
The gitmojis are published on the following package in order to be used as a dependency 📦.
Gitmoji is an initiative to standardize and explain the use of emojis on GitHub commit messages.
\n
Using emojis on commit messages provides an easy way of identifying the purpose or intention of a commit with only looking at the emojis used. As there are a lot of different emojis I found the need of creating a guide that can help to use emojis easier.
\n
The gitmojis are published on the following package in order to be used as a dependency 📦.
You can install this alongside your existing GitHub Desktop for Mac or GitHub\nDesktop for Windows application.
\n
NOTE: there is no current migration path to import your existing\nrepositories into the new application - you can drag-and-drop your repositories\nfrom disk onto the application to get started.
\n
Beta Channel
\n
Want to test out new features and get fixes before everyone else? Install the\nbeta channel to get access to early builds of Desktop:
First, please search the open issues\nand closed issues\nto see if your issue hasn't already been reported (it may also be fixed).
\n
There is also a list of known issues\nthat are being tracked against Desktop, and some of these issues have workarounds.
\n
If you can't find an issue that matches what you're seeing, open a new issue,\nchoose the right template and provide us with enough information to investigate\nfurther.
\n
The issue I reported isn't fixed yet. What can I do?
\n
If nobody has responded to your issue in a few days, you're welcome to respond to it with a friendly ping in the issue. Please do not respond more than a second time if nobody has responded. The GitHub Desktop maintainers are constrained in time and resources, and diagnosing individual configurations can be difficult and time consuming. While we'll try to at least get you pointed in the right direction, we can't guarantee we'll be able to dig too deeply into any one person's issue.
\n
How can I contribute to GitHub Desktop?
\n
The CONTRIBUTING.md document will help you get setup and\nfamiliar with the source. The documentation folder also contains more\nresources relevant to the project.
\n
If you're looking for something to work on, check out the help wanted label.
\n
More Resources
\n
See desktop.github.com for more product-oriented\ninformation about GitHub Desktop.
The MIT license grant is not for GitHub's trademarks, which include the logo\ndesigns. GitHub reserves all trademark and copyright rights in and to all\nGitHub trademarks. GitHub's logos include, for instance, the stylized\nInvertocat designs that include \"logo\" in the file title in the following\nfolder: logos.
\n
GitHub® and its stylized versions and the Invertocat mark are GitHub's\nTrademarks or registered Trademarks. When using GitHub's logos, be sure to\nfollow the GitHub logo guidelines.
You can install this alongside your existing GitHub Desktop for Mac or GitHub\nDesktop for Windows application.
\n
NOTE: there is no current migration path to import your existing\nrepositories into the new application - you can drag-and-drop your repositories\nfrom disk onto the application to get started.
\n
Beta Channel
\n
Want to test out new features and get fixes before everyone else? Install the\nbeta channel to get access to early builds of Desktop:
First, please search the open issues\nand closed issues\nto see if your issue hasn't already been reported (it may also be fixed).
\n
There is also a list of known issues\nthat are being tracked against Desktop, and some of these issues have workarounds.
\n
If you can't find an issue that matches what you're seeing, open a new issue,\nchoose the right template and provide us with enough information to investigate\nfurther.
\n
The issue I reported isn't fixed yet. What can I do?
\n
If nobody has responded to your issue in a few days, you're welcome to respond to it with a friendly ping in the issue. Please do not respond more than a second time if nobody has responded. The GitHub Desktop maintainers are constrained in time and resources, and diagnosing individual configurations can be difficult and time consuming. While we'll try to at least get you pointed in the right direction, we can't guarantee we'll be able to dig too deeply into any one person's issue.
\n
How can I contribute to GitHub Desktop?
\n
The CONTRIBUTING.md document will help you get setup and\nfamiliar with the source. The documentation folder also contains more\nresources relevant to the project.
\n
If you're looking for something to work on, check out the help wanted label.
\n
More Resources
\n
See desktop.github.com for more product-oriented\ninformation about GitHub Desktop.
The MIT license grant is not for GitHub's trademarks, which include the logo\ndesigns. GitHub reserves all trademark and copyright rights in and to all\nGitHub trademarks. GitHub's logos include, for instance, the stylized\nInvertocat designs that include \"logo\" in the file title in the following\nfolder: logos.
\n
GitHub® and its stylized versions and the Invertocat mark are GitHub's\nTrademarks or registered Trademarks. When using GitHub's logos, be sure to\nfollow the GitHub logo guidelines.
Be sure to have Node.js and git installed. Linux/Mac users who wish to do builds for Windows will need to have WINE installed. Mac users who wish to do builds for Windows will need to XQuartz installed in order to run WINE. It is recommended that Mac users install both Wine and XQuartz via Homebrew.
Be sure to have Node.js and git installed. Linux/Mac users who wish to do builds for Windows will need to have WINE installed. Mac users who wish to do builds for Windows will need to XQuartz installed in order to run WINE. It is recommended that Mac users install both Wine and XQuartz via Homebrew.
Click the eye to enable click-through mode. It will ignore mouse clicks and let you interact with windows below.
\n
To disable click-through and interact with the window again, click the icon in the Windows dock/taskbar and minimize it, then click again to open it and it will be disabled.
\n
\n
Known Issues
\n
\n
Transparency seems to not be working on Linux - but it still floats above other windows.
Click the eye to enable click-through mode. It will ignore mouse clicks and let you interact with windows below.
\n
To disable click-through and interact with the window again, click the icon in the Windows dock/taskbar and minimize it, then click again to open it and it will be disabled.
\n
\n
Known Issues
\n
\n
Transparency seems to not be working on Linux - but it still floats above other windows.
Run \"Google Play Music\" as a standalone desktop app. Never again will you have to hunt through your tabs to pause your music, or stop listening to your favourite song because Chrome is guzzling up all your RAM. Now also has YouTube Music player fully integrated.
Both are documented in the Docs folder. For one time read access you should\nprobably use the JSON interface. For an application that requires continuous\nupdates as to the state of GPMDP or needs to control GPMDP you should use the\nWeb Socket interface.
\n
Issues
\n
If you have any bugs / issues please check the\nFAQ\nfirst before raising an issue
To get started just pull the repo and run the following
\n
npm install\nnpm run build\nnpm start
\n
To build the installers / release packages you need to run, you can only build a platforms installer from that platform.
\n
# Windows\nnpm run make:win\n\n# Mac OS X\nnpm run make:darwin\n\n# Ubuntu (Requires the 'dpkg' package)\nnpm run make:deb\n\n# Fedora (Requires the 'rpm' package)\nnpm run make:rpm
\n
All releases will be signing with my Code Signing Certificates (Authenticode on Windows and Codesign on OS X)
\n
Please see the development FAQ for additional requirements for building.
\n
Contributing
\n
If you find something wrong (theming issues, app crashes) please report them as an issue. \nIf you think you can add something cool or fix a problem, fork the repo and make a pull request :D
\n
NOTE: Some of the functionality in this app has been extracted into smaller submodules. In particular
You can download the latest signed installers for Windows from the artifacts section of AppVeyor \nYou can download the latest linux (debian and fedora) and OS X (darwin) builds from the artifacts section on Circle CI
\n
License
\n
The MIT License (MIT)
\n
Copyright (c) 2016 Samuel Attard
\n
Permission is hereby granted, free of charge, to any person obtaining a copy of\nthis software and associated documentation files (the \"Software\"), to deal in\nthe Software without restriction, including without limitation the rights to\nuse, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of\nthe Software, and to permit persons to whom the Software is furnished to do so,\nsubject to the following conditions:
\n
The above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.
\n
THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS\nFOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR\nCOPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER\nIN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN\nCONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
\n
",
- "readmeOriginal": "
Google Play Music™ Desktop Player
\n
\n\n\n\n\n\n \nWindows: \nMacOS / Linux:
\n
\n
Run \"Google Play Music\" as a standalone desktop app. Never again will you have to hunt through your tabs to pause your music, or stop listening to your favourite song because Chrome is guzzling up all your RAM. Now also has YouTube Music player fully integrated.
Both are documented in the Docs folder. For one time read access you should\nprobably use the JSON interface. For an application that requires continuous\nupdates as to the state of GPMDP or needs to control GPMDP you should use the\nWeb Socket interface.
\n
Issues
\n
If you have any bugs / issues please check the\nFAQ\nfirst before raising an issue
To get started just pull the repo and run the following
\n
npm install\nnpm run build\nnpm start
\n
To build the installers / release packages you need to run, you can only build a platforms installer from that platform.
\n
# Windows\nnpm run make:win\n\n# Mac OS X\nnpm run make:darwin\n\n# Ubuntu (Requires the 'dpkg' package)\nnpm run make:deb\n\n# Fedora (Requires the 'rpm' package)\nnpm run make:rpm
\n
All releases will be signing with my Code Signing Certificates (Authenticode on Windows and Codesign on OS X)
\n
Please see the development FAQ for additional requirements for building.
\n
Contributing
\n
If you find something wrong (theming issues, app crashes) please report them as an issue. \nIf you think you can add something cool or fix a problem, fork the repo and make a pull request :D
\n
NOTE: Some of the functionality in this app has been extracted into smaller submodules. In particular
You can download the latest signed installers for Windows from the artifacts section of AppVeyor \nYou can download the latest linux (debian and fedora) and OS X (darwin) builds from the artifacts section on Circle CI
\n
License
\n
The MIT License (MIT)
\n
Copyright (c) 2016 Samuel Attard
\n
Permission is hereby granted, free of charge, to any person obtaining a copy of\nthis software and associated documentation files (the \"Software\"), to deal in\nthe Software without restriction, including without limitation the rights to\nuse, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of\nthe Software, and to permit persons to whom the Software is furnished to do so,\nsubject to the following conditions:
\n
The above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.
\n
THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS\nFOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR\nCOPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER\nIN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN\nCONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Be sure to have Node.js and git installed. Linux/Mac users who wish to do builds for Windows will need to have WINE installed. Mac users who wish to do builds for Windows will need to XQuartz installed in order to run WINE. It is recommended that Mac users install both Wine and XQuartz via Homebrew.
Be sure to have Node.js and git installed. Linux/Mac users who wish to do builds for Windows will need to have WINE installed. Mac users who wish to do builds for Windows will need to XQuartz installed in order to run WINE. It is recommended that Mac users install both Wine and XQuartz via Homebrew.
Google Assistant Unofficial Desktop Client is a cross-platform desktop client for Google Assistant based on Google Assistant SDK.
\n
\n
Note:
\n
The \"Google Assistant Unofficial Desktop Client\" is under development. So, if you find any bugs or have any suggestion, feel free to post an issue or a pull request.
\n
\n
Inspiration
\n
The design is inspired by Google Assistant in Chrome OS and comes in both Light Mode (beta) and Dark Mode 😉.
\n
\n
Getting Started
\n
In order to use the client, you must have a \"Key File\" and \"Token\" for authentication which you can get by going through Device Registration process. You can go through the wiki given below to get started.
\n
\"Setup Authentication for Google Assistant Unofficial Desktop Client\" Wiki (For both Device Registration & Authentication help):
After you have registered your device and downloaded the required authentication files, you can head on to Settings and set the \"Key File Path\" and \"Saved Tokens Path\" to the location where the respective files are located.
\n
Want to Contribute?
\n
You are more than welcome to contribute to all kinds of contributions:
\n
\n
🤔 Request/Suggest a feature
\n
🐛 Report a bug
\n
📖 Make this documentation better
\n
💻 Contribute with the code
\n
\n
Before you start, we highly recommend you check the Google Assistant Unofficial Desktop Client's contributing guidelines.
\n
How to Build?
\n
Using npm
\n\n
# Get dependencies from npm\nnpm install\n\n# Run the Assistant\nnpm start\n\n# Build the Assistant\nnpm run dist
\n
Using yarn
\n\n
# Get dependencies from npm registry\nyarn install\n\n# Run the Assistant\nyarn start\n\n# Build the Assistant\nyarn dist
\n
Download
\n
If you don't want to build the project for yourself, you can download the Assistant Setup/Installer for the respective platform from here (releases)
\n
Linux Build
\n
If you are a linux user, Snap build is recommended over AppImage. You can download the snap from snapstore.
\n
\n
Default Keyboard Shortcut
\n
\n
Windows: Win + Shift + A
\n
MacOS: Cmd + Shift + A
\n
Linux: Super + Shift + A
\n
\n
Note: Keyboard shortcut is configurable in the settings
\n
TODO
\n
\n
Set build for Mac and Linux in package.json
\n
Create Config File
\n
Remove 'auth' from the app folder
\n
Respond to \"Ok Google\" or \"Hey Google\"
\n
Activate Mic for continuousConverstion only when audio output is done
\n
Use different dependency for audio recording
\n
Improve Carousel UI Rendering in the main_area
\n
Improve Error Handling
\n
Improve Assistant Audio Output
\n
Turn off webAudio after visualization
\n
\"Enable Audio Output\" in Settings
\n
Divide Settings into sections
\n
Don't accept empty queries
\n
Info for each Setting
\n
Animation while talking
\n
Ping when activating mic
\n
Welcome screen for first-time users
\n
Display images from Google Images
\n
Option to disable auto-scaling
\n
Cleanup CSS
\n
Remove sox as a dependency
\n
\n
Other Libraries Used
\n
\n
\n
p5.js:
\n
\n
For visualization purpose when the user speaks through mic.
Google Assistant Unofficial Desktop Client is a cross-platform desktop client for Google Assistant based on Google Assistant SDK.
\n
\n
Note:
\n
The \"Google Assistant Unofficial Desktop Client\" is under development. So, if you find any bugs or have any suggestion, feel free to post an issue or a pull request.
\n
\n
Inspiration
\n
The design is inspired by Google Assistant in Chrome OS and comes in both Light Mode (beta) and Dark Mode 😉.
\n
\n
Getting Started
\n
In order to use the client, you must have a \"Key File\" and \"Token\" for authentication which you can get by going through Device Registration process. You can go through the wiki given below to get started.
\n
\"Setup Authentication for Google Assistant Unofficial Desktop Client\" Wiki (For both Device Registration & Authentication help):
After you have registered your device and downloaded the required authentication files, you can head on to Settings and set the \"Key File Path\" and \"Saved Tokens Path\" to the location where the respective files are located.
\n
Want to Contribute?
\n
You are more than welcome to contribute to all kinds of contributions:
\n
\n
🤔 Request/Suggest a feature
\n
🐛 Report a bug
\n
📖 Make this documentation better
\n
💻 Contribute with the code
\n
\n
Before you start, we highly recommend you check the Google Assistant Unofficial Desktop Client's contributing guidelines.
\n
How to Build?
\n
Using npm
\n\n
# Get dependencies from npm\nnpm install\n\n# Run the Assistant\nnpm start\n\n# Build the Assistant\nnpm run dist
\n
Using yarn
\n\n
# Get dependencies from npm registry\nyarn install\n\n# Run the Assistant\nyarn start\n\n# Build the Assistant\nyarn dist
\n
Download
\n
If you don't want to build the project for yourself, you can download the Assistant Setup/Installer for the respective platform from here (releases)
\n
Linux Build
\n
If you are a linux user, Snap build is recommended over AppImage. You can download the snap from snapstore.
\n
\n
Default Keyboard Shortcut
\n
\n
Windows: Win + Shift + A
\n
MacOS: Cmd + Shift + A
\n
Linux: Super + Shift + A
\n
\n
Note: Keyboard shortcut is configurable in the settings
\n
TODO
\n
\n
Set build for Mac and Linux in package.json
\n
Create Config File
\n
Remove 'auth' from the app folder
\n
Respond to \"Ok Google\" or \"Hey Google\"
\n
Activate Mic for continuousConverstion only when audio output is done
\n
Use different dependency for audio recording
\n
Improve Carousel UI Rendering in the main_area
\n
Improve Error Handling
\n
Improve Assistant Audio Output
\n
Turn off webAudio after visualization
\n
\"Enable Audio Output\" in Settings
\n
Divide Settings into sections
\n
Don't accept empty queries
\n
Info for each Setting
\n
Animation while talking
\n
Ping when activating mic
\n
Welcome screen for first-time users
\n
Display images from Google Images
\n
Option to disable auto-scaling
\n
Cleanup CSS
\n
Remove sox as a dependency
\n
\n
Other Libraries Used
\n
\n
\n
p5.js:
\n
\n
For visualization purpose when the user speaks through mic.
Alternately, download the binary from the Releases tab.
\n
Linux installation
\n
The graphiql-app uses the AppImage format for its Linux version. You download it from the Electron app directory (click the \"Download for Linux\"-button) or from the Releases tab.
\n
Either way, you will get a .AppImage binary. Put it in a safe place and make it executable:
\n
chmod +x graphiql-app-0.7.2-x86_64.AppImage\n
\n
Then simply execute the app. It will ask whether to add shortcuts to your desktop and menus for easy access in the future.
\n
Getting started developing
\n
\n
Branch and/or clone the repo locally.
\n
cd into it
\n
install all the require packages: npm i
\n
build the project: npm run build
\n
start the project: npm start
\n
\n
",
+ "readmeOriginal": "
GraphiQL.app
\n
\n
A light, Electron-based wrapper around GraphiQL.
\n
Provides a tabbed interface for editing and testing GraphQL queries/mutations with GraphiQL.
Alternately, download the binary from the Releases tab.
\n
Linux installation
\n
The graphiql-app uses the AppImage format for its Linux version. You download it from the Electron app directory (click the \"Download for Linux\"-button) or from the Releases tab.
\n
Either way, you will get a .AppImage binary. Put it in a safe place and make it executable:
\n
chmod +x graphiql-app-0.7.2-x86_64.AppImage\n
\n
Then simply execute the app. It will ask whether to add shortcuts to your desktop and menus for easy access in the future.
This desktop app is just a wrapper which starts a chromium instance locally and runs the actual web-app in it. All\nrights to the Google Chat product is reserved by\nGoogle Inc.\nThis desktop client has no way to access none of your data.
This desktop app is just a wrapper which starts a chromium instance locally and runs the actual web-app in it. All\nrights to the Google Chat product is reserved by\nGoogle Inc.\nThis desktop client has no way to access none of your data.
Alternately, download the binary from the Releases tab.
\n
Linux installation
\n
The graphiql-app uses the AppImage format for its Linux version. You download it from the Electron app directory (click the \"Download for Linux\"-button) or from the Releases tab.
\n
Either way, you will get a .AppImage binary. Put it in a safe place and make it executable:
\n
chmod +x graphiql-app-0.7.2-x86_64.AppImage\n
\n
Then simply execute the app. It will ask whether to add shortcuts to your desktop and menus for easy access in the future.
\n
Getting started developing
\n
\n
Branch and/or clone the repo locally.
\n
cd into it
\n
install all the require packages: npm i
\n
build the project: npm run build
\n
start the project: npm start
\n
\n
",
- "readmeOriginal": "
GraphiQL.app
\n
\n
A light, Electron-based wrapper around GraphiQL.
\n
Provides a tabbed interface for editing and testing GraphQL queries/mutations with GraphiQL.
Alternately, download the binary from the Releases tab.
\n
Linux installation
\n
The graphiql-app uses the AppImage format for its Linux version. You download it from the Electron app directory (click the \"Download for Linux\"-button) or from the Releases tab.
\n
Either way, you will get a .AppImage binary. Put it in a safe place and make it executable:
\n
chmod +x graphiql-app-0.7.2-x86_64.AppImage\n
\n
Then simply execute the app. It will ask whether to add shortcuts to your desktop and menus for easy access in the future.
Run \"Google Play Music\" as a standalone desktop app. Never again will you have to hunt through your tabs to pause your music, or stop listening to your favourite song because Chrome is guzzling up all your RAM. Now also has YouTube Music player fully integrated.
Both are documented in the Docs folder. For one time read access you should\nprobably use the JSON interface. For an application that requires continuous\nupdates as to the state of GPMDP or needs to control GPMDP you should use the\nWeb Socket interface.
\n
Issues
\n
If you have any bugs / issues please check the\nFAQ\nfirst before raising an issue
To get started just pull the repo and run the following
\n
npm install\nnpm run build\nnpm start
\n
To build the installers / release packages you need to run, you can only build a platforms installer from that platform.
\n
# Windows\nnpm run make:win\n\n# Mac OS X\nnpm run make:darwin\n\n# Ubuntu (Requires the 'dpkg' package)\nnpm run make:deb\n\n# Fedora (Requires the 'rpm' package)\nnpm run make:rpm
\n
All releases will be signing with my Code Signing Certificates (Authenticode on Windows and Codesign on OS X)
\n
Please see the development FAQ for additional requirements for building.
\n
Contributing
\n
If you find something wrong (theming issues, app crashes) please report them as an issue. \nIf you think you can add something cool or fix a problem, fork the repo and make a pull request :D
\n
NOTE: Some of the functionality in this app has been extracted into smaller submodules. In particular
You can download the latest signed installers for Windows from the artifacts section of AppVeyor \nYou can download the latest linux (debian and fedora) and OS X (darwin) builds from the artifacts section on Circle CI
\n
License
\n
The MIT License (MIT)
\n
Copyright (c) 2016 Samuel Attard
\n
Permission is hereby granted, free of charge, to any person obtaining a copy of\nthis software and associated documentation files (the \"Software\"), to deal in\nthe Software without restriction, including without limitation the rights to\nuse, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of\nthe Software, and to permit persons to whom the Software is furnished to do so,\nsubject to the following conditions:
\n
The above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.
\n
THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS\nFOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR\nCOPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER\nIN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN\nCONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
\n
",
+ "readmeOriginal": "
Google Play Music™ Desktop Player
\n
\n\n\n\n\n\n \nWindows: \nMacOS / Linux:
\n
\n
Run \"Google Play Music\" as a standalone desktop app. Never again will you have to hunt through your tabs to pause your music, or stop listening to your favourite song because Chrome is guzzling up all your RAM. Now also has YouTube Music player fully integrated.
Both are documented in the Docs folder. For one time read access you should\nprobably use the JSON interface. For an application that requires continuous\nupdates as to the state of GPMDP or needs to control GPMDP you should use the\nWeb Socket interface.
\n
Issues
\n
If you have any bugs / issues please check the\nFAQ\nfirst before raising an issue
To get started just pull the repo and run the following
\n
npm install\nnpm run build\nnpm start
\n
To build the installers / release packages you need to run, you can only build a platforms installer from that platform.
\n
# Windows\nnpm run make:win\n\n# Mac OS X\nnpm run make:darwin\n\n# Ubuntu (Requires the 'dpkg' package)\nnpm run make:deb\n\n# Fedora (Requires the 'rpm' package)\nnpm run make:rpm
\n
All releases will be signing with my Code Signing Certificates (Authenticode on Windows and Codesign on OS X)
\n
Please see the development FAQ for additional requirements for building.
\n
Contributing
\n
If you find something wrong (theming issues, app crashes) please report them as an issue. \nIf you think you can add something cool or fix a problem, fork the repo and make a pull request :D
\n
NOTE: Some of the functionality in this app has been extracted into smaller submodules. In particular
You can download the latest signed installers for Windows from the artifacts section of AppVeyor \nYou can download the latest linux (debian and fedora) and OS X (darwin) builds from the artifacts section on Circle CI
\n
License
\n
The MIT License (MIT)
\n
Copyright (c) 2016 Samuel Attard
\n
Permission is hereby granted, free of charge, to any person obtaining a copy of\nthis software and associated documentation files (the \"Software\"), to deal in\nthe Software without restriction, including without limitation the rights to\nuse, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of\nthe Software, and to permit persons to whom the Software is furnished to do so,\nsubject to the following conditions:
\n
The above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.
\n
THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS\nFOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR\nCOPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER\nIN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN\nCONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Graviton is a open source, cross-platform, minimalist-looking code editor.
\n
You can download it for Windows, MacOS, and GNU/Linux from Graviton's Website, or try the experimentalOnline Version.\nYou can also download weekly (probably unstable) releases from the Releases section.
\n
\n
✨ Features
\n
NOTE:\nSome of these features may not be released as an official build yet, but they are already implemented in the source code.
Graviton is a open source, cross-platform, minimalist-looking code editor.
\n
You can download it for Windows, MacOS, and GNU/Linux from Graviton's Website, or try the experimentalOnline Version.\nYou can also download weekly (probably unstable) releases from the Releases section.
\n
\n
✨ Features
\n
NOTE:\nSome of these features may not be released as an official build yet, but they are already implemented in the source code.
Note: The primary maintainer @acao is on hiatus until December 2020
\n
\n
\n
SECURITY WARNING: both graphql-playground-html and all four (4) of it's middleware dependents until graphql-playground-html@1.6.22 were subject to an XSS Reflection attack vulnerability only to unsanitized user input strings to the functions therein. This was resolved in graphql-playground-html@^1.6.22. More InformationCVE-2020-4038
⚙ GraphQL Config support with multiple Projects & Endpoints
\n
🚥 Apollo Tracing support
\n
\n
Security Details
\n
\n
NOTE: only unsanitized user input to the functions in these packages is vulnerable to the recently reported XSS Reflection attack.
\n
\n
Impact
\n
\n
Impacted are any and all unsanitized user-defined input to:\n-renderPlaygroundPage()\n-koaPlayground()\n-expressPlayground()\n-koaPlayground()\n-`lambdaPlayground()
\n
\n
\n
If you used static values, such as graphql-playground-electron does in it's webpack config, as well as the most common middleware implementations out there, they were not vulnerable to the attack.
\n
\n
The only reason this vulnerability exists is because we are using template strings in renderPlaygroundPage() with potentially unsanitized user defined variables. This allows an attacker to inject html and javascript into the page.
Common examples may be user-defined path parameters, query string, unsanitized UI provided values in database, etc., that are used to build template strings or passed directly to a renderPlaygroundPage() or the matching middleware function equivalent listed above.
\n
Impacted Packages
\n
All versions of these packages are impacted until the ones specified below, which are now safe for user defined input:
\n
\n
graphql-playground-html: ☔ safe @ 1.6.22
\n
graphql-playground-express☔ safe @ 1.7.16
\n
graphql-playground-koa☔ safe @ 1.6.15
\n
graphql-playground-hapi☔ safe @ 1.6.13
\n
graphql-playground-lambda☔ safe @ 1.7.17
\n
graphql-playground-electron has always been ☔ safe from XSS attacks! This is because configuration is statically defined it's webpack config
\n
graphql-playground-react is safe because it does not use renderPlaygroundPage() anywhere, and thus is not susceptible to template string XSS reflection attacks.
\n
\n
More Information
\n
See the security docs for more details on how your implementation might be impacted by this vulnerability. It contains safe examples, unsafe examples, workarounds, and more details.
\n
We've also provided 'an example of the xss using the express middleware
GraphQL Playground uses components of GraphiQL under the hood but is meant as a more powerful GraphQL IDE enabling better (local) development workflows. Compared to GraphiQL, the GraphQL Playground ships with the following additional features:
\n
\n
Interactive, multi-column schema documentation
\n
Automatic schema reloading
\n
Support for GraphQL Subscriptions
\n
Query history
\n
Configuration of HTTP headers
\n
Tabs
\n
\n
See the following question for more additonal features.
\n
What's the difference between the desktop app and the web version?
\n
The desktop app is the same as the web version but includes these additional features:
\n
\n
Partial support for graphql-config enabling features like multi-environment setups (no support for sending HTTP headers).
\n
Double click on *.graphql files.
\n
\n
How does GraphQL Bin work?
\n
You can easily share your Playgrounds with others by clicking on the \"Share\" button and sharing the generated link. You can think about GraphQL Bin like Pastebin for your GraphQL queries including the context (endpoint, HTTP headers, open tabs etc).
schemaIntrospectionResult - The result of an introspection query (an object of this form: {__schema: {...}}) The playground automatically fetches the schema from the endpoint. This is only needed when you want to override the schema.
\n
tabsTab[] - An array of tabs to inject. Note: When using this feature, tabs will be resetted each time the page is reloaded
In addition to this, the React app provides some more properties:
\n
\n
props (React Component)
\n
createApolloLink [(session: Session, subscriptionEndpoint?: string) => ApolloLink] - this is the equivalent to the fetcher of GraphiQL. For each query that is being executed, this function will be called
\n
\n
createApolloLink is only available in the React Component and not the middlewares, because the content must be serializable as it is being printed into a HTML template.
\n
As HTML Page
\n
If you simply want to render the Playground HTML on your own, for example when implementing a GraphQL Server, there are 2 options for you:
Note: In case you do not want to serve assets from a CDN (like jsDelivr) and instead use a local copy, you will need to install graphql-playground-react from npm, and then replace all instances of //cdn.jsdelivr.net/npm with ./node_modules. An example can be found here
\n
As React Component
\n
Install
\n
yarn add graphql-playground-react
\n
Use
\n
GraphQL Playground provides a React component responsible for rendering the UI and Session management.\nThere are 3 dependencies needed in order to run the graphql-playground-react React component.
# Pick the one that matches your server framework\nyarn add graphql-playground-middleware-express # for Express or Connect\nyarn add graphql-playground-middleware-hapi\nyarn add graphql-playground-middleware-koa\nyarn add graphql-playground-middleware-lambda
\n
Usage with example
\n
We have a full example for each of the frameworks below:
To initiate the signature process please open a PR against this repo. The EasyCLA bot will block the merge if we still need a membership agreement from you.
If your company benefits from GraphQL and you would like to provide essential financial support for the systems and people that power our community, please also consider membership in the GraphQL Foundation.
\n
Custom Theme
\n
From graphql-playground-react@1.7.0 on you can provide a codeTheme property to the React Component to customize your color theme.\nThese are the available options:
This is repository is a \"mono repo\" and contains multiple packages using Yarn workspaces. Please be aware that versions are not synchronised between packages. The versions of the release page refer to the electron app.
\n
Packages
\n
In the folder packages you'll find the following packages:
\n
\n
graphql-playground-electron: Cross-platform electron app which uses graphql-playground-react
\n
graphql-playground-html: Simple HTML page rendering a version of graphql-playground-react hosted on JSDeliver
\n
graphql-playground-middleware-express: Express middleware using graphql-playground-html
\n
graphql-playground-middleware-hapi: Hapi middleware using graphql-playground-html
\n
graphql-playground-middleware-koa: Koa middleware using graphql-playground-html
\n
graphql-playground-middleware-lambda: AWS Lambda middleware using graphql-playground-html
\n
graphql-playground-react: Core of GraphQL Playground built with ReactJS
Join our Discord Server if you run into issues or have questions. We love talking to you!
\n
\n
",
- "readmeOriginal": "
\n
Note: The primary maintainer @acao is on hiatus until December 2020
\n
\n
\n
SECURITY WARNING: both graphql-playground-html and all four (4) of it's middleware dependents until graphql-playground-html@1.6.22 were subject to an XSS Reflection attack vulnerability only to unsanitized user input strings to the functions therein. This was resolved in graphql-playground-html@^1.6.22. More InformationCVE-2020-4038
⚙ GraphQL Config support with multiple Projects & Endpoints
\n
🚥 Apollo Tracing support
\n
\n
Security Details
\n
\n
NOTE: only unsanitized user input to the functions in these packages is vulnerable to the recently reported XSS Reflection attack.
\n
\n
Impact
\n
\n
Impacted are any and all unsanitized user-defined input to:\n-renderPlaygroundPage()\n-koaPlayground()\n-expressPlayground()\n-koaPlayground()\n-`lambdaPlayground()
\n
\n
\n
If you used static values, such as graphql-playground-electron does in it's webpack config, as well as the most common middleware implementations out there, they were not vulnerable to the attack.
\n
\n
The only reason this vulnerability exists is because we are using template strings in renderPlaygroundPage() with potentially unsanitized user defined variables. This allows an attacker to inject html and javascript into the page.
Common examples may be user-defined path parameters, query string, unsanitized UI provided values in database, etc., that are used to build template strings or passed directly to a renderPlaygroundPage() or the matching middleware function equivalent listed above.
\n
Impacted Packages
\n
All versions of these packages are impacted until the ones specified below, which are now safe for user defined input:
\n
\n
graphql-playground-html: ☔ safe @ 1.6.22
\n
graphql-playground-express☔ safe @ 1.7.16
\n
graphql-playground-koa☔ safe @ 1.6.15
\n
graphql-playground-hapi☔ safe @ 1.6.13
\n
graphql-playground-lambda☔ safe @ 1.7.17
\n
graphql-playground-electron has always been ☔ safe from XSS attacks! This is because configuration is statically defined it's webpack config
\n
graphql-playground-react is safe because it does not use renderPlaygroundPage() anywhere, and thus is not susceptible to template string XSS reflection attacks.
\n
\n
More Information
\n
See the security docs for more details on how your implementation might be impacted by this vulnerability. It contains safe examples, unsafe examples, workarounds, and more details.
\n
We've also provided 'an example of the xss using the express middleware
GraphQL Playground uses components of GraphiQL under the hood but is meant as a more powerful GraphQL IDE enabling better (local) development workflows. Compared to GraphiQL, the GraphQL Playground ships with the following additional features:
\n
\n
Interactive, multi-column schema documentation
\n
Automatic schema reloading
\n
Support for GraphQL Subscriptions
\n
Query history
\n
Configuration of HTTP headers
\n
Tabs
\n
\n
See the following question for more additonal features.
\n
What's the difference between the desktop app and the web version?
\n
The desktop app is the same as the web version but includes these additional features:
\n
\n
Partial support for graphql-config enabling features like multi-environment setups (no support for sending HTTP headers).
\n
Double click on *.graphql files.
\n
\n
How does GraphQL Bin work?
\n
You can easily share your Playgrounds with others by clicking on the \"Share\" button and sharing the generated link. You can think about GraphQL Bin like Pastebin for your GraphQL queries including the context (endpoint, HTTP headers, open tabs etc).
schemaIntrospectionResult - The result of an introspection query (an object of this form: {__schema: {...}}) The playground automatically fetches the schema from the endpoint. This is only needed when you want to override the schema.
\n
tabsTab[] - An array of tabs to inject. Note: When using this feature, tabs will be resetted each time the page is reloaded
In addition to this, the React app provides some more properties:
\n
\n
props (React Component)
\n
createApolloLink [(session: Session, subscriptionEndpoint?: string) => ApolloLink] - this is the equivalent to the fetcher of GraphiQL. For each query that is being executed, this function will be called
\n
\n
createApolloLink is only available in the React Component and not the middlewares, because the content must be serializable as it is being printed into a HTML template.
\n
As HTML Page
\n
If you simply want to render the Playground HTML on your own, for example when implementing a GraphQL Server, there are 2 options for you:
Note: In case you do not want to serve assets from a CDN (like jsDelivr) and instead use a local copy, you will need to install graphql-playground-react from npm, and then replace all instances of //cdn.jsdelivr.net/npm with ./node_modules. An example can be found here
\n
As React Component
\n
Install
\n
yarn add graphql-playground-react
\n
Use
\n
GraphQL Playground provides a React component responsible for rendering the UI and Session management.\nThere are 3 dependencies needed in order to run the graphql-playground-react React component.
# Pick the one that matches your server framework\nyarn add graphql-playground-middleware-express # for Express or Connect\nyarn add graphql-playground-middleware-hapi\nyarn add graphql-playground-middleware-koa\nyarn add graphql-playground-middleware-lambda
\n
Usage with example
\n
We have a full example for each of the frameworks below:
To initiate the signature process please open a PR against this repo. The EasyCLA bot will block the merge if we still need a membership agreement from you.
If your company benefits from GraphQL and you would like to provide essential financial support for the systems and people that power our community, please also consider membership in the GraphQL Foundation.
\n
Custom Theme
\n
From graphql-playground-react@1.7.0 on you can provide a codeTheme property to the React Component to customize your color theme.\nThese are the available options:
This is repository is a \"mono repo\" and contains multiple packages using Yarn workspaces. Please be aware that versions are not synchronised between packages. The versions of the release page refer to the electron app.
\n
Packages
\n
In the folder packages you'll find the following packages:
\n
\n
graphql-playground-electron: Cross-platform electron app which uses graphql-playground-react
\n
graphql-playground-html: Simple HTML page rendering a version of graphql-playground-react hosted on JSDeliver
\n
graphql-playground-middleware-express: Express middleware using graphql-playground-html
\n
graphql-playground-middleware-hapi: Hapi middleware using graphql-playground-html
\n
graphql-playground-middleware-koa: Koa middleware using graphql-playground-html
\n
graphql-playground-middleware-lambda: AWS Lambda middleware using graphql-playground-html
\n
graphql-playground-react: Core of GraphQL Playground built with ReactJS
Meet gSubs. A desktop app that finds you the perfect subtitle match for your videos. Simply download now and drag and drop videos to get started.\n gSubs is multi-platform, open-source, and built entirely on web technology.
The following features made what gSubs is today and many more features will be, hopefully added with the support of great open source community in the future.\n \n
\n
Drag & Drop
\n
Just drag and drop the video files that you want to search subtitle for and gSubs will do it's job. No more browsing and selecting videos from the mysteries directories that you don't know.
\n
Multiple Files
\n
gSubs supports multiple files input, meaning you can drag and drop as many files as you want and gSubs will find subtitles for each and every file. You have an entire season with dozen of episodes? gSubs gets your subtitles for the entire season in one time.
\n
Search Subtitles
\n
You don't have a video file but just want to donwload your favourite movies or series subtitles? Don't worry, gSubs consists of the search function where you can input any queries for search. gSubs will give you the results according to the language that has been set.
\n
10 Languages
\n
gSubs are capable of finding you subtitles for 10 languages which are English, Español, Français, Italiano, Nederlands, Polski, Português, Român, Svenska and Türkçe. Many more languages will be added soon.
\n
Auto Update
\n
gSubs have auto update feature included in it. This means you don't have to manually download the latest release every time. gSubs downloads and installs the latest release automatically.
\n \n
⚡️ Contributing
\n
gSubs is completely open-source. If you'd like to help out by adding features, working on bug fixes,\nor assisting in other parts of development, here's how to get started:
Clone it to your\nlocal device: git clone git@github.com:sanjevirau/gsubs.git
\n
Install the dependencies: npm install
\n
Run the app by starting electron, building the code and watch for changes:\nnpm start\n
To build for production (should not generally be used):
\n
\n
Build the actual app for Windows: npm run dist
\n
gSubs can also be build into Mac and Linux by change the dist script to build -wlm --config in the package.json file and then building the app using npm run dist
\n\n
We does give you credits for your contributions. Every contributors name will be shown in our contributors page at gSubs Contributors.
\n \n
📦 Sources
\n
gSubs currently uses 2 sources to gather subtitles. When user drag and drop the video files, gSubs looks into SubDB source first followed by OpenSubtitles source. We hope to add more sources in the future.
\n
Standard sources:
\n
\n
SubDB
\n
OpenSubtitles
\n
Addic7ed
\n
\n \n
🌟 Special Thanks
\n
We would like to thank the following great beings and projects for assisting and giving us the motivation to build gSubs directly or indirectly.
Meet gSubs. A desktop app that finds you the perfect subtitle match for your videos. Simply download now and drag and drop videos to get started.\n gSubs is multi-platform, open-source, and built entirely on web technology.
The following features made what gSubs is today and many more features will be, hopefully added with the support of great open source community in the future.\n \n
\n
Drag & Drop
\n
Just drag and drop the video files that you want to search subtitle for and gSubs will do it's job. No more browsing and selecting videos from the mysteries directories that you don't know.
\n
Multiple Files
\n
gSubs supports multiple files input, meaning you can drag and drop as many files as you want and gSubs will find subtitles for each and every file. You have an entire season with dozen of episodes? gSubs gets your subtitles for the entire season in one time.
\n
Search Subtitles
\n
You don't have a video file but just want to donwload your favourite movies or series subtitles? Don't worry, gSubs consists of the search function where you can input any queries for search. gSubs will give you the results according to the language that has been set.
\n
10 Languages
\n
gSubs are capable of finding you subtitles for 10 languages which are English, Español, Français, Italiano, Nederlands, Polski, Português, Român, Svenska and Türkçe. Many more languages will be added soon.
\n
Auto Update
\n
gSubs have auto update feature included in it. This means you don't have to manually download the latest release every time. gSubs downloads and installs the latest release automatically.
\n \n
⚡️ Contributing
\n
gSubs is completely open-source. If you'd like to help out by adding features, working on bug fixes,\nor assisting in other parts of development, here's how to get started:
Clone it to your\nlocal device: git clone git@github.com:sanjevirau/gsubs.git
\n
Install the dependencies: npm install
\n
Run the app by starting electron, building the code and watch for changes:\nnpm start\n
To build for production (should not generally be used):
\n
\n
Build the actual app for Windows: npm run dist
\n
gSubs can also be build into Mac and Linux by change the dist script to build -wlm --config in the package.json file and then building the app using npm run dist
\n\n
We does give you credits for your contributions. Every contributors name will be shown in our contributors page at gSubs Contributors.
\n \n
📦 Sources
\n
gSubs currently uses 2 sources to gather subtitles. When user drag and drop the video files, gSubs looks into SubDB source first followed by OpenSubtitles source. We hope to add more sources in the future.
\n
Standard sources:
\n
\n
SubDB
\n
OpenSubtitles
\n
Addic7ed
\n
\n \n
🌟 Special Thanks
\n
We would like to thank the following great beings and projects for assisting and giving us the motivation to build gSubs directly or indirectly.
An endless 2D jumping game, select a avatar, choose a environment and start playing. Dont fall off the platforms and dont hit the spike balls!
\n
How to Play/ Build
\n
1. Play the game
\n
Download the game from here . Start the application and and then follow the instructions below to start playing. Try to score as many points as you can!
\n
2. Building from the repo
\n
Clone the repository, then navigate to it on your terminal and run npm install, once all the dependencies have finished downloading, run npm start to test it, and npm run dist to build it for your platform.
\n
Instructions
\n
\n
Select your environment, cycle through the 3 available ones by hitting spacebar.
\n
Click on a avatar to begin.
\n
Use the left and right arrow keys to move on the platforms.
\n
Press the up key to jump
\n
Dont fall below the screen, and dont hit the Spike Balls
\n
\n
If you liked this, check out My colaborative task app, where you can create groups with your team and make to-dos and task lists
The game assets including the background and the tiles were made by Kenny, the character sprites were made by MadFireOn, and the idea for the game was inspired by a tutorial from Joshmorony.
\n
",
- "readmeOriginal": "
\nHasty Heroes \n
\n
\n\n\n\n
\n
An endless 2D jumping game, select a avatar, choose a environment and start playing. Dont fall off the platforms and dont hit the spike balls!
\n
How to Play/ Build
\n
1. Play the game
\n
Download the game from here . Start the application and and then follow the instructions below to start playing. Try to score as many points as you can!
\n
2. Building from the repo
\n
Clone the repository, then navigate to it on your terminal and run npm install, once all the dependencies have finished downloading, run npm start to test it, and npm run dist to build it for your platform.
\n
Instructions
\n
\n
Select your environment, cycle through the 3 available ones by hitting spacebar.
\n
Click on a avatar to begin.
\n
Use the left and right arrow keys to move on the platforms.
\n
Press the up key to jump
\n
Dont fall below the screen, and dont hit the Spike Balls
\n
\n
If you liked this, check out My colaborative task app, where you can create groups with your team and make to-dos and task lists
The game assets including the background and the tiles were made by Kenny, the character sprites were made by MadFireOn, and the idea for the game was inspired by a tutorial from Joshmorony.
Collect and share information about your computer's hardware. Example paste with info - go to link
\n
changelog
\n
0.1.0 - Remove \"open\" module because of its associated vulnerability (https://nodesecurity.io/advisories/663), update all modules, update electron to latest stable version, other small fix
Collect and share information about your computer's hardware. Example paste with info - go to link
\n
changelog
\n
0.1.0 - Remove \"open\" module because of its associated vulnerability (https://nodesecurity.io/advisories/663), update all modules, update electron to latest stable version, other small fix
A free GUI application for HandBrake and FFmpeg/FFprobe on Windows, macOS and Linux (+ Linux Docker image) with an emphasis on multi HandBrake/FFmpeg instance batch conversion (including recursive folder scans and folder watching). The destination folder structure is kept the same as the source folder structure. Media in subfolders is also converted. Multiple folders can be monitored and different conversion presets can be specified for each folder. Also included:
\n
-Remote monitoring feature to monitor batch file conversions in any browser
\n
-Basic h265 benchmarking
\n
-Health check feature which can scan for corrupt video files using HandBrake (quick scan) or FFmpeg (thorough scan), although this is not always accurate. Attempt repair file feature included too.
\n
This is a standalone program on Windows but requires HandBrakeCLI to be installed on Linux and Mac. For a server application with similar functionality please see Tdarr.
\n
Settings help is available by pressing the blue ? diamond icons spread throughout the program:
\n
\n
The program scans the source folders for all files. It then compares the source folder files with the destination folder files to see if any of the source files exist in the destination folder already. If not, the program queues the files for conversion.
\n
4 worker modules (default number) then work through the conversion queue. If periodic scanning is enabled then the program will run at the chosen interval.
\n
After it a bit more testing it seems that weird things can happen if you monitor a folder which is being downloaded to. It seems sometimes conversions start before a file has fully downloaded. To solve this, I recommend using a temporary download folder before moving completed files into your HBBB source folder.
\n
If you use a download program which has an 'incomplete downloads' folder etc, do not put that folder inside your main source folder else you may end up converting each file twice.
\n
The program won't work properly if you put the destination folder in a folder inside the source folder because the program is recreating the source folder structure inside the destination folder. It will cause an infinite loop of creating more and more sub-folders each time you run the program. So it will NOT work properly if you do something like this:
\n
Source:
\n
D:\\Videos
\n
Destination:
\n
D:\\Videos\\Converted
\n
It will work properly if you do something like this etc:
\n
Source:
\n
D:\\Videos
\n
Destination:
\n
D:\\Converted
\n
",
- "readmeOriginal": "
HBBatchBeast for HandBrake and FFmpeg/FFprobe (Windows, macOS, Linux & Docker)
A free GUI application for HandBrake and FFmpeg/FFprobe on Windows, macOS and Linux (+ Linux Docker image) with an emphasis on multi HandBrake/FFmpeg instance batch conversion (including recursive folder scans and folder watching). The destination folder structure is kept the same as the source folder structure. Media in subfolders is also converted. Multiple folders can be monitored and different conversion presets can be specified for each folder. Also included:
\n
-Remote monitoring feature to monitor batch file conversions in any browser
\n
-Basic h265 benchmarking
\n
-Health check feature which can scan for corrupt video files using HandBrake (quick scan) or FFmpeg (thorough scan), although this is not always accurate. Attempt repair file feature included too.
\n
This is a standalone program on Windows but requires HandBrakeCLI to be installed on Linux and Mac. For a server application with similar functionality please see Tdarr.
\n
Settings help is available by pressing the blue ? diamond icons spread throughout the program:
\n
\n
The program scans the source folders for all files. It then compares the source folder files with the destination folder files to see if any of the source files exist in the destination folder already. If not, the program queues the files for conversion.
\n
4 worker modules (default number) then work through the conversion queue. If periodic scanning is enabled then the program will run at the chosen interval.
\n
After it a bit more testing it seems that weird things can happen if you monitor a folder which is being downloaded to. It seems sometimes conversions start before a file has fully downloaded. To solve this, I recommend using a temporary download folder before moving completed files into your HBBB source folder.
\n
If you use a download program which has an 'incomplete downloads' folder etc, do not put that folder inside your main source folder else you may end up converting each file twice.
\n
The program won't work properly if you put the destination folder in a folder inside the source folder because the program is recreating the source folder structure inside the destination folder. It will cause an infinite loop of creating more and more sub-folders each time you run the program. So it will NOT work properly if you do something like this:
\n
Source:
\n
D:\\Videos
\n
Destination:
\n
D:\\Videos\\Converted
\n
It will work properly if you do something like this etc:
HashTag is a minimalist mirosoftware that hash some text. This application should mainly be used by developers who want to quickly hash something. It can also keep in memory your previous hashes in order to save some time during your development process. Currently, their are 3 algorithms : MD5, SHA-256 and Bcrypt.
\n
Installation
\n
⚠️ Currently, this software is only available for Windows (Linux and MacOS are not supported) \n \nYou can either download it from GitHub using the latest realese, from the Electron apps website or from the Softpedia website.\n \nOnce done, double click on HashTag.exe and it be ready to use.
\n
Run HashTag locally
\n\n
Clone the repository
\n\n
$ git clone https://github.com/MrAnyx/HashTag.git
\n \n\n
Install the dependencies
\n\n
$ npm install
\n \n\n
Run the application
\n\n
$ npm start
\n \n\n
Build the application
\n\n
$ npm run build
\n
Issue
\n
If you find a security issue or any other kind of issue, feel free to create an issue by clicking here.\nSame thing for the pull requests and feature requests.
If you like this project or if you want to support me, you can simply smash the like button, just to let me know.
\n
Preview
\n
\n \n
\n
\n \n
\n
License
\n
Currently, this project is under the GPL-3.0 license.
\n
",
+ "readmeOriginal": "
\n \n
\n
Overview
\n
HashTag is a minimalist mirosoftware that hash some text. This application should mainly be used by developers who want to quickly hash something. It can also keep in memory your previous hashes in order to save some time during your development process. Currently, their are 3 algorithms : MD5, SHA-256 and Bcrypt.
\n
Installation
\n
⚠️ Currently, this software is only available for Windows (Linux and MacOS are not supported) \n \nYou can either download it from GitHub using the latest realese, from the Electron apps website or from the Softpedia website.\n \nOnce done, double click on HashTag.exe and it be ready to use.
\n
Run HashTag locally
\n\n
Clone the repository
\n\n
$ git clone https://github.com/MrAnyx/HashTag.git
\n \n\n
Install the dependencies
\n\n
$ npm install
\n \n\n
Run the application
\n\n
$ npm start
\n \n\n
Build the application
\n\n
$ npm run build
\n
Issue
\n
If you find a security issue or any other kind of issue, feel free to create an issue by clicking here.\nSame thing for the pull requests and feature requests.
An endless 2D jumping game, select a avatar, choose a environment and start playing. Dont fall off the platforms and dont hit the spike balls!
\n
How to Play/ Build
\n
1. Play the game
\n
Download the game from here . Start the application and and then follow the instructions below to start playing. Try to score as many points as you can!
\n
2. Building from the repo
\n
Clone the repository, then navigate to it on your terminal and run npm install, once all the dependencies have finished downloading, run npm start to test it, and npm run dist to build it for your platform.
\n
Instructions
\n
\n
Select your environment, cycle through the 3 available ones by hitting spacebar.
\n
Click on a avatar to begin.
\n
Use the left and right arrow keys to move on the platforms.
\n
Press the up key to jump
\n
Dont fall below the screen, and dont hit the Spike Balls
\n
\n
If you liked this, check out My colaborative task app, where you can create groups with your team and make to-dos and task lists
The game assets including the background and the tiles were made by Kenny, the character sprites were made by MadFireOn, and the idea for the game was inspired by a tutorial from Joshmorony.
\n
",
+ "readmeOriginal": "
\nHasty Heroes \n
\n
\n\n\n\n
\n
An endless 2D jumping game, select a avatar, choose a environment and start playing. Dont fall off the platforms and dont hit the spike balls!
\n
How to Play/ Build
\n
1. Play the game
\n
Download the game from here . Start the application and and then follow the instructions below to start playing. Try to score as many points as you can!
\n
2. Building from the repo
\n
Clone the repository, then navigate to it on your terminal and run npm install, once all the dependencies have finished downloading, run npm start to test it, and npm run dist to build it for your platform.
\n
Instructions
\n
\n
Select your environment, cycle through the 3 available ones by hitting spacebar.
\n
Click on a avatar to begin.
\n
Use the left and right arrow keys to move on the platforms.
\n
Press the up key to jump
\n
Dont fall below the screen, and dont hit the Spike Balls
\n
\n
If you liked this, check out My colaborative task app, where you can create groups with your team and make to-dos and task lists
The game assets including the background and the tiles were made by Kenny, the character sprites were made by MadFireOn, and the idea for the game was inspired by a tutorial from Joshmorony.
Note: The primary maintainer @acao is on hiatus until December 2020
\n
\n
\n
SECURITY WARNING: both graphql-playground-html and all four (4) of it's middleware dependents until graphql-playground-html@1.6.22 were subject to an XSS Reflection attack vulnerability only to unsanitized user input strings to the functions therein. This was resolved in graphql-playground-html@^1.6.22. More InformationCVE-2020-4038
⚙ GraphQL Config support with multiple Projects & Endpoints
\n
🚥 Apollo Tracing support
\n
\n
Security Details
\n
\n
NOTE: only unsanitized user input to the functions in these packages is vulnerable to the recently reported XSS Reflection attack.
\n
\n
Impact
\n
\n
Impacted are any and all unsanitized user-defined input to:\n-renderPlaygroundPage()\n-koaPlayground()\n-expressPlayground()\n-koaPlayground()\n-`lambdaPlayground()
\n
\n
\n
If you used static values, such as graphql-playground-electron does in it's webpack config, as well as the most common middleware implementations out there, they were not vulnerable to the attack.
\n
\n
The only reason this vulnerability exists is because we are using template strings in renderPlaygroundPage() with potentially unsanitized user defined variables. This allows an attacker to inject html and javascript into the page.
Common examples may be user-defined path parameters, query string, unsanitized UI provided values in database, etc., that are used to build template strings or passed directly to a renderPlaygroundPage() or the matching middleware function equivalent listed above.
\n
Impacted Packages
\n
All versions of these packages are impacted until the ones specified below, which are now safe for user defined input:
\n
\n
graphql-playground-html: ☔ safe @ 1.6.22
\n
graphql-playground-express☔ safe @ 1.7.16
\n
graphql-playground-koa☔ safe @ 1.6.15
\n
graphql-playground-hapi☔ safe @ 1.6.13
\n
graphql-playground-lambda☔ safe @ 1.7.17
\n
graphql-playground-electron has always been ☔ safe from XSS attacks! This is because configuration is statically defined it's webpack config
\n
graphql-playground-react is safe because it does not use renderPlaygroundPage() anywhere, and thus is not susceptible to template string XSS reflection attacks.
\n
\n
More Information
\n
See the security docs for more details on how your implementation might be impacted by this vulnerability. It contains safe examples, unsafe examples, workarounds, and more details.
\n
We've also provided 'an example of the xss using the express middleware
GraphQL Playground uses components of GraphiQL under the hood but is meant as a more powerful GraphQL IDE enabling better (local) development workflows. Compared to GraphiQL, the GraphQL Playground ships with the following additional features:
\n
\n
Interactive, multi-column schema documentation
\n
Automatic schema reloading
\n
Support for GraphQL Subscriptions
\n
Query history
\n
Configuration of HTTP headers
\n
Tabs
\n
\n
See the following question for more additonal features.
\n
What's the difference between the desktop app and the web version?
\n
The desktop app is the same as the web version but includes these additional features:
\n
\n
Partial support for graphql-config enabling features like multi-environment setups (no support for sending HTTP headers).
\n
Double click on *.graphql files.
\n
\n
How does GraphQL Bin work?
\n
You can easily share your Playgrounds with others by clicking on the \"Share\" button and sharing the generated link. You can think about GraphQL Bin like Pastebin for your GraphQL queries including the context (endpoint, HTTP headers, open tabs etc).
schemaIntrospectionResult - The result of an introspection query (an object of this form: {__schema: {...}}) The playground automatically fetches the schema from the endpoint. This is only needed when you want to override the schema.
\n
tabsTab[] - An array of tabs to inject. Note: When using this feature, tabs will be resetted each time the page is reloaded
In addition to this, the React app provides some more properties:
\n
\n
props (React Component)
\n
createApolloLink [(session: Session, subscriptionEndpoint?: string) => ApolloLink] - this is the equivalent to the fetcher of GraphiQL. For each query that is being executed, this function will be called
\n
\n
createApolloLink is only available in the React Component and not the middlewares, because the content must be serializable as it is being printed into a HTML template.
\n
As HTML Page
\n
If you simply want to render the Playground HTML on your own, for example when implementing a GraphQL Server, there are 2 options for you:
Note: In case you do not want to serve assets from a CDN (like jsDelivr) and instead use a local copy, you will need to install graphql-playground-react from npm, and then replace all instances of //cdn.jsdelivr.net/npm with ./node_modules. An example can be found here
\n
As React Component
\n
Install
\n
yarn add graphql-playground-react
\n
Use
\n
GraphQL Playground provides a React component responsible for rendering the UI and Session management.\nThere are 3 dependencies needed in order to run the graphql-playground-react React component.
# Pick the one that matches your server framework\nyarn add graphql-playground-middleware-express # for Express or Connect\nyarn add graphql-playground-middleware-hapi\nyarn add graphql-playground-middleware-koa\nyarn add graphql-playground-middleware-lambda
\n
Usage with example
\n
We have a full example for each of the frameworks below:
To initiate the signature process please open a PR against this repo. The EasyCLA bot will block the merge if we still need a membership agreement from you.
If your company benefits from GraphQL and you would like to provide essential financial support for the systems and people that power our community, please also consider membership in the GraphQL Foundation.
\n
Custom Theme
\n
From graphql-playground-react@1.7.0 on you can provide a codeTheme property to the React Component to customize your color theme.\nThese are the available options:
This is repository is a \"mono repo\" and contains multiple packages using Yarn workspaces. Please be aware that versions are not synchronised between packages. The versions of the release page refer to the electron app.
\n
Packages
\n
In the folder packages you'll find the following packages:
\n
\n
graphql-playground-electron: Cross-platform electron app which uses graphql-playground-react
\n
graphql-playground-html: Simple HTML page rendering a version of graphql-playground-react hosted on JSDeliver
\n
graphql-playground-middleware-express: Express middleware using graphql-playground-html
\n
graphql-playground-middleware-hapi: Hapi middleware using graphql-playground-html
\n
graphql-playground-middleware-koa: Koa middleware using graphql-playground-html
\n
graphql-playground-middleware-lambda: AWS Lambda middleware using graphql-playground-html
\n
graphql-playground-react: Core of GraphQL Playground built with ReactJS
Join our Discord Server if you run into issues or have questions. We love talking to you!
\n
\n
",
+ "readmeOriginal": "
\n
Note: The primary maintainer @acao is on hiatus until December 2020
\n
\n
\n
SECURITY WARNING: both graphql-playground-html and all four (4) of it's middleware dependents until graphql-playground-html@1.6.22 were subject to an XSS Reflection attack vulnerability only to unsanitized user input strings to the functions therein. This was resolved in graphql-playground-html@^1.6.22. More InformationCVE-2020-4038
⚙ GraphQL Config support with multiple Projects & Endpoints
\n
🚥 Apollo Tracing support
\n
\n
Security Details
\n
\n
NOTE: only unsanitized user input to the functions in these packages is vulnerable to the recently reported XSS Reflection attack.
\n
\n
Impact
\n
\n
Impacted are any and all unsanitized user-defined input to:\n-renderPlaygroundPage()\n-koaPlayground()\n-expressPlayground()\n-koaPlayground()\n-`lambdaPlayground()
\n
\n
\n
If you used static values, such as graphql-playground-electron does in it's webpack config, as well as the most common middleware implementations out there, they were not vulnerable to the attack.
\n
\n
The only reason this vulnerability exists is because we are using template strings in renderPlaygroundPage() with potentially unsanitized user defined variables. This allows an attacker to inject html and javascript into the page.
Common examples may be user-defined path parameters, query string, unsanitized UI provided values in database, etc., that are used to build template strings or passed directly to a renderPlaygroundPage() or the matching middleware function equivalent listed above.
\n
Impacted Packages
\n
All versions of these packages are impacted until the ones specified below, which are now safe for user defined input:
\n
\n
graphql-playground-html: ☔ safe @ 1.6.22
\n
graphql-playground-express☔ safe @ 1.7.16
\n
graphql-playground-koa☔ safe @ 1.6.15
\n
graphql-playground-hapi☔ safe @ 1.6.13
\n
graphql-playground-lambda☔ safe @ 1.7.17
\n
graphql-playground-electron has always been ☔ safe from XSS attacks! This is because configuration is statically defined it's webpack config
\n
graphql-playground-react is safe because it does not use renderPlaygroundPage() anywhere, and thus is not susceptible to template string XSS reflection attacks.
\n
\n
More Information
\n
See the security docs for more details on how your implementation might be impacted by this vulnerability. It contains safe examples, unsafe examples, workarounds, and more details.
\n
We've also provided 'an example of the xss using the express middleware
GraphQL Playground uses components of GraphiQL under the hood but is meant as a more powerful GraphQL IDE enabling better (local) development workflows. Compared to GraphiQL, the GraphQL Playground ships with the following additional features:
\n
\n
Interactive, multi-column schema documentation
\n
Automatic schema reloading
\n
Support for GraphQL Subscriptions
\n
Query history
\n
Configuration of HTTP headers
\n
Tabs
\n
\n
See the following question for more additonal features.
\n
What's the difference between the desktop app and the web version?
\n
The desktop app is the same as the web version but includes these additional features:
\n
\n
Partial support for graphql-config enabling features like multi-environment setups (no support for sending HTTP headers).
\n
Double click on *.graphql files.
\n
\n
How does GraphQL Bin work?
\n
You can easily share your Playgrounds with others by clicking on the \"Share\" button and sharing the generated link. You can think about GraphQL Bin like Pastebin for your GraphQL queries including the context (endpoint, HTTP headers, open tabs etc).
schemaIntrospectionResult - The result of an introspection query (an object of this form: {__schema: {...}}) The playground automatically fetches the schema from the endpoint. This is only needed when you want to override the schema.
\n
tabsTab[] - An array of tabs to inject. Note: When using this feature, tabs will be resetted each time the page is reloaded
In addition to this, the React app provides some more properties:
\n
\n
props (React Component)
\n
createApolloLink [(session: Session, subscriptionEndpoint?: string) => ApolloLink] - this is the equivalent to the fetcher of GraphiQL. For each query that is being executed, this function will be called
\n
\n
createApolloLink is only available in the React Component and not the middlewares, because the content must be serializable as it is being printed into a HTML template.
\n
As HTML Page
\n
If you simply want to render the Playground HTML on your own, for example when implementing a GraphQL Server, there are 2 options for you:
Note: In case you do not want to serve assets from a CDN (like jsDelivr) and instead use a local copy, you will need to install graphql-playground-react from npm, and then replace all instances of //cdn.jsdelivr.net/npm with ./node_modules. An example can be found here
\n
As React Component
\n
Install
\n
yarn add graphql-playground-react
\n
Use
\n
GraphQL Playground provides a React component responsible for rendering the UI and Session management.\nThere are 3 dependencies needed in order to run the graphql-playground-react React component.
# Pick the one that matches your server framework\nyarn add graphql-playground-middleware-express # for Express or Connect\nyarn add graphql-playground-middleware-hapi\nyarn add graphql-playground-middleware-koa\nyarn add graphql-playground-middleware-lambda
\n
Usage with example
\n
We have a full example for each of the frameworks below:
To initiate the signature process please open a PR against this repo. The EasyCLA bot will block the merge if we still need a membership agreement from you.
If your company benefits from GraphQL and you would like to provide essential financial support for the systems and people that power our community, please also consider membership in the GraphQL Foundation.
\n
Custom Theme
\n
From graphql-playground-react@1.7.0 on you can provide a codeTheme property to the React Component to customize your color theme.\nThese are the available options:
This is repository is a \"mono repo\" and contains multiple packages using Yarn workspaces. Please be aware that versions are not synchronised between packages. The versions of the release page refer to the electron app.
\n
Packages
\n
In the folder packages you'll find the following packages:
\n
\n
graphql-playground-electron: Cross-platform electron app which uses graphql-playground-react
\n
graphql-playground-html: Simple HTML page rendering a version of graphql-playground-react hosted on JSDeliver
\n
graphql-playground-middleware-express: Express middleware using graphql-playground-html
\n
graphql-playground-middleware-hapi: Hapi middleware using graphql-playground-html
\n
graphql-playground-middleware-koa: Koa middleware using graphql-playground-html
\n
graphql-playground-middleware-lambda: AWS Lambda middleware using graphql-playground-html
\n
graphql-playground-react: Core of GraphQL Playground built with ReactJS
To get started and try out Hawk Eye, download the latest release for your platform on the Releases Page. You'll then be able to auto-update when new updates are available. Note: this currently only works for macOS, Windows incoming.
\n
Screenshots
\n
Dark Mode
\n
\n
Light Mode
\n
\n
Contributing
\n
For information regarding contributing to this project, please read the Contributing document.
To get started and try out Hawk Eye, download the latest release for your platform on the Releases Page. You'll then be able to auto-update when new updates are available. Note: this currently only works for macOS, Windows incoming.
\n
Screenshots
\n
Dark Mode
\n
\n
Light Mode
\n
\n
Contributing
\n
For information regarding contributing to this project, please read the Contributing document.
HashTag is a minimalist mirosoftware that hash some text. This application should mainly be used by developers who want to quickly hash something. It can also keep in memory your previous hashes in order to save some time during your development process. Currently, their are 3 algorithms : MD5, SHA-256 and Bcrypt.
\n
Installation
\n
⚠️ Currently, this software is only available for Windows (Linux and MacOS are not supported) \n \nYou can either download it from GitHub using the latest realese, from the Electron apps website or from the Softpedia website.\n \nOnce done, double click on HashTag.exe and it be ready to use.
\n
Run HashTag locally
\n\n
Clone the repository
\n\n
$ git clone https://github.com/MrAnyx/HashTag.git
\n \n\n
Install the dependencies
\n\n
$ npm install
\n \n\n
Run the application
\n\n
$ npm start
\n \n\n
Build the application
\n\n
$ npm run build
\n
Issue
\n
If you find a security issue or any other kind of issue, feel free to create an issue by clicking here.\nSame thing for the pull requests and feature requests.
If you like this project or if you want to support me, you can simply smash the like button, just to let me know.
\n
Preview
\n
\n \n
\n
\n \n
\n
License
\n
Currently, this project is under the GPL-3.0 license.
\n
",
- "readmeOriginal": "
\n \n
\n
Overview
\n
HashTag is a minimalist mirosoftware that hash some text. This application should mainly be used by developers who want to quickly hash something. It can also keep in memory your previous hashes in order to save some time during your development process. Currently, their are 3 algorithms : MD5, SHA-256 and Bcrypt.
\n
Installation
\n
⚠️ Currently, this software is only available for Windows (Linux and MacOS are not supported) \n \nYou can either download it from GitHub using the latest realese, from the Electron apps website or from the Softpedia website.\n \nOnce done, double click on HashTag.exe and it be ready to use.
\n
Run HashTag locally
\n\n
Clone the repository
\n\n
$ git clone https://github.com/MrAnyx/HashTag.git
\n \n\n
Install the dependencies
\n\n
$ npm install
\n \n\n
Run the application
\n\n
$ npm start
\n \n\n
Build the application
\n\n
$ npm run build
\n
Issue
\n
If you find a security issue or any other kind of issue, feel free to create an issue by clicking here.\nSame thing for the pull requests and feature requests.
A free GUI application for HandBrake and FFmpeg/FFprobe on Windows, macOS and Linux (+ Linux Docker image) with an emphasis on multi HandBrake/FFmpeg instance batch conversion (including recursive folder scans and folder watching). The destination folder structure is kept the same as the source folder structure. Media in subfolders is also converted. Multiple folders can be monitored and different conversion presets can be specified for each folder. Also included:
\n
-Remote monitoring feature to monitor batch file conversions in any browser
\n
-Basic h265 benchmarking
\n
-Health check feature which can scan for corrupt video files using HandBrake (quick scan) or FFmpeg (thorough scan), although this is not always accurate. Attempt repair file feature included too.
\n
This is a standalone program on Windows but requires HandBrakeCLI to be installed on Linux and Mac. For a server application with similar functionality please see Tdarr.
\n
Settings help is available by pressing the blue ? diamond icons spread throughout the program:
\n
\n
The program scans the source folders for all files. It then compares the source folder files with the destination folder files to see if any of the source files exist in the destination folder already. If not, the program queues the files for conversion.
\n
4 worker modules (default number) then work through the conversion queue. If periodic scanning is enabled then the program will run at the chosen interval.
\n
After it a bit more testing it seems that weird things can happen if you monitor a folder which is being downloaded to. It seems sometimes conversions start before a file has fully downloaded. To solve this, I recommend using a temporary download folder before moving completed files into your HBBB source folder.
\n
If you use a download program which has an 'incomplete downloads' folder etc, do not put that folder inside your main source folder else you may end up converting each file twice.
\n
The program won't work properly if you put the destination folder in a folder inside the source folder because the program is recreating the source folder structure inside the destination folder. It will cause an infinite loop of creating more and more sub-folders each time you run the program. So it will NOT work properly if you do something like this:
\n
Source:
\n
D:\\Videos
\n
Destination:
\n
D:\\Videos\\Converted
\n
It will work properly if you do something like this etc:
\n
Source:
\n
D:\\Videos
\n
Destination:
\n
D:\\Converted
\n
",
+ "readmeOriginal": "
HBBatchBeast for HandBrake and FFmpeg/FFprobe (Windows, macOS, Linux & Docker)
A free GUI application for HandBrake and FFmpeg/FFprobe on Windows, macOS and Linux (+ Linux Docker image) with an emphasis on multi HandBrake/FFmpeg instance batch conversion (including recursive folder scans and folder watching). The destination folder structure is kept the same as the source folder structure. Media in subfolders is also converted. Multiple folders can be monitored and different conversion presets can be specified for each folder. Also included:
\n
-Remote monitoring feature to monitor batch file conversions in any browser
\n
-Basic h265 benchmarking
\n
-Health check feature which can scan for corrupt video files using HandBrake (quick scan) or FFmpeg (thorough scan), although this is not always accurate. Attempt repair file feature included too.
\n
This is a standalone program on Windows but requires HandBrakeCLI to be installed on Linux and Mac. For a server application with similar functionality please see Tdarr.
\n
Settings help is available by pressing the blue ? diamond icons spread throughout the program:
\n
\n
The program scans the source folders for all files. It then compares the source folder files with the destination folder files to see if any of the source files exist in the destination folder already. If not, the program queues the files for conversion.
\n
4 worker modules (default number) then work through the conversion queue. If periodic scanning is enabled then the program will run at the chosen interval.
\n
After it a bit more testing it seems that weird things can happen if you monitor a folder which is being downloaded to. It seems sometimes conversions start before a file has fully downloaded. To solve this, I recommend using a temporary download folder before moving completed files into your HBBB source folder.
\n
If you use a download program which has an 'incomplete downloads' folder etc, do not put that folder inside your main source folder else you may end up converting each file twice.
\n
The program won't work properly if you put the destination folder in a folder inside the source folder because the program is recreating the source folder structure inside the destination folder. It will cause an infinite loop of creating more and more sub-folders each time you run the program. So it will NOT work properly if you do something like this:
\n
Source:
\n
D:\\Videos
\n
Destination:
\n
D:\\Videos\\Converted
\n
It will work properly if you do something like this etc:
Clone and run for a quick way to see Electron-News-App in action.
\n
Screenshot
\n
\n
To Use
\n
To clone and run this repository you'll need Git and Node.js (which comes with npm) installed on your computer. From your command line:
\n
# Clone this repository\ngit clone https://github.com/MedZed/Electron-Headlines.git\n# Go into the repository\ncd electron-quick-start\n# Install dependencies\nnpm install\n# Run the app\nnpm start
For more example apps, see the\nlist of boilerplates\ncreated by the awesome electron community.
\n
License
\n
The MIT License
\n
Copyright (c) 2017 Med Zarroug
\n
",
"readmeOriginal": "
Electron-Headlines
\n
\n
Clone and run for a quick way to see Electron-News-App in action.
\n
Screenshot
\n
\n
To Use
\n
To clone and run this repository you'll need Git and Node.js (which comes with npm) installed on your computer. From your command line:
\n
# Clone this repository\ngit clone https://github.com/MedZed/Electron-Headlines.git\n# Go into the repository\ncd electron-quick-start\n# Install dependencies\nnpm install\n# Run the app\nnpm start
If you download from the Releases tab, select the installer for your system.
\n
\n\n
\n
Platform
\n
File
\n
\n\n\n
\n
Windows x64
\n
Helios-Launcher-setup-VERSION.exe
\n
\n
\n
macOS x64
\n
Helios-Launcher-setup-VERSION.dmg
\n
\n
\n
macOS arm64
\n
Helios-Launcher-setup-VERSION-arm64.dmg
\n
\n
\n
Linux x64
\n
Helios-Launcher-setup-VERSION.AppImage
\n
\n\n
\n
Console
\n
To open the console, use the following keybind.
\n
ctrl + shift + i
\n
Ensure that you have the console tab selected. Do not paste anything into the console unless you are 100% sure of what it will do. Pasting the wrong thing can expose sensitive information.
\n
Export Output to a File
\n
If you want to export the console output, simply right click anywhere on the console and click Save as..
\n
\n
Development
\n
This section details the setup of a basic developmentment environment.
Note that you cannot open the DevTools window while using this debug configuration. Chromium only allows one debugger, opening another will crash the program.
\n\n
Note on Third-Party Usage
\n
Please give credit to the original author and provide a link to the original source. This is free software, please do at least this much.
If you download from the Releases tab, select the installer for your system.
\n
\n\n
\n
Platform
\n
File
\n
\n\n\n
\n
Windows x64
\n
Helios-Launcher-setup-VERSION.exe
\n
\n
\n
macOS x64
\n
Helios-Launcher-setup-VERSION.dmg
\n
\n
\n
macOS arm64
\n
Helios-Launcher-setup-VERSION-arm64.dmg
\n
\n
\n
Linux x64
\n
Helios-Launcher-setup-VERSION.AppImage
\n
\n\n
\n
Console
\n
To open the console, use the following keybind.
\n
ctrl + shift + i
\n
Ensure that you have the console tab selected. Do not paste anything into the console unless you are 100% sure of what it will do. Pasting the wrong thing can expose sensitive information.
\n
Export Output to a File
\n
If you want to export the console output, simply right click anywhere on the console and click Save as..
\n
\n
Development
\n
This section details the setup of a basic developmentment environment.
Note that you cannot open the DevTools window while using this debug configuration. Chromium only allows one debugger, opening another will crash the program.
\n\n
Note on Third-Party Usage
\n
Please give credit to the original author and provide a link to the original source. This is free software, please do at least this much.
Heads or Tails” is a multiplayer game, based on the DPOS blockchain with instant payments, built-in wallet and exchange platform for popular cryptocurrencies. Statistics of your games and a chat are also available.
\n
You can start a new game with your own stake or choose an existing one by choosing one “Heads” or “Tails” side of the coin.\nThe game of “Heads or tails” is still insanely popular worldwide.\nThe history of many peoples carefully keeps the rules of the “Heads or tails” game. It was called differently from one country to another. The name of the game often depended on what was depicted on the coin.
\n
One could find players on loud Eastern bazaars, under the moonlight of the Great Silk Road or on Her Majesty’s ship, fell calm somewhere in the Mediterranean Sea.\nAnd now, the most popular game of “Heads or tails” is on the blockchain.\nThe information about every side of the coin is encrypted and saved in the blockchain. The game is played strictly between the players.\nYou can transfer or send cryptocurrency to your address or to the exchange market using your profile. The statistics of your games and a chat are also available.
Heads or Tails” is a multiplayer game, based on the DPOS blockchain with instant payments, built-in wallet and exchange platform for popular cryptocurrencies. Statistics of your games and a chat are also available.
\n
You can start a new game with your own stake or choose an existing one by choosing one “Heads” or “Tails” side of the coin.\nThe game of “Heads or tails” is still insanely popular worldwide.\nThe history of many peoples carefully keeps the rules of the “Heads or tails” game. It was called differently from one country to another. The name of the game often depended on what was depicted on the coin.
\n
One could find players on loud Eastern bazaars, under the moonlight of the Great Silk Road or on Her Majesty’s ship, fell calm somewhere in the Mediterranean Sea.\nAnd now, the most popular game of “Heads or tails” is on the blockchain.\nThe information about every side of the coin is encrypted and saved in the blockchain. The game is played strictly between the players.\nYou can transfer or send cryptocurrency to your address or to the exchange market using your profile. The statistics of your games and a chat are also available.
If you download from the Releases tab, select the installer for your system.
\n
\n\n
\n
Platform
\n
File
\n
\n\n\n
\n
Windows x64
\n
Helios-Launcher-setup-VERSION.exe
\n
\n
\n
macOS x64
\n
Helios-Launcher-setup-VERSION.dmg
\n
\n
\n
macOS arm64
\n
Helios-Launcher-setup-VERSION-arm64.dmg
\n
\n
\n
Linux x64
\n
Helios-Launcher-setup-VERSION.AppImage
\n
\n\n
\n
Console
\n
To open the console, use the following keybind.
\n
ctrl + shift + i
\n
Ensure that you have the console tab selected. Do not paste anything into the console unless you are 100% sure of what it will do. Pasting the wrong thing can expose sensitive information.
\n
Export Output to a File
\n
If you want to export the console output, simply right click anywhere on the console and click Save as..
\n
\n
Development
\n
This section details the setup of a basic developmentment environment.
Note that you cannot open the DevTools window while using this debug configuration. Chromium only allows one debugger, opening another will crash the program.
\n\n
Note on Third-Party Usage
\n
Please give credit to the original author and provide a link to the original source. This is free software, please do at least this much.
If you download from the Releases tab, select the installer for your system.
\n
\n\n
\n
Platform
\n
File
\n
\n\n\n
\n
Windows x64
\n
Helios-Launcher-setup-VERSION.exe
\n
\n
\n
macOS x64
\n
Helios-Launcher-setup-VERSION.dmg
\n
\n
\n
macOS arm64
\n
Helios-Launcher-setup-VERSION-arm64.dmg
\n
\n
\n
Linux x64
\n
Helios-Launcher-setup-VERSION.AppImage
\n
\n\n
\n
Console
\n
To open the console, use the following keybind.
\n
ctrl + shift + i
\n
Ensure that you have the console tab selected. Do not paste anything into the console unless you are 100% sure of what it will do. Pasting the wrong thing can expose sensitive information.
\n
Export Output to a File
\n
If you want to export the console output, simply right click anywhere on the console and click Save as..
\n
\n
Development
\n
This section details the setup of a basic developmentment environment.
Note that you cannot open the DevTools window while using this debug configuration. Chromium only allows one debugger, opening another will crash the program.
\n\n
Note on Third-Party Usage
\n
Please give credit to the original author and provide a link to the original source. This is free software, please do at least this much.
Welcome to Hypnos(beta), a streamlined desktop application to sandbox GraphQL calls to RESTful APIs using the Apollo-link-rest package from Apollo Client, as well as giving detailed, helpful error messages.
\n\n\n
* We recently added tabs to handle multiple entries!
\n
Getting Started
\n
Requirements
\n
All you need to do is download your respective OS package, install, and go!
Hypnos will return the GraphQL response or meaningful errors
\n
If there are any errors in query formatting, they will be displayed on the right
\n
\n\n
\n
Features
\n
Hypnos History
\n
Hypnos will store your local query history, persisting queries from your sessions. You can delete your entire history, or you can delete individual queries. You also have the option of repopulating the current tab with a previous query.
\n
\n\n
\n
Tabs
\n
Want to submit another query, but don't want to submit your current query just yet? Just open up a new tab! Hypnos will save the endpoint and query, and you can come back to it later.
\n
\n\n
\n
Authenticated APIs
\n
A majority of APIs require a key in order to gain access to their endpoints, but have no fear: Hypnos supports API keys. Type in your endpoint and query as you would normally, but before you submit the query, go to Submit API Key. Clicking on it will open a new window in which you can enter the key for your headers and the API key given to you by the API itself. Once you submit the keys, you can go ahead and submit your query.
Welcome to Hypnos(beta), a streamlined desktop application to sandbox GraphQL calls to RESTful APIs using the Apollo-link-rest package from Apollo Client, as well as giving detailed, helpful error messages.
\n\n\n
* We recently added tabs to handle multiple entries!
\n
Getting Started
\n
Requirements
\n
All you need to do is download your respective OS package, install, and go!
Hypnos will return the GraphQL response or meaningful errors
\n
If there are any errors in query formatting, they will be displayed on the right
\n
\n\n
\n
Features
\n
Hypnos History
\n
Hypnos will store your local query history, persisting queries from your sessions. You can delete your entire history, or you can delete individual queries. You also have the option of repopulating the current tab with a previous query.
\n
\n\n
\n
Tabs
\n
Want to submit another query, but don't want to submit your current query just yet? Just open up a new tab! Hypnos will save the endpoint and query, and you can come back to it later.
\n
\n\n
\n
Authenticated APIs
\n
A majority of APIs require a key in order to gain access to their endpoints, but have no fear: Hypnos supports API keys. Type in your endpoint and query as you would normally, but before you submit the query, go to Submit API Key. Clicking on it will open a new window in which you can enter the key for your headers and the API key given to you by the API itself. Once you submit the keys, you can go ahead and submit your query.
🎉 Store, manage and switch your hosts quickly. Especially suitable for developers who need to switch frequently between development, test and production environment. Based on Node.js and Electron.
Firstly be sure you have installed Node.js and NPM successfully.
\n
Install bower global
\n
$ npm install -g bower
\n
Install dependency
\n
$ npm install
\n
$ bower install
\n
Start app
\n
$ npm start
\n
To start app with debug model, use:
\n
$ npm run dev
\n
Enjoy it!😄
\n
How to package
\n
We use electron-packager package the application to facilitate the distribution of it.
\n
Install electron-packager global
\n
$ npm install -g electron-packager
\n
Package app
\n
After finished all operations in Quick start, go into the app folder, execute:
\n
$ npm run package
\n
Attentions
\n
\n
During packing electron-packager will download all required files and cache them in ~/.electron folder(user/your_user_name/.electron in Windows), it may be very slow, I suggest you to manually download them into the folder through some download tool (the required files see Electron Release).
\n
Packing Darwin app in Windows may fail (even if there is no error, packaged application may also be unable to run in OS X), there seems no nice solution now, I suggest you to package Darwin app on non-Windows platform. See more details in Issue 164.
\n
\n
License
\n
The MIT License (MIT)
\n
Copyright (c) 2017 Sky
\n
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
\n
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
\n
THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
🎉 Store, manage and switch your hosts quickly. Especially suitable for developers who need to switch frequently between development, test and production environment. Based on Node.js and Electron.
Firstly be sure you have installed Node.js and NPM successfully.
\n
Install bower global
\n
$ npm install -g bower
\n
Install dependency
\n
$ npm install
\n
$ bower install
\n
Start app
\n
$ npm start
\n
To start app with debug model, use:
\n
$ npm run dev
\n
Enjoy it!😄
\n
How to package
\n
We use electron-packager package the application to facilitate the distribution of it.
\n
Install electron-packager global
\n
$ npm install -g electron-packager
\n
Package app
\n
After finished all operations in Quick start, go into the app folder, execute:
\n
$ npm run package
\n
Attentions
\n
\n
During packing electron-packager will download all required files and cache them in ~/.electron folder(user/your_user_name/.electron in Windows), it may be very slow, I suggest you to manually download them into the folder through some download tool (the required files see Electron Release).
\n
Packing Darwin app in Windows may fail (even if there is no error, packaged application may also be unable to run in OS X), there seems no nice solution now, I suggest you to package Darwin app on non-Windows platform. See more details in Issue 164.
\n
\n
License
\n
The MIT License (MIT)
\n
Copyright (c) 2017 Sky
\n
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
\n
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
\n
THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
This project has entered on looking for new owner stage.
\n
Developing this tool has being great, but recently I (@gilmarsquinelato) am not contributing too much with it, and I don't think it's fair to the people that are\nusing this tool, so I am stopping to contribute with this tool and happy to transfer the project to the people that really wants to keep maintaining it.
\n
Thank you!
\n\n
This app was developed with the objective to help the developers to manage the app translations.
\n
Any type of contributions are welcome.
\n
Features
\n
\n
Detect changed, missing, duplicated/untranslated keys and added translations
\n
Add, remove and rename translation keys (context menu)
This project has entered on looking for new owner stage.
\n
Developing this tool has being great, but recently I (@gilmarsquinelato) am not contributing too much with it, and I don't think it's fair to the people that are\nusing this tool, so I am stopping to contribute with this tool and happy to transfer the project to the people that really wants to keep maintaining it.
\n
Thank you!
\n\n
This app was developed with the objective to help the developers to manage the app translations.
\n
Any type of contributions are welcome.
\n
Features
\n
\n
Detect changed, missing, duplicated/untranslated keys and added translations
\n
Add, remove and rename translation keys (context menu)
The goal of the project is to create a beautiful and extensible experience for command-line interface users, built on open web standards. In the beginning, our focus will be primarily around speed, stability and the development of the correct API for extension authors.
\n
In the future, we anticipate the community will come up with innovative additions to enhance what could be the simplest, most powerful and well-tested interface for productivity.
Hyper is available as Nix package, to install the app run this command:
\n
nix-env -i hyper
\n
macOS
\n
Use Homebrew Cask to download the app by running these commands:
\n
brew update\nbrew install --cask hyper
\n
Windows
\n
Use chocolatey to install the app by running the following command (package information can be found here):
\n
choco install hyper
\n
Note: The version available on Homebrew Cask, Chocolatey, Snapcraft or the AUR may not be the latest. Please consider downloading it from here if that's the case.
\n
Contribute
\n
Regardless of the platform you are working on, you will need to have Yarn installed. If you have never installed Yarn before, you can find out how at: https://yarnpkg.com/en/docs/install.
\n\n
Install necessary packages:
\n\n
\n
Windows\n
\n
Be sure to run yarn global add windows-build-tools from an elevated prompt (as an administrator) to install windows-build-tools.
\n
\n
\n
macOS\n
\n
Once you have installed Yarn, you can skip this section!
\n
\n
\n
Linux (You can see here what your Linux is based on.)\n
\n
RPM-based\n
\n
GraphicsMagick
\n
libicns-utils
\n
xz (Installed by default on some distributions.)
\n
\n
\n
Debian-based\n
\n
graphicsmagick
\n
icnsutils
\n
xz-utils
\n
\n
\n
\n
\n
\n\n
Fork this repository to your own GitHub account and then clone it to your local device
\n
Install the dependencies: yarn
\n
Build the code and watch for changes: yarn run dev
\n
To run hyper
\n\n
\n
yarn run app from another terminal tab/window/pane
\n
If you are using Visual Studio Code, select Launch Hyper in debugger configuration to launch a new Hyper instance with debugger attached.
\n
If you interrupt yarn run dev, you'll need to relaunch it each time you want to test something. Webpack will watch changes and will rebuild renderer code when needed (and only what have changed). You'll just have to relaunch electron by using yarn run app or VSCode launch task.
\n
\n
To make sure that your code works in the finished application, you can generate the binaries like this:
\n
yarn run dist
\n
After that, you will see the binary in the ./dist folder!
\n
Known issues that can happen during development
\n
Error building node-pty
\n
If after building during development you get an alert dialog related to node-pty issues,\nmake sure its build process is working correctly by running yarn run rebuild-node-pty.
\n
If you are on macOS, this typically is related to Xcode issues (like not having agreed\nto the Terms of Service by running sudo xcodebuild after a fresh Xcode installation).
\n
Error with c++ on macOS when running yarn
\n
If you are getting compiler errors when running yarn add the environment variable export CXX=clang++
\n
Error with codesign on macOS when running yarn run dist
\n
If you have issues in the codesign step when running yarn run dist on macOS, you can temporarily disable code signing locally by setting\nexport CSC_IDENTITY_AUTO_DISCOVERY=false for the current terminal session.
The goal of the project is to create a beautiful and extensible experience for command-line interface users, built on open web standards. In the beginning, our focus will be primarily around speed, stability and the development of the correct API for extension authors.
\n
In the future, we anticipate the community will come up with innovative additions to enhance what could be the simplest, most powerful and well-tested interface for productivity.
Hyper is available as Nix package, to install the app run this command:
\n
nix-env -i hyper
\n
macOS
\n
Use Homebrew Cask to download the app by running these commands:
\n
brew update\nbrew install --cask hyper
\n
Windows
\n
Use chocolatey to install the app by running the following command (package information can be found here):
\n
choco install hyper
\n
Note: The version available on Homebrew Cask, Chocolatey, Snapcraft or the AUR may not be the latest. Please consider downloading it from here if that's the case.
\n
Contribute
\n
Regardless of the platform you are working on, you will need to have Yarn installed. If you have never installed Yarn before, you can find out how at: https://yarnpkg.com/en/docs/install.
\n\n
Install necessary packages:
\n\n
\n
Windows\n
\n
Be sure to run yarn global add windows-build-tools from an elevated prompt (as an administrator) to install windows-build-tools.
\n
\n
\n
macOS\n
\n
Once you have installed Yarn, you can skip this section!
\n
\n
\n
Linux (You can see here what your Linux is based on.)\n
\n
RPM-based\n
\n
GraphicsMagick
\n
libicns-utils
\n
xz (Installed by default on some distributions.)
\n
\n
\n
Debian-based\n
\n
graphicsmagick
\n
icnsutils
\n
xz-utils
\n
\n
\n
\n
\n
\n\n
Fork this repository to your own GitHub account and then clone it to your local device
\n
Install the dependencies: yarn
\n
Build the code and watch for changes: yarn run dev
\n
To run hyper
\n\n
\n
yarn run app from another terminal tab/window/pane
\n
If you are using Visual Studio Code, select Launch Hyper in debugger configuration to launch a new Hyper instance with debugger attached.
\n
If you interrupt yarn run dev, you'll need to relaunch it each time you want to test something. Webpack will watch changes and will rebuild renderer code when needed (and only what have changed). You'll just have to relaunch electron by using yarn run app or VSCode launch task.
\n
\n
To make sure that your code works in the finished application, you can generate the binaries like this:
\n
yarn run dist
\n
After that, you will see the binary in the ./dist folder!
\n
Known issues that can happen during development
\n
Error building node-pty
\n
If after building during development you get an alert dialog related to node-pty issues,\nmake sure its build process is working correctly by running yarn run rebuild-node-pty.
\n
If you are on macOS, this typically is related to Xcode issues (like not having agreed\nto the Terms of Service by running sudo xcodebuild after a fresh Xcode installation).
\n
Error with c++ on macOS when running yarn
\n
If you are getting compiler errors when running yarn add the environment variable export CXX=clang++
\n
Error with codesign on macOS when running yarn run dist
\n
If you have issues in the codesign step when running yarn run dist on macOS, you can temporarily disable code signing locally by setting\nexport CSC_IDENTITY_AUTO_DISCOVERY=false for the current terminal session.
git clone https://github.com/meowtec/Imagine.git\nnpm install\nnpm run dev
\n
A PR with all checks passed is welcome.
\n
Before submit a PR, please run npm run test and make sure it success on your machine.
\n
Up to now, there are only 5 locales. To add a new locale, you can either submit a PR, or create an issue, or just send me an email(found in my profile).
git clone https://github.com/meowtec/Imagine.git\nnpm install\nnpm run dev
\n
A PR with all checks passed is welcome.
\n
Before submit a PR, please run npm run test and make sure it success on your machine.
\n
Up to now, there are only 5 locales. To add a new locale, you can either submit a PR, or create an issue, or just send me an email(found in my profile).
Image Shrinker is a tool to minify images and graphics using the best available libraries for image processing: pngquant, mozjpg, SVGO and Gifsicle. Built with web technologies in Electron
\n
\n
How to use
\n
Drag your image file onto the Image Shrinker window and it will saved in the same or in a predefined folder as reduced image.\nThe original graphic will be not replaced.
Image Shrinker is a tool to minify images and graphics using the best available libraries for image processing: pngquant, mozjpg, SVGO and Gifsicle. Built with web technologies in Electron
\n
\n
How to use
\n
Drag your image file onto the Image Shrinker window and it will saved in the same or in a predefined folder as reduced image.\nThe original graphic will be not replaced.
Unofficial, free and open-source Google Gmail Desktop App
\n
\n
Inboxer — started out as an unofficial Inbox by Gmail client for desktop platforms. However, Google plans to discontinue Inbox at the end of March 2019 (see official announcement). To keep Inboxer alive we have converted it to work with Gmail. Inboxer is now built on top of Gmail web-version. It has pleasant UI and supports useful keyboard shortcuts.
Check out these ones as great examples of Electron applications. All of them are under the MIT license.
\n
Features
\n
\n
Familiar Gmail interface
\n
Cross-platform (macOS/Linux/Windows)
\n
Useful Keyboard shortcuts
\n
Multiple accounts
\n
Optional Always on Top
\n
Auto-updates to the latest version
\n
Desktop notifications
\n
TODO: Dark theme
\n
TODO: Custom text size
\n
TODO: Ability to use as default mail client
\n
\n
All feature requests and contributions are welcome!
\n
Screenshot
\n
\n
TODO: Update screenshot to show latest version working with Gmail\n
\n
\n
Installation
\n
Inboxer works well on macOS 10.9+, Linux and Windows 7+. You can download the latest version on Releases page or below.\nInboxer is also available through the nix package manager (see package in nix)
You'll need electron and npm installed in your system.\nDownload and extract the source code (.zip or .tar.gz file).\nInside the source code folder, run:
\n
$ npm install\n
\n
Then package the app with:
\n
$ npm run dist\n
\n
This builds packages for all architectures. Use dist:mac, dist:linux, or dist:win to package a single architecture. The packages will be found in the dist folder.
\n
Keyboard shortcuts
\n
Inboxer supports all Gmail keyboard shortcuts, system-specific keybindings and more. Additional keybindings are listed below:
\n
\n\n
\n
Description
\n
Keys
\n
\n\n\n
\n
Preferences
\n
Cmd/CtrlP
\n
\n
\n
Compose Message
\n
Cmd/CtrlN
\n
\n
\n
Go to Inbox
\n
Cmd/CtrlI
\n
\n
\n
Go to Snoozed
\n
Cmd/CtrlS
\n
\n
\n
Go to Done
\n
Cmd/CtrlD
\n
\n
\n
Drafts
\n
Cmd/CtrlShiftD
\n
\n
\n
Sent
\n
Cmd/CtrlShiftS
\n
\n
\n
Trash
\n
AltShiftT
\n
\n
\n
Spam
\n
AltShiftS
\n
\n
\n
Open Contacts
\n
Cmd/CtrlShiftC
\n
\n
\n
Search
\n
Cmd/CtrlF
\n
\n
\n
Toggle Sidebar
\n
Cmd/Ctrl/
\n
\n
\n
Toggle \"Always on Top\"
\n
Cmd/CtrlShiftT
\n
\n
\n
Keyboard Shortcuts Reference
\n
Shift/ or ?
\n
\n
\n
Toggle Developer Tools
\n
OptionCmdI(macOS) or CtrlShiftI
\n
\n\n
\n
Disclaimer
\n
This code is in no way affiliated with, authorised, maintained, sponsored or endorsed by Google or any of its affiliates or subsidiaries. This is an independent and unofficial Gmail app. Use it at your own risk.
\n
End User License Agreement
\n
\n
You will not use this repository for sending mass spam or any other malicious activity.
\n
We / You will not support anyone who is violating this EULA conditions.
\n
Repository is just for learning / personal purposes thus should not be part of any service available on the Internet that is trying to do any malicious activity (mass bulk request, spam etc).
\n
\n
Donate
\n
Hi! I work on this project in my spare time, beside my primary job. I hope enjoy using Inboxer, and if you do, please, support this project 🙏🏻.
Unofficial, free and open-source Google Gmail Desktop App
\n
\n
Inboxer — started out as an unofficial Inbox by Gmail client for desktop platforms. However, Google plans to discontinue Inbox at the end of March 2019 (see official announcement). To keep Inboxer alive we have converted it to work with Gmail. Inboxer is now built on top of Gmail web-version. It has pleasant UI and supports useful keyboard shortcuts.
Check out these ones as great examples of Electron applications. All of them are under the MIT license.
\n
Features
\n
\n
Familiar Gmail interface
\n
Cross-platform (macOS/Linux/Windows)
\n
Useful Keyboard shortcuts
\n
Multiple accounts
\n
Optional Always on Top
\n
Auto-updates to the latest version
\n
Desktop notifications
\n
TODO: Dark theme
\n
TODO: Custom text size
\n
TODO: Ability to use as default mail client
\n
\n
All feature requests and contributions are welcome!
\n
Screenshot
\n
\n
TODO: Update screenshot to show latest version working with Gmail\n
\n
\n
Installation
\n
Inboxer works well on macOS 10.9+, Linux and Windows 7+. You can download the latest version on Releases page or below.\nInboxer is also available through the nix package manager (see package in nix)
You'll need electron and npm installed in your system.\nDownload and extract the source code (.zip or .tar.gz file).\nInside the source code folder, run:
\n
$ npm install\n
\n
Then package the app with:
\n
$ npm run dist\n
\n
This builds packages for all architectures. Use dist:mac, dist:linux, or dist:win to package a single architecture. The packages will be found in the dist folder.
\n
Keyboard shortcuts
\n
Inboxer supports all Gmail keyboard shortcuts, system-specific keybindings and more. Additional keybindings are listed below:
\n
\n\n
\n
Description
\n
Keys
\n
\n\n\n
\n
Preferences
\n
Cmd/CtrlP
\n
\n
\n
Compose Message
\n
Cmd/CtrlN
\n
\n
\n
Go to Inbox
\n
Cmd/CtrlI
\n
\n
\n
Go to Snoozed
\n
Cmd/CtrlS
\n
\n
\n
Go to Done
\n
Cmd/CtrlD
\n
\n
\n
Drafts
\n
Cmd/CtrlShiftD
\n
\n
\n
Sent
\n
Cmd/CtrlShiftS
\n
\n
\n
Trash
\n
AltShiftT
\n
\n
\n
Spam
\n
AltShiftS
\n
\n
\n
Open Contacts
\n
Cmd/CtrlShiftC
\n
\n
\n
Search
\n
Cmd/CtrlF
\n
\n
\n
Toggle Sidebar
\n
Cmd/Ctrl/
\n
\n
\n
Toggle \"Always on Top\"
\n
Cmd/CtrlShiftT
\n
\n
\n
Keyboard Shortcuts Reference
\n
Shift/ or ?
\n
\n
\n
Toggle Developer Tools
\n
OptionCmdI(macOS) or CtrlShiftI
\n
\n\n
\n
Disclaimer
\n
This code is in no way affiliated with, authorised, maintained, sponsored or endorsed by Google or any of its affiliates or subsidiaries. This is an independent and unofficial Gmail app. Use it at your own risk.
\n
End User License Agreement
\n
\n
You will not use this repository for sending mass spam or any other malicious activity.
\n
We / You will not support anyone who is violating this EULA conditions.
\n
Repository is just for learning / personal purposes thus should not be part of any service available on the Internet that is trying to do any malicious activity (mass bulk request, spam etc).
\n
\n
Donate
\n
Hi! I work on this project in my spare time, beside my primary job. I hope enjoy using Inboxer, and if you do, please, support this project 🙏🏻.
The goal of the project is to create a beautiful and extensible experience for command-line interface users, built on open web standards. In the beginning, our focus will be primarily around speed, stability and the development of the correct API for extension authors.
\n
In the future, we anticipate the community will come up with innovative additions to enhance what could be the simplest, most powerful and well-tested interface for productivity.
Hyper is available as Nix package, to install the app run this command:
\n
nix-env -i hyper
\n
macOS
\n
Use Homebrew Cask to download the app by running these commands:
\n
brew update\nbrew install --cask hyper
\n
Windows
\n
Use chocolatey to install the app by running the following command (package information can be found here):
\n
choco install hyper
\n
Note: The version available on Homebrew Cask, Chocolatey, Snapcraft or the AUR may not be the latest. Please consider downloading it from here if that's the case.
\n
Contribute
\n
Regardless of the platform you are working on, you will need to have Yarn installed. If you have never installed Yarn before, you can find out how at: https://yarnpkg.com/en/docs/install.
\n\n
Install necessary packages:
\n\n
\n
Windows\n
\n
Be sure to run yarn global add windows-build-tools from an elevated prompt (as an administrator) to install windows-build-tools.
\n
\n
\n
macOS\n
\n
Once you have installed Yarn, you can skip this section!
\n
\n
\n
Linux (You can see here what your Linux is based on.)\n
\n
RPM-based\n
\n
GraphicsMagick
\n
libicns-utils
\n
xz (Installed by default on some distributions.)
\n
\n
\n
Debian-based\n
\n
graphicsmagick
\n
icnsutils
\n
xz-utils
\n
\n
\n
\n
\n
\n\n
Fork this repository to your own GitHub account and then clone it to your local device
\n
Install the dependencies: yarn
\n
Build the code and watch for changes: yarn run dev
\n
To run hyper
\n\n
\n
yarn run app from another terminal tab/window/pane
\n
If you are using Visual Studio Code, select Launch Hyper in debugger configuration to launch a new Hyper instance with debugger attached.
\n
If you interrupt yarn run dev, you'll need to relaunch it each time you want to test something. Webpack will watch changes and will rebuild renderer code when needed (and only what have changed). You'll just have to relaunch electron by using yarn run app or VSCode launch task.
\n
\n
To make sure that your code works in the finished application, you can generate the binaries like this:
\n
yarn run dist
\n
After that, you will see the binary in the ./dist folder!
\n
Known issues that can happen during development
\n
Error building node-pty
\n
If after building during development you get an alert dialog related to node-pty issues,\nmake sure its build process is working correctly by running yarn run rebuild-node-pty.
\n
If you are on macOS, this typically is related to Xcode issues (like not having agreed\nto the Terms of Service by running sudo xcodebuild after a fresh Xcode installation).
\n
Error with c++ on macOS when running yarn
\n
If you are getting compiler errors when running yarn add the environment variable export CXX=clang++
\n
Error with codesign on macOS when running yarn run dist
\n
If you have issues in the codesign step when running yarn run dist on macOS, you can temporarily disable code signing locally by setting\nexport CSC_IDENTITY_AUTO_DISCOVERY=false for the current terminal session.
The goal of the project is to create a beautiful and extensible experience for command-line interface users, built on open web standards. In the beginning, our focus will be primarily around speed, stability and the development of the correct API for extension authors.
\n
In the future, we anticipate the community will come up with innovative additions to enhance what could be the simplest, most powerful and well-tested interface for productivity.
Hyper is available as Nix package, to install the app run this command:
\n
nix-env -i hyper
\n
macOS
\n
Use Homebrew Cask to download the app by running these commands:
\n
brew update\nbrew install --cask hyper
\n
Windows
\n
Use chocolatey to install the app by running the following command (package information can be found here):
\n
choco install hyper
\n
Note: The version available on Homebrew Cask, Chocolatey, Snapcraft or the AUR may not be the latest. Please consider downloading it from here if that's the case.
\n
Contribute
\n
Regardless of the platform you are working on, you will need to have Yarn installed. If you have never installed Yarn before, you can find out how at: https://yarnpkg.com/en/docs/install.
\n\n
Install necessary packages:
\n\n
\n
Windows\n
\n
Be sure to run yarn global add windows-build-tools from an elevated prompt (as an administrator) to install windows-build-tools.
\n
\n
\n
macOS\n
\n
Once you have installed Yarn, you can skip this section!
\n
\n
\n
Linux (You can see here what your Linux is based on.)\n
\n
RPM-based\n
\n
GraphicsMagick
\n
libicns-utils
\n
xz (Installed by default on some distributions.)
\n
\n
\n
Debian-based\n
\n
graphicsmagick
\n
icnsutils
\n
xz-utils
\n
\n
\n
\n
\n
\n\n
Fork this repository to your own GitHub account and then clone it to your local device
\n
Install the dependencies: yarn
\n
Build the code and watch for changes: yarn run dev
\n
To run hyper
\n\n
\n
yarn run app from another terminal tab/window/pane
\n
If you are using Visual Studio Code, select Launch Hyper in debugger configuration to launch a new Hyper instance with debugger attached.
\n
If you interrupt yarn run dev, you'll need to relaunch it each time you want to test something. Webpack will watch changes and will rebuild renderer code when needed (and only what have changed). You'll just have to relaunch electron by using yarn run app or VSCode launch task.
\n
\n
To make sure that your code works in the finished application, you can generate the binaries like this:
\n
yarn run dist
\n
After that, you will see the binary in the ./dist folder!
\n
Known issues that can happen during development
\n
Error building node-pty
\n
If after building during development you get an alert dialog related to node-pty issues,\nmake sure its build process is working correctly by running yarn run rebuild-node-pty.
\n
If you are on macOS, this typically is related to Xcode issues (like not having agreed\nto the Terms of Service by running sudo xcodebuild after a fresh Xcode installation).
\n
Error with c++ on macOS when running yarn
\n
If you are getting compiler errors when running yarn add the environment variable export CXX=clang++
\n
Error with codesign on macOS when running yarn run dist
\n
If you have issues in the codesign step when running yarn run dist on macOS, you can temporarily disable code signing locally by setting\nexport CSC_IDENTITY_AUTO_DISCOVERY=false for the current terminal session.
This is my first attempt to write a desktop app with electron and learn the fantastic reactjs library. The editor is far from complete but I use it personally and I wanted to open-source it so that others can help with it.
\n
The one part of the app is a LaTeX editor with search functionality and simplified bibliography and packages handling. The other part is a WYSIWYG editor based on quilljs. The simple part also supports encrypted documents.
\n
I have built it on Debian Linux and I tried on Windows but, like always, everything in there is crappy compared to Linux so I just dropped it. I still have not tested on mac but I plan on doing it soon. Otherwise I expect that the program will be fully functional for anyone who wants to develop it on their mac.
In order to run LaTeX you need to have an installed version of the interpeter like TeXlive, MacTex or MikTex.
\n
To start the process go to the folder, open a terminal there and press
\n
yarn && yarn preminify\nnpm start\n
\n
The file Infinitex.jsx is only used for react-dom. The app.jsx file separates the two environments and has width and height event listeners.\nThe grid.jsx file has the LaTeX editor and the editor.jsx file has the WYSIWYG.
\n
To build the minified js you press
\n
npm run minify\n
\n
To create the executable in a dist folder run (!Attention! This will trigger the minification which takes a lot of time)
\n
npm run dist\n
\n
Issues:
\n\n
Compilation and configurations for Mac (probably works, will test soon) and Windows.
\n
Configure auto-updates (work on linux and windows).
\n
Detect latex change and move pdf to that page.
\n
Better memory handling of Ace editor.
\n
Open files with the app without the app being open
\n
Configure KaTeX to take both $math$ and $$math$$ and interpret them accordingly.
\n
Open formula module on math selection at simple.
\n\n
Roadmap:
\n\n
Either move to Semantic UI or Material UI beta for performance.
\n
Integration with cloud servicesIPFS for collaboration (working on it).
\n\n
",
"readmeOriginal": "
Infinitex
\n
\n
This is my first attempt to write a desktop app with electron and learn the fantastic reactjs library. The editor is far from complete but I use it personally and I wanted to open-source it so that others can help with it.
\n
The one part of the app is a LaTeX editor with search functionality and simplified bibliography and packages handling. The other part is a WYSIWYG editor based on quilljs. The simple part also supports encrypted documents.
\n
I have built it on Debian Linux and I tried on Windows but, like always, everything in there is crappy compared to Linux so I just dropped it. I still have not tested on mac but I plan on doing it soon. Otherwise I expect that the program will be fully functional for anyone who wants to develop it on their mac.
In order to run LaTeX you need to have an installed version of the interpeter like TeXlive, MacTex or MikTex.
\n
To start the process go to the folder, open a terminal there and press
\n
yarn && yarn preminify\nnpm start\n
\n
The file Infinitex.jsx is only used for react-dom. The app.jsx file separates the two environments and has width and height event listeners.\nThe grid.jsx file has the LaTeX editor and the editor.jsx file has the WYSIWYG.
\n
To build the minified js you press
\n
npm run minify\n
\n
To create the executable in a dist folder run (!Attention! This will trigger the minification which takes a lot of time)
\n
npm run dist\n
\n
Issues:
\n\n
Compilation and configurations for Mac (probably works, will test soon) and Windows.
\n
Configure auto-updates (work on linux and windows).
\n
Detect latex change and move pdf to that page.
\n
Better memory handling of Ace editor.
\n
Open files with the app without the app being open
\n
Configure KaTeX to take both $math$ and $$math$$ and interpret them accordingly.
\n
Open formula module on math selection at simple.
\n\n
Roadmap:
\n\n
Either move to Semantic UI or Material UI beta for performance.
\n
Integration with cloud servicesIPFS for collaboration (working on it).
I open-source almost everything I can, and I try to reply everyone needing help using these projects. Obviously,\nthis takes time. You can use these projects in your applications for free! You can even change the source code and redistribute (even resell it).
\n
If you get some profit from this or just want to encourage me to continue creating stuff, there are few ways you can do it:
\n
\n
Starring and sharing the project
\n
—make one-time donations via PayPal.
\n
—set up monthly donation via Patreon and get interesting news about what I'm doing.
\n
—send bitcoins or ethereum to this address: 19jHGagJWeVvuNjN3kaBoAszXd9ea9gKzp.
I open-source almost everything I can, and I try to reply everyone needing help using these projects. Obviously,\nthis takes time. You can use these projects in your applications for free! You can even change the source code and redistribute (even resell it).
\n
If you get some profit from this or just want to encourage me to continue creating stuff, there are few ways you can do it:
\n
\n
Starring and sharing the project
\n
—make one-time donations via PayPal.
\n
—set up monthly donation via Patreon and get interesting news about what I'm doing.
\n
—send bitcoins or ethereum to this address: 19jHGagJWeVvuNjN3kaBoAszXd9ea9gKzp.
A Software to interactively edit data in a graphical manner.
\n
\n\n\n \n\n \n\nWe have all worked with data at some point of time. Now, depending on the source, sometimes the data may not be regular, smooth and uniform and requires refinement before applying for any practical use. This software lets you do that very easily and efficiently in a graphical way including many others useful data operation.
\n
Features
\n\n
Edit one or multiple points by dragging with mouse and keyboard keys.
\n
Automatically smooth data using spline and linear Kernel smoother.
\n
Fit any function to the data.
\n
Plot any 2D and gridded 3D data with LaTeX rendering support.
\n
Export images in five format in any resolution.
\n
Simultaneously work with multiple datasets.
\n
Fill missing values.
\n
Remove bad data points.
\n
Repeat or mirror data any required times.
\n
Filter data subject to a given condition.
\n
Swap data between two lines or surfaces.
\n
Supports undo/redo.
\n
Change sign of any selected part of the data.
\n
Spreadsheet editor with all basic excel like features including formula parsing.\n And many more...
\n\n
Download and installation
\n
The software is available as pre-built binaries for different platforms. Install the appropriate installer for your system available in releases section of this repo. Also available as snap for linux users. \n
\n
Quick Reference
\n
For a quick reference, documentation and FAQs check this
A Software to interactively edit data in a graphical manner.
\n
\n\n\n \n\n \n\nWe have all worked with data at some point of time. Now, depending on the source, sometimes the data may not be regular, smooth and uniform and requires refinement before applying for any practical use. This software lets you do that very easily and efficiently in a graphical way including many others useful data operation.
\n
Features
\n\n
Edit one or multiple points by dragging with mouse and keyboard keys.
\n
Automatically smooth data using spline and linear Kernel smoother.
\n
Fit any function to the data.
\n
Plot any 2D and gridded 3D data with LaTeX rendering support.
\n
Export images in five format in any resolution.
\n
Simultaneously work with multiple datasets.
\n
Fill missing values.
\n
Remove bad data points.
\n
Repeat or mirror data any required times.
\n
Filter data subject to a given condition.
\n
Swap data between two lines or surfaces.
\n
Supports undo/redo.
\n
Change sign of any selected part of the data.
\n
Spreadsheet editor with all basic excel like features including formula parsing.\n And many more...
\n\n
Download and installation
\n
The software is available as pre-built binaries for different platforms. Install the appropriate installer for your system available in releases section of this repo. Also available as snap for linux users. \n
\n
Quick Reference
\n
For a quick reference, documentation and FAQs check this
IPTVnator is a video player application that provides support for the playback of IPTV playlists (m3u, m3u8). The application allows to import playlists by using remote URLs or per file upload from the file system. Additionally there is a support of EPG information XMLTV-based which can be provided by URL.
\n
The application is an cross-platform and open source project based on Electron and Angular.
\n
\n
Features
\n
\n
M3u and M3u8 playlists support 📺
\n
Upload playlists from a file system 📂
\n
Add remote playlists via URL 🔗
\n
Playlists auto-update feature
\n
Open playlist from the file system
\n
Search for channels 🔍
\n
EPG support (TV Guide) with detailed info
\n
TV archive/catchup/timeshift
\n
Group-based channels list
\n
Save channels as favorites
\n
HTML video player with hls.js support or Video.js based player
\n
Internalization, currently 3 languages are supported (en, ru, de)
\n
Set custom \"User Agent\" header for a playlist
\n
Light and Dark theme
\n
\n
Screenshots:
\n
\n\n
\n
Welcome screen: Playlists overview
\n
Main player interface with channels sidebar and video player
\n
\n\n\n
\n
\n
\n
\n
\n
Welcome screen: Add playlist via file upload
\n
Welcome screen: Add playlist via URL
\n
\n
\n
\n
\n
\n
\n
EPG Sidebar: TV guide on the right side
\n
General application settings
\n
\n
\n
\n
\n
\n
\n
Playlist settings
\n
\n
\n
\n
\n
\n
\n\n
\n
Note: First version of the application which was developed as a PWA is available in an extra git branch.
\n
Download
\n
Download the latest version of the application for macOS, Windows and Linux from the release page.
\n
IPTVnator is also available as a snap package:
\n
$ sudo snap install iptvnator\n
\n
Also available as an Arch PKG, iptvnator-bin, in the AUR (using your favourite AUR-helper, .e.g. yay)
\n
$ yay -S iptvnator-bin\n
\n
\n
\n
How to build
\n
Requirements: node.js with npm.
\n\n
\n
Clone this repository and install all project dependencies with:
\n
$ npm install\n
\n
\n
\n
To build the application on your local machine use one of the following commands:
\n
# linux\n$ npm run electron:build:linux\n
\n
#mac\n$ npm run electron:build:mac\n
\n
# windows\n$ npm run electron:build:windows\n
\n
\n\n
This command will produce the distributable assets in the release folder based on the configuration from electron-builder which is stored in electron-builder.json and package.json. Check the API description of electron-builder and adapt the configuration if you need some special configuration for you environment.
\n
Note: Don’t expect that you can build app for all platforms on one platform. Read details
\n
Disclaimer
\n
IPTVnator doesn't provide any playlists or other digital content.
\n
",
- "readmeOriginal": "
IPTVnator - IPTV Player Application
\n
\n \n
\n
\n \n
\n
IPTVnator is a video player application that provides support for the playback of IPTV playlists (m3u, m3u8). The application allows to import playlists by using remote URLs or per file upload from the file system. Additionally there is a support of EPG information XMLTV-based which can be provided by URL.
\n
The application is an cross-platform and open source project based on Electron and Angular.
\n
\n
Features
\n
\n
M3u and M3u8 playlists support 📺
\n
Upload playlists from a file system 📂
\n
Add remote playlists via URL 🔗
\n
Playlists auto-update feature
\n
Open playlist from the file system
\n
Search for channels 🔍
\n
EPG support (TV Guide) with detailed info
\n
TV archive/catchup/timeshift
\n
Group-based channels list
\n
Save channels as favorites
\n
HTML video player with hls.js support or Video.js based player
\n
Internalization, currently 3 languages are supported (en, ru, de)
\n
Set custom \"User Agent\" header for a playlist
\n
Light and Dark theme
\n
\n
Screenshots:
\n
\n\n
\n
Welcome screen: Playlists overview
\n
Main player interface with channels sidebar and video player
\n
\n\n\n
\n
\n
\n
\n
\n
Welcome screen: Add playlist via file upload
\n
Welcome screen: Add playlist via URL
\n
\n
\n
\n
\n
\n
\n
EPG Sidebar: TV guide on the right side
\n
General application settings
\n
\n
\n
\n
\n
\n
\n
Playlist settings
\n
\n
\n
\n
\n
\n
\n\n
\n
Note: First version of the application which was developed as a PWA is available in an extra git branch.
\n
Download
\n
Download the latest version of the application for macOS, Windows and Linux from the release page.
\n
IPTVnator is also available as a snap package:
\n
$ sudo snap install iptvnator\n
\n
Also available as an Arch PKG, iptvnator-bin, in the AUR (using your favourite AUR-helper, .e.g. yay)
\n
$ yay -S iptvnator-bin\n
\n
\n
\n
How to build
\n
Requirements: node.js with npm.
\n\n
\n
Clone this repository and install all project dependencies with:
\n
$ npm install\n
\n
\n
\n
To build the application on your local machine use one of the following commands:
\n
# linux\n$ npm run electron:build:linux\n
\n
#mac\n$ npm run electron:build:mac\n
\n
# windows\n$ npm run electron:build:windows\n
\n
\n\n
This command will produce the distributable assets in the release folder based on the configuration from electron-builder which is stored in electron-builder.json and package.json. Check the API description of electron-builder and adapt the configuration if you need some special configuration for you environment.
\n
Note: Don’t expect that you can build app for all platforms on one platform. Read details
\n
Disclaimer
\n
IPTVnator doesn't provide any playlists or other digital content.
android : Android app project. Please open with Android Studio.
\n
dist : Bundled electron app stuff. All executable and installable of the electron app are generated in this folder. You can generate this by npm run prepack, npm run pack, and npm run release scripts.
\n
compiled : Compiled web app resources from npm run build script. The resources are for deploying the web app.
\n
electron : Compiled electron resources from npm run build:electron script. You can run it by npm start script. The resources are for packaging the electron app.
\n
ios : iOS app project. Please open with XCode.
\n
src : Source code.
\n
\n
Build
\n
Please copy .env.default file and create a file named .env in the root of the project directory, or the build will fail.
\n
Web app
\n
# Install dependencies\nnpm i\n\n# Run webpack and open browser\nnpm run dev:cloud
\n
Electron app
\n
# Install dependencies\nnpm i\n\n# Run webpack\nnpm run dev:webpack\n\n# Run electron (You have to open another terminal to run this)\nnpm run dev:electron
\n
\n
For Windows users, If npm run dev:electron doesn't spawn an electron window, please try again after removing %APPDATA%\\electron directory.
android : Android app project. Please open with Android Studio.
\n
dist : Bundled electron app stuff. All executable and installable of the electron app are generated in this folder. You can generate this by npm run prepack, npm run pack, and npm run release scripts.
\n
compiled : Compiled web app resources from npm run build script. The resources are for deploying the web app.
\n
electron : Compiled electron resources from npm run build:electron script. You can run it by npm start script. The resources are for packaging the electron app.
\n
ios : iOS app project. Please open with XCode.
\n
src : Source code.
\n
\n
Build
\n
Please copy .env.default file and create a file named .env in the root of the project directory, or the build will fail.
\n
Web app
\n
# Install dependencies\nnpm i\n\n# Run webpack and open browser\nnpm run dev:cloud
\n
Electron app
\n
# Install dependencies\nnpm i\n\n# Run webpack\nnpm run dev:webpack\n\n# Run electron (You have to open another terminal to run this)\nnpm run dev:electron
\n
\n
For Windows users, If npm run dev:electron doesn't spawn an electron window, please try again after removing %APPDATA%\\electron directory.
Have a bug or a feature request? First, read the\nissue guidelines and search for existing and\nclosed issues. If your problem or idea is not addressed yet, please open a new issue.
Please read through our contributing guidelines and code of conduct. Included are directions\nfor opening issues, coding standards, and notes on development.
\n
Editor preferences are available in the editor config for easy use in\ncommon text editors. Read more and download plugins at editorconfig.org.
\n
Developing
\n
Development on Insomnia can be done on Mac, Windows, or Linux as long as you have\nNodeJS and Git. See the .nvmrc file located in the project for the correct Node version.
\n\nInitial Dev Setup\n
This repository is structured as a monorepo and contains many Node.JS packages. Each package has\nits own set of commands, but the most common commands are available from the\nroot package.json and can be accessed using the npm run ... command. Here\nare the only three commands you should need to start developing on the app.
\n
# Install and Link Dependencies\nnpm run bootstrap\n\n# Run Tests\nnpm test\n\n# Start App with Live Reload\nnpm run app-start
\n
If you are on Linux, you may need to install the following supporting packages
Have a bug or a feature request? First, read the\nissue guidelines and search for existing and\nclosed issues. If your problem or idea is not addressed yet, please open a new issue.
Please read through our contributing guidelines and code of conduct. Included are directions\nfor opening issues, coding standards, and notes on development.
\n
Editor preferences are available in the editor config for easy use in\ncommon text editors. Read more and download plugins at editorconfig.org.
\n
Developing
\n
Development on Insomnia can be done on Mac, Windows, or Linux as long as you have\nNodeJS and Git. See the .nvmrc file located in the project for the correct Node version.
\n\nInitial Dev Setup\n
This repository is structured as a monorepo and contains many Node.JS packages. Each package has\nits own set of commands, but the most common commands are available from the\nroot package.json and can be accessed using the npm run ... command. Here\nare the only three commands you should need to start developing on the app.
\n
# Install and Link Dependencies\nnpm run bootstrap\n\n# Run Tests\nnpm test\n\n# Start App with Live Reload\nnpm run app-start
\n
If you are on Linux, you may need to install the following supporting packages
A Software to interactively edit data in a graphical manner.
\n
\n\n\n \n\n \n\nWe have all worked with data at some point of time. Now, depending on the source, sometimes the data may not be regular, smooth and uniform and requires refinement before applying for any practical use. This software lets you do that very easily and efficiently in a graphical way including many others useful data operation.
\n
Features
\n\n
Edit one or multiple points by dragging with mouse and keyboard keys.
\n
Automatically smooth data using spline and linear Kernel smoother.
\n
Fit any function to the data.
\n
Plot any 2D and gridded 3D data with LaTeX rendering support.
\n
Export images in five format in any resolution.
\n
Simultaneously work with multiple datasets.
\n
Fill missing values.
\n
Remove bad data points.
\n
Repeat or mirror data any required times.
\n
Filter data subject to a given condition.
\n
Swap data between two lines or surfaces.
\n
Supports undo/redo.
\n
Change sign of any selected part of the data.
\n
Spreadsheet editor with all basic excel like features including formula parsing.\n And many more...
\n\n
Download and installation
\n
The software is available as pre-built binaries for different platforms. Install the appropriate installer for your system available in releases section of this repo. Also available as snap for linux users. \n
\n
Quick Reference
\n
For a quick reference, documentation and FAQs check this
A Software to interactively edit data in a graphical manner.
\n
\n\n\n \n\n \n\nWe have all worked with data at some point of time. Now, depending on the source, sometimes the data may not be regular, smooth and uniform and requires refinement before applying for any practical use. This software lets you do that very easily and efficiently in a graphical way including many others useful data operation.
\n
Features
\n\n
Edit one or multiple points by dragging with mouse and keyboard keys.
\n
Automatically smooth data using spline and linear Kernel smoother.
\n
Fit any function to the data.
\n
Plot any 2D and gridded 3D data with LaTeX rendering support.
\n
Export images in five format in any resolution.
\n
Simultaneously work with multiple datasets.
\n
Fill missing values.
\n
Remove bad data points.
\n
Repeat or mirror data any required times.
\n
Filter data subject to a given condition.
\n
Swap data between two lines or surfaces.
\n
Supports undo/redo.
\n
Change sign of any selected part of the data.
\n
Spreadsheet editor with all basic excel like features including formula parsing.\n And many more...
\n\n
Download and installation
\n
The software is available as pre-built binaries for different platforms. Install the appropriate installer for your system available in releases section of this repo. Also available as snap for linux users. \n
\n
Quick Reference
\n
For a quick reference, documentation and FAQs check this
Invizi is a 100% open source, private and free cryptocurrency manager.
\n
With Invizi you can safely track and trade your digital assets - all your data is local, encrypted and never leaves your computer. Invizi is a public good and will always be free to use.
\n
\n
Our mission is to empower people to manage their digital assets without compromising their privacy. We want to usher in a world without data breaches, predatory ad models, commoditization of user’s data and abuse of privacy.
Invizi is a 100% open source, private and free cryptocurrency manager.
\n
With Invizi you can safely track and trade your digital assets - all your data is local, encrypted and never leaves your computer. Invizi is a public good and will always be free to use.
\n
\n
Our mission is to empower people to manage their digital assets without compromising their privacy. We want to usher in a world without data breaches, predatory ad models, commoditization of user’s data and abuse of privacy.
Create project with template like side-menu,tab,blank
\n
Live serve ionic app
\n
App build for IOS and Android
\n
Genrate Page,Service,Component,Pipe, etc...
\n
Install & Uninstall cordova plugins
\n
Mange app details like App Id, App name, App version, App author, App email
\n
Run app in simulator IOS / Android
\n
Create Splash screen and App Icons (Put Icons and Splash in resources folder in App directory).
\n
\n
Future Goals
\n
\n
Provide Support React, Vue for ionic
\n
Support feature for Anguler 2 CLI for Direct Anguler project
\n
Ionic Compatible IDE
\n
\n
How to Use
\n
MAC
\n
Download DMG file and install and use but we not support sudo feature so please in that directory where sudo not required soon we will give that feature.
Create project with template like side-menu,tab,blank
\n
Live serve ionic app
\n
App build for IOS and Android
\n
Genrate Page,Service,Component,Pipe, etc...
\n
Install & Uninstall cordova plugins
\n
Mange app details like App Id, App name, App version, App author, App email
\n
Run app in simulator IOS / Android
\n
Create Splash screen and App Icons (Put Icons and Splash in resources folder in App directory).
\n
\n
Future Goals
\n
\n
Provide Support React, Vue for ionic
\n
Support feature for Anguler 2 CLI for Direct Anguler project
\n
Ionic Compatible IDE
\n
\n
How to Use
\n
MAC
\n
Download DMG file and install and use but we not support sudo feature so please in that directory where sudo not required soon we will give that feature.
android : Android app project. Please open with Android Studio.
\n
dist : Bundled electron app stuff. All executable and installable of the electron app are generated in this folder. You can generate this by npm run prepack, npm run pack, and npm run release scripts.
\n
compiled : Compiled web app resources from npm run build script. The resources are for deploying the web app.
\n
electron : Compiled electron resources from npm run build:electron script. You can run it by npm start script. The resources are for packaging the electron app.
\n
ios : iOS app project. Please open with XCode.
\n
src : Source code.
\n
\n
Build
\n
Please copy .env.default file and create a file named .env in the root of the project directory, or the build will fail.
\n
Web app
\n
# Install dependencies\nnpm i\n\n# Run webpack and open browser\nnpm run dev:cloud
\n
Electron app
\n
# Install dependencies\nnpm i\n\n# Run webpack\nnpm run dev:webpack\n\n# Run electron (You have to open another terminal to run this)\nnpm run dev:electron
\n
\n
For Windows users, If npm run dev:electron doesn't spawn an electron window, please try again after removing %APPDATA%\\electron directory.
android : Android app project. Please open with Android Studio.
\n
dist : Bundled electron app stuff. All executable and installable of the electron app are generated in this folder. You can generate this by npm run prepack, npm run pack, and npm run release scripts.
\n
compiled : Compiled web app resources from npm run build script. The resources are for deploying the web app.
\n
electron : Compiled electron resources from npm run build:electron script. You can run it by npm start script. The resources are for packaging the electron app.
\n
ios : iOS app project. Please open with XCode.
\n
src : Source code.
\n
\n
Build
\n
Please copy .env.default file and create a file named .env in the root of the project directory, or the build will fail.
\n
Web app
\n
# Install dependencies\nnpm i\n\n# Run webpack and open browser\nnpm run dev:cloud
\n
Electron app
\n
# Install dependencies\nnpm i\n\n# Run webpack\nnpm run dev:webpack\n\n# Run electron (You have to open another terminal to run this)\nnpm run dev:electron
\n
\n
For Windows users, If npm run dev:electron doesn't spawn an electron window, please try again after removing %APPDATA%\\electron directory.
# install dependencies\nyarn\n\n# serve with hot reload at localhost:9080\nyarn dev\n\n# run unit tests\nyarn test\n\n# unit and coverage\nyarn cover\n\n# build electron application for production\nyarn build
# install dependencies\nyarn\n\n# serve with hot reload at localhost:9080\nyarn dev\n\n# run unit tests\nyarn test\n\n# unit and coverage\nyarn cover\n\n# build electron application for production\nyarn build
IPTVnator is a video player application that provides support for the playback of IPTV playlists (m3u, m3u8). The application allows to import playlists by using remote URLs or per file upload from the file system. Additionally there is a support of EPG information XMLTV-based which can be provided by URL.
\n
The application is an cross-platform and open source project based on Electron and Angular.
\n
\n
Features
\n
\n
M3u and M3u8 playlists support 📺
\n
Upload playlists from a file system 📂
\n
Add remote playlists via URL 🔗
\n
Playlists auto-update feature
\n
Open playlist from the file system
\n
Search for channels 🔍
\n
EPG support (TV Guide) with detailed info
\n
TV archive/catchup/timeshift
\n
Group-based channels list
\n
Save channels as favorites
\n
HTML video player with hls.js support or Video.js based player
\n
Internalization, currently 3 languages are supported (en, ru, de)
\n
Set custom \"User Agent\" header for a playlist
\n
Light and Dark theme
\n
\n
Screenshots:
\n
\n\n
\n
Welcome screen: Playlists overview
\n
Main player interface with channels sidebar and video player
\n
\n\n\n
\n
\n
\n
\n
\n
Welcome screen: Add playlist via file upload
\n
Welcome screen: Add playlist via URL
\n
\n
\n
\n
\n
\n
\n
EPG Sidebar: TV guide on the right side
\n
General application settings
\n
\n
\n
\n
\n
\n
\n
Playlist settings
\n
\n
\n
\n
\n
\n
\n\n
\n
Note: First version of the application which was developed as a PWA is available in an extra git branch.
\n
Download
\n
Download the latest version of the application for macOS, Windows and Linux from the release page.
\n
IPTVnator is also available as a snap package:
\n
$ sudo snap install iptvnator\n
\n
Also available as an Arch PKG, iptvnator-bin, in the AUR (using your favourite AUR-helper, .e.g. yay)
\n
$ yay -S iptvnator-bin\n
\n
\n
\n
How to build
\n
Requirements: node.js with npm.
\n\n
\n
Clone this repository and install all project dependencies with:
\n
$ npm install\n
\n
\n
\n
To build the application on your local machine use one of the following commands:
\n
# linux\n$ npm run electron:build:linux\n
\n
#mac\n$ npm run electron:build:mac\n
\n
# windows\n$ npm run electron:build:windows\n
\n
\n\n
This command will produce the distributable assets in the release folder based on the configuration from electron-builder which is stored in electron-builder.json and package.json. Check the API description of electron-builder and adapt the configuration if you need some special configuration for you environment.
\n
Note: Don’t expect that you can build app for all platforms on one platform. Read details
\n
Disclaimer
\n
IPTVnator doesn't provide any playlists or other digital content.
\n
",
+ "readmeOriginal": "
IPTVnator - IPTV Player Application
\n
\n \n
\n
\n \n
\n
IPTVnator is a video player application that provides support for the playback of IPTV playlists (m3u, m3u8). The application allows to import playlists by using remote URLs or per file upload from the file system. Additionally there is a support of EPG information XMLTV-based which can be provided by URL.
\n
The application is an cross-platform and open source project based on Electron and Angular.
\n
\n
Features
\n
\n
M3u and M3u8 playlists support 📺
\n
Upload playlists from a file system 📂
\n
Add remote playlists via URL 🔗
\n
Playlists auto-update feature
\n
Open playlist from the file system
\n
Search for channels 🔍
\n
EPG support (TV Guide) with detailed info
\n
TV archive/catchup/timeshift
\n
Group-based channels list
\n
Save channels as favorites
\n
HTML video player with hls.js support or Video.js based player
\n
Internalization, currently 3 languages are supported (en, ru, de)
\n
Set custom \"User Agent\" header for a playlist
\n
Light and Dark theme
\n
\n
Screenshots:
\n
\n\n
\n
Welcome screen: Playlists overview
\n
Main player interface with channels sidebar and video player
\n
\n\n\n
\n
\n
\n
\n
\n
Welcome screen: Add playlist via file upload
\n
Welcome screen: Add playlist via URL
\n
\n
\n
\n
\n
\n
\n
EPG Sidebar: TV guide on the right side
\n
General application settings
\n
\n
\n
\n
\n
\n
\n
Playlist settings
\n
\n
\n
\n
\n
\n
\n\n
\n
Note: First version of the application which was developed as a PWA is available in an extra git branch.
\n
Download
\n
Download the latest version of the application for macOS, Windows and Linux from the release page.
\n
IPTVnator is also available as a snap package:
\n
$ sudo snap install iptvnator\n
\n
Also available as an Arch PKG, iptvnator-bin, in the AUR (using your favourite AUR-helper, .e.g. yay)
\n
$ yay -S iptvnator-bin\n
\n
\n
\n
How to build
\n
Requirements: node.js with npm.
\n\n
\n
Clone this repository and install all project dependencies with:
\n
$ npm install\n
\n
\n
\n
To build the application on your local machine use one of the following commands:
\n
# linux\n$ npm run electron:build:linux\n
\n
#mac\n$ npm run electron:build:mac\n
\n
# windows\n$ npm run electron:build:windows\n
\n
\n\n
This command will produce the distributable assets in the release folder based on the configuration from electron-builder which is stored in electron-builder.json and package.json. Check the API description of electron-builder and adapt the configuration if you need some special configuration for you environment.
\n
Note: Don’t expect that you can build app for all platforms on one platform. Read details
\n
Disclaimer
\n
IPTVnator doesn't provide any playlists or other digital content.
The goal of this project is to give you a desktop application that you can\ndownload and run games from itch.io with. Additionally you\nshould be able to update games and get notified when games are updated. The\ngoal is not to replace the itch.io website.
If you'd like to develop the app instead, read the Getting Started page of the developer guide.
\n
About itch-setup
\n
itch-setup is the installer program for the itch app.
\n
It's a Go executable that runs on Windows, macOS and Linux, and downloads the latest\nversion of the app directly from https://itch.io.
\n
Although itch-setup is normally served from https://itch.io/app, the canonical\nsource to download it (e.g. for packaging purposes), is the following download server:
The goal of this project is to give you a desktop application that you can\ndownload and run games from itch.io with. Additionally you\nshould be able to update games and get notified when games are updated. The\ngoal is not to replace the itch.io website.
If you'd like to develop the app instead, read the Getting Started page of the developer guide.
\n
About itch-setup
\n
itch-setup is the installer program for the itch app.
\n
It's a Go executable that runs on Windows, macOS and Linux, and downloads the latest\nversion of the app directly from https://itch.io.
\n
Although itch-setup is normally served from https://itch.io/app, the canonical\nsource to download it (e.g. for packaging purposes), is the following download server:
Invizi is a 100% open source, private and free cryptocurrency manager.
\n
With Invizi you can safely track and trade your digital assets - all your data is local, encrypted and never leaves your computer. Invizi is a public good and will always be free to use.
\n
\n
Our mission is to empower people to manage their digital assets without compromising their privacy. We want to usher in a world without data breaches, predatory ad models, commoditization of user’s data and abuse of privacy.
Invizi is a 100% open source, private and free cryptocurrency manager.
\n
With Invizi you can safely track and trade your digital assets - all your data is local, encrypted and never leaves your computer. Invizi is a public good and will always be free to use.
\n
\n
Our mission is to empower people to manage their digital assets without compromising their privacy. We want to usher in a world without data breaches, predatory ad models, commoditization of user’s data and abuse of privacy.
Debug Node.js code with Chrome Developer Tools on Linux, Windows and OS X.
\n
This software aims to make things easier 😄. With ironNode you have the full power of JavaScript debugging within Chrome Developer Tools.
\n
Installation
\n
npm install iron-node -g;
\n
Usage
\n
The usage is the same as node. Use iron-node instead of node. \nKeep in mind to place the keyword debugger; to a place where you want to stop. Run a debug session with the given JavaScript file.
Debug Node.js code with Chrome Developer Tools on Linux, Windows and OS X.
\n
This software aims to make things easier 😄. With ironNode you have the full power of JavaScript debugging within Chrome Developer Tools.
\n
Installation
\n
npm install iron-node -g;
\n
Usage
\n
The usage is the same as node. Use iron-node instead of node. \nKeep in mind to place the keyword debugger; to a place where you want to stop. Run a debug session with the given JavaScript file.
The goal of this project is to give you a desktop application that you can\ndownload and run games from itch.io with. Additionally you\nshould be able to update games and get notified when games are updated. The\ngoal is not to replace the itch.io website.
If you'd like to develop the app instead, read the Getting Started page of the developer guide.
\n
About itch-setup
\n
itch-setup is the installer program for the itch app.
\n
It's a Go executable that runs on Windows, macOS and Linux, and downloads the latest\nversion of the app directly from https://itch.io.
\n
Although itch-setup is normally served from https://itch.io/app, the canonical\nsource to download it (e.g. for packaging purposes), is the following download server:
The goal of this project is to give you a desktop application that you can\ndownload and run games from itch.io with. Additionally you\nshould be able to update games and get notified when games are updated. The\ngoal is not to replace the itch.io website.
If you'd like to develop the app instead, read the Getting Started page of the developer guide.
\n
About itch-setup
\n
itch-setup is the installer program for the itch app.
\n
It's a Go executable that runs on Windows, macOS and Linux, and downloads the latest\nversion of the app directly from https://itch.io.
\n
Although itch-setup is normally served from https://itch.io/app, the canonical\nsource to download it (e.g. for packaging purposes), is the following download server:
Maintainers or forks welcome: the original James team aren't able to spend the same amount of time on James anymore.
\n
We suggest looking at HTTP Toolkit as an actively maintained open-source alternative.
\n\n
James
\n
\n
James is an HTTP Proxy and Monitor that enables developers to view and intercept requests made from the browser.\nIt is an open-source alternative to the popular developer tool Charles
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
\n
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
\n
THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
\n
",
"readmeOriginal": "
This project is in maintenance mode
\n
Maintainers or forks welcome: the original James team aren't able to spend the same amount of time on James anymore.
\n
We suggest looking at HTTP Toolkit as an actively maintained open-source alternative.
\n\n
James
\n
\n
James is an HTTP Proxy and Monitor that enables developers to view and intercept requests made from the browser.\nIt is an open-source alternative to the popular developer tool Charles
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
\n
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
\n
THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
# install dependencies\nyarn\n\n# serve with hot reload at localhost:9080\nyarn dev\n\n# run unit tests\nyarn test\n\n# unit and coverage\nyarn cover\n\n# build electron application for production\nyarn build
# install dependencies\nyarn\n\n# serve with hot reload at localhost:9080\nyarn dev\n\n# run unit tests\nyarn test\n\n# unit and coverage\nyarn cover\n\n# build electron application for production\nyarn build
jamovi is a free and open statistics package, which is easy to use, and designed to be familiar to users of SPSS. It provides a spreadsheet editor, and a range of statistical analyses. jamovi can provide R syntax for each analysis that is run, and additional analyses for jamovi can be developed using the R language.
this launches an embedded web-server, and jamovi can be accessed with a web-browser at the url http://localhost:41337
\n
building
\n
it's possible to modify the source code, and rebuild the docker image, to try out your changes -- however this can be time consuming. it's often easier to just rebuild the component of interest, rather than rebuilding everything.
\n
to this end, a build command is available from inside the container. the default configuration mounts the jamovi source folder (i.e. this repo) as a volume inside the container, and the build command uses it (including any changes you make) to rebuild the component of interest.
note that these require that the docker container is running. depending on which component has been rebuilt, it may be necessary to restart the docker container for the changes to take effect (docker-compose restart).
\n
",
"readmeOriginal": "
jamovi
\n
jamovi is a free and open statistics package, which is easy to use, and designed to be familiar to users of SPSS. It provides a spreadsheet editor, and a range of statistical analyses. jamovi can provide R syntax for each analysis that is run, and additional analyses for jamovi can be developed using the R language.
this launches an embedded web-server, and jamovi can be accessed with a web-browser at the url http://localhost:41337
\n
building
\n
it's possible to modify the source code, and rebuild the docker image, to try out your changes -- however this can be time consuming. it's often easier to just rebuild the component of interest, rather than rebuilding everything.
\n
to this end, a build command is available from inside the container. the default configuration mounts the jamovi source folder (i.e. this repo) as a volume inside the container, and the build command uses it (including any changes you make) to rebuild the component of interest.
note that these require that the docker container is running. depending on which component has been rebuilt, it may be necessary to restart the docker container for the changes to take effect (docker-compose restart).
Joplin is a free, open source note taking and to-do application, which can handle a large number of notes organised into notebooks. The notes are searchable, can be copied, tagged and modified either from the applications directly or from your own text editor. The notes are in Markdown format.
\n
Notes exported from Evernote via .enex files can be imported into Joplin, including the formatted content (which is converted to Markdown), resources (images, attachments, etc.) and complete metadata (geolocation, updated time, created time, etc.). Plain Markdown files can also be imported.
\n
The notes can be synchronised with various cloud services including Nextcloud, Dropbox, OneDrive, WebDAV or the file system (for example with a network directory). When synchronising the notes, notebooks, tags and other metadata are saved to plain text files which can be easily inspected, backed up and moved around.
\n
The application is available for Windows, Linux, macOS, Android and iOS (the terminal app also works on FreeBSD). A Web Clipper, to save web pages and screenshots from your browser, is also available for Firefox and Chrome.
\n
\n
Installation
\n
Three types of applications are available: for the desktop (Windows, macOS and Linux), for mobile (Android and iOS) and for terminal (Windows, macOS, Linux and FreeBSD). All applications have similar user interfaces and can synchronise with each other.
\n
Desktop applications
\n
\n\n
\n
Operating System
\n
Download
\n
\n\n\n
\n
Windows (32 and 64-bit)
\n
\n
\n
\n
macOS
\n
\n
\n
\n
Linux
\n
\n
\n\n
\n
On Windows, you may also use the Portable version. The portable application allows installing the software on a portable device such as a USB key. Simply copy the file JoplinPortable.exe in any directory on that USB key ; the application will then create a directory called \"JoplinProfile\" next to the executable file.
\n
On Linux, the recommended way is to use the following installation script as it will handle the desktop icon too:
By default, the application binary will be installed under ~/.joplin-bin. You may change this directory if needed. Alternatively, if your npm permissions are setup as described here (Option 2) then simply running npm -g install joplin would work.
There are other ways to install the terminal application. However, they are not supported and problems must be reported to the upstream projects.
\n
\n\n
\n
Operating system
\n
Method
\n
\n\n\n
\n
macOS
\n
brew install joplin
\n
\n
\n
Arch Linux
\n
An Arch Linux package is available here. To install it, use an AUR wrapper such as yay: yay -S joplin. Both the CLI tool (type joplin) and desktop app (type joplin-desktop) are packaged. You can also install a compiled version with the chaotic-aur repository. For support, please go to the GitHub repo. If you are interested in pre-release you have joplin-beta.
\n
\n\n
\n
Web Clipper
\n
The Web Clipper is a browser extension that allows you to save web pages and screenshots from your browser. For more information on how to install and use it, see the Web Clipper Help Page.
Synchronisation with various services, including Nextcloud, Dropbox, WebDAV and OneDrive.
\n
Offline first, so the entire data is always available on the device even without an internet connection.
\n
Import Enex files (Evernote export format) and Markdown files.
\n
Export JEX files (Joplin Export format) and raw files.
\n
Support notes, to-dos, tags and notebooks.
\n
Sort notes by multiple criteria - title, updated time, etc.
\n
Support for alarms (notifications) in mobile and desktop applications.
\n
Markdown notes, which are rendered with images and formatting in the desktop and mobile applications. Support for extra features such as math notation and checkboxes.
\n
Choice of both Markdown and Rich Text (WYSIWYG) editors.
\n
File attachment support - images are displayed, other files are linked and can be opened in the relevant application.
\n
Inline display of PDF, video and audio files.
\n
Goto Anything feature.
\n
Search functionality.
\n
Geo-location support.
\n
Supports multiple languages.
\n
External editor support - open notes in your favorite external editor with one click in Joplin.
\n
Extensible functionality through plugin and data APIs.
\n
Template support with data variables for auto creation of time & dates.
\n
Custom CSS support for customisation of both the rendered markdown and overall user interface.
\n
Customisable layout allows toggling, movement and sizing of various elements.
\n
Keyboard shortcuts are editable and allow binding of most Joplin commands with export/import functionality.
\n
\n
Importing
\n
Importing from Evernote
\n
Joplin was designed as a replacement for Evernote and so can import complete Evernote notebooks, as well as notes, tags, resources (attached files) and note metadata (such as author, geo-location, etc.) via ENEX files. In terms of data, the only two things that might slightly differ are:
\n
\n
\n
Recognition data - Evernote images, in particular scanned (or photographed) documents have recognition data associated with them. It is the text that Evernote has been able to recognise in the document. This data is not preserved when the note are imported into Joplin. However, should it become supported in the search tool or other parts of Joplin, it should be possible to regenerate this recognition data since the actual image would still be available.
\n
\n
\n
Colour, font sizes and faces - Evernote text is stored as HTML and this is converted to Markdown during the import process. For notes that are mostly plain text or with basic formatting (bold, italic, bullet points, links, etc.) this is a lossless conversion, and the note, once rendered back to HTML should be very similar. Tables are also imported and converted to Markdown tables. For very complex notes, some formatting data might be lost - in particular colours, font sizes and font faces will not be imported. The text itself however is always imported in full regardless of formatting. If it is essential that this extra data is preserved then Joplin also allows import of ENEX files as HTML.
\n
\n
\n
To import Evernote data, first export your Evernote notebooks to ENEX files as described here. Then follow these steps:
\n
In the desktop application, open File > Import > ENEX and select your file. The notes will be imported into a new separate notebook. If needed they can then be moved to a different notebook, or the notebook can be renamed, etc.
\n
In the terminal application, in command-line mode, type import /path/to/file.enex. This will import the notes into a new notebook named after the filename.
\n
Importing from Markdown files
\n
Joplin can import notes from plain Markdown file. You can either import a complete directory of Markdown files or individual files.
\n
In the desktop application:
\n
\n
File import: Go to File > Import > MD - Markdown (file) and select the Markdown file. This file will then be imported to the currently selected Notebook.
\n
Directory import: Go to File > Import > MD - Markdown (directory) and select the top level of the directory that is being imported. Directory (folder) structure will be preserved in the Notebook > Subnotebook > Note structure within Joplin.
\n
\n
In the terminal application, in command-line mode, type import --format md /path/to/file.md or import --format md /path/to/directory/.
\n
Importing from other applications
\n
In general the way to import notes from any application into Joplin is to convert the notes to ENEX files (Evernote format) and to import these ENEX files into Joplin using the method above. Most note-taking applications support ENEX files so it should be relatively straightforward. For help about specific applications, see below:
NixNote: Synchronise with Evernote, then export the ENEX files and import them into Joplin. More info in this thread.
\n
\n
Exporting
\n
Joplin can export to the JEX format (Joplin Export file), which is a tar file that can contain multiple notes, notebooks, etc. This is a lossless format in that all the notes, but also metadata such as geo-location, updated time, tags, etc. are preserved. This format is convenient for backup purposes and can be re-imported into Joplin. A \"raw\" format is also available. This is the same as the JEX format except that the data is saved to a directory and each item represented by a single file.\nJoplin is also capable of exporting to a number of other formats including HTML and PDF which can be done for single notes, notebooks or everything.
\n
Synchronisation
\n
One of the goals of Joplin is to avoid being tied to any particular company or service, whether it is Evernote, Google or Microsoft. As such the synchronisation is designed without any hard dependency to any particular service. Most of the synchronisation process is done at an abstract level and access to external services, such as Nextcloud or Dropbox, is done via lightweight drivers. It is easy to support new services by creating simple drivers that provide a filesystem-like interface, i.e. the ability to read, write, delete and list items. It is also simple to switch from one service to another or to even sync to multiple services at once. Each note, notebook, tags, as well as the relation between items is transmitted as plain text files during synchronisation, which means the data can also be moved to a different application, can be easily backed up, inspected, etc.
\n
Currently, synchronisation is possible with Nextcloud, WebDAV, Dropbox, OneDrive or the local filesystem. To enable synchronisation please follow the instructions below. After that, the application will synchronise in the background whenever it is running, or you can click on \"Synchronise\" to start a synchronisation manually. Joplin will background sync automatically after any content change is made on the local application.
\n
If the terminal client has been installed, it is possible to also synchronise outside of the user interface by typing joplin sync from the terminal. This can be used to setup a cron script to synchronise at a regular interval. For example, this would do it every 30 minutes:
\n
*/30 * * * * /path/to/joplin sync
\n
Nextcloud synchronisation
\n
Nextcloud is a self-hosted, private cloud solution. It can store documents, images and videos but also calendars, passwords and countless other things and can sync them to your laptop or phone. As you can host your own Nextcloud server, you own both the data on your device and infrastructure used for synchronisation. As such it is a good fit for Joplin. The platform is also well supported and with a strong community, so it is likely to be around for a while - since it's open source anyway, it is not a service that can be closed, it can exist on a server for as long as one chooses.
\n
In the desktop application or mobile application, go to the Configuration screen and select Nextcloud as the synchronisation target. Then input the WebDAV URL (to get it, click on Settings in the bottom left corner of the page, in Nextcloud), this is normally https://example.com/nextcloud/remote.php/webdav/Joplin (make sure to create the \"Joplin\" directory in Nextcloud), and set the username and password. If it does not work, please see this explanation for more details.
\n
In the terminal application, you will need to set the sync.target config variable and all the sync.5.path, sync.5.username and sync.5.password config variables to, respectively the Nextcloud WebDAV URL, your username and your password. This can be done from the command line mode using:
If synchronisation does not work, please consult the logs in the app profile directory - it is often due to a misconfigured URL or password. The log should indicate what the exact issue is.
\n
WebDAV synchronisation
\n
Select the \"WebDAV\" synchronisation target and follow the same instructions as for Nextcloud above (for the terminal application you will need to select sync target 6 rather than 5)
\n
WebDAV-compatible services that are known to work with Joplin:
When syncing with Dropbox, Joplin creates a sub-directory in Dropbox, in /Apps/Joplin and read/write the notes and notebooks from it. The application does not have access to anything outside this directory.
\n
In the desktop application or mobile application, select \"Dropbox\" as the synchronisation target in the Configuration screen (it is selected by default). Then, to initiate the synchronisation process, click on the \"Synchronise\" button in the sidebar and follow the instructions.
\n
In the terminal application, to initiate the synchronisation process, type :sync. You will be asked to follow a link to authorise the application.
\n
OneDrive synchronisation
\n
When syncing with OneDrive, Joplin creates a sub-directory in OneDrive, in /Apps/Joplin and read/write the notes and notebooks from it. The application does not have access to anything outside this directory.
\n
In the desktop application or mobile application, select \"OneDrive\" as the synchronisation target in the Configuration screen. Then, to initiate the synchronisation process, click on the \"Synchronise\" button in the sidebar and follow the instructions.
\n
In the terminal application, to initiate the synchronisation process, type :sync. You will be asked to follow a link to authorise the application (simply input your Microsoft credentials - you do not need to register with OneDrive).
\n
AWS S3 synchronisation
\n
In the desktop application or mobile application, select \"AWS S3 (Beta)\" as the synchronisation target in the Configuration screen.
\n
\n
AWS S3 Bucket: The name of your Bucket, such as joplin-bucket
\n
AWS S3 URL: Fully qualified URL; By default this should be https://s3.amazonaws.com/
\n
AWS key & AWS secret: IAM user's programmatic access key. To create a new key & secret, visit IAM Security Credentials.
\n
\n
While creating a new Bucket for Joplin, disable Bucket Versioning, enable Block all public access and enable Default encryption with Amazon S3 key (SSE-S3).
\n
To add a Bucket Policy from the AWS S3 Web Console, navigate to the Permissions tab. Temporarily disable Block all public access to edit the Bucket policy, something along the lines of:
Joplin supports end-to-end encryption (E2EE) on all the applications. E2EE is a system where only the owner of the notes, notebooks, tags or resources can read them. It prevents potential eavesdroppers - including telecom providers, internet providers, and even the developers of Joplin from being able to access the data. Please see the End-To-End Encryption Tutorial for more information about this feature and how to enable it.
\n
For a more technical description, mostly relevant for development or to review the method being used, please see the Encryption specification.
\n
Note history
\n
The Joplin applications automatically save previous versions of your notes at regular intervals. These versions are synced across devices and can be viewed from the desktop application. To do so, click on the \"Information\" button on a note, then click on \"Previous version of this note\". From this screen you can view the previous versions of the note as well as restore any of them.
\n
This feature can be disabled from the \"Note history\" section in the Configuration screen, and it is also possible to change for how long the history of a note is saved.
Joplin notes can be opened and edited using an external editor of your choice. It can be a simple text editor like Notepad++ or Sublime Text or an actual Markdown editor like Typora. In that case, images will also be displayed within the editor. To open the note in an external editor, click on the icon in the toolbar or press Ctrl+E (or Cmd+E). Your default text editor will be used to open the note. If needed, you can also specify the editor directly in the General Options, under \"Text editor command\".
\n
Attachments
\n
Any kind of file can be attached to a note. In Markdown, links to these files are represented as a simple ID to the attachment, clicking on this link will open the file in the default application. In the case of audio, video and pdf files, these will be displayed inline with the note and so can be viewed or played within Joplin.
\n
In the desktop application, files can be attached either by clicking the \"Attach file\" icon in the editor or via drag and drop. If you prefer to create a link to a local file instead, hold the ALT key while performing the drag and drop operation. You can also copy and paste images directly in the editor via Ctrl+V.
\n
Resources that are not attached to any note will be automatically deleted in accordance to the Note History settings.
\n
Important: Resources larger than 10 MB are not currently supported on mobile. They will crash the application when synchronising so it is recommended not to attach such resources at the moment. The issue is being looked at.
\n
Downloading attachments
\n
The way the attachments are downloaded during synchronisation can be customised in the Configuration screen, under \"Attachment download behaviour\". The default option (\"Always\") is to download all the attachments, all the time, so that the data is available even when the device is offline. There is also the option to download the attachments manually (option \"Manual\"), by clicking on it, or automatically (Option \"Auto\"), in which case the attachments are downloaded only when a note is opened. These options should help saving disk space and network bandwidth, especially on mobile.
\n
Notifications
\n
In the desktop and mobile apps, an alarm can be associated with any to-do. It will be triggered at the given time by displaying a notification. How the notification will be displayed depends on the operating system since each has a different way to handle this. Please see below for the requirements for the desktop applications:
\n
\n
Windows: >= 8. Make sure the Action Center is enabled on Windows. Task bar balloon for Windows < 8. Growl as fallback. Growl takes precedence over Windows balloons.
\n
macOS: >= 10.8 or Growl if earlier.
\n
Linux: notify-send tool, delivered through packages notify-osd, libnotify-bin or libnotify-tools. GNOME should have this by default, but install libnotify-tools if using KDE Plasma.
On mobile, the alarms will be displayed using the built-in notification system.
\n
If for any reason the notifications do not work, please open an issue.
\n
Sub-notebooks
\n
Sub-notebooks allow organising multiple notebooks into a tree of notebooks. For example it can be used to regroup all the notebooks related to work, to family or to a particular project under a parent notebook.
\n
\n
\n
In the desktop application, to create a subnotebook, drag and drop it onto another notebook. To move it back to the root, drag and drop it on the \"Notebooks\" header. Currently only the desktop app can be used to organise the notebooks.
\n
The mobile application supports displaying and collapsing/expanding the tree of notebooks, however it does not currently support moving the subnotebooks to different notebooks.
\n
The terminal app supports displaying the tree of subnotebooks but it does not support collapsing/expanding them or moving the subnotebooks around.
\n
\n
Markdown
\n
Joplin uses and renders a Github-flavoured Markdown with a few variations and additions. In particular it adds math formula support, interactive checkboxes and support for note links. Joplin also supports Markdown plugins which allow enabling and disabling various advanced Markdown features. Have a look at the Markdown Guide for more information.
\n
Custom CSS
\n
Rendered markdown can be customized by placing a userstyle file in the profile directory ~/.config/joplin-desktop/userstyle.css (This path might be different on your device - check at the top of the General page of the Configuration menu for the exact path). This file supports standard CSS syntax. Joplin must be restarted for the new css to be applied, please ensure that Joplin is not closing to the tray, but is actually exiting. Note that this file is used for both displaying the notes and printing the notes. Be aware how the CSS may look printed (for example, printing white text over a black background is usually not wanted).
\n
The whole UI can be customized by placing a custom editor style file in the profile directory ~/.config/joplin-desktop/userchrome.css.
\n
Important: userstyle.css and userchrome.css are provided for your convenience, but they are advanced settings, and styles you define may break from one version to the next. If you want to use them, please know that it might require regular development work from you to keep them working. The Joplin team cannot make a commitment to keep the application HTML structure stable.
\n
Note templates
\n
In the desktop app, templates can be used to create new notes or to insert into existing ones by adding a template file to the templates directory (File > Templates). For example creating the file hours.md in the templates directory with the contents:
\n
Date: {{date}}\nHours:\nDetails:
\n
Templates can then be inserted from the menu (File->Templates).
\n
The currently supported template variables are:
\n
\n\n
\n
Variable
\n
Description
\n
Example
\n
\n\n\n
\n
{{date}}
\n
Today's date formatted based on the settings format
\n
2019-01-01
\n
\n
\n
{{time}}
\n
Current time formatted based on the settings format
\n
13:00
\n
\n
\n
{{datetime}}
\n
Current date and time formatted based on the settings format
\n
01/01/19 1:00 PM
\n
\n
\n
{{#custom_datetime}}
\n
Current date and/or time formatted based on a supplied string (using moment.js formatting)
\n
{{#custom_datetime}}M d{{/custom_datetime}}
\n
\n
\n
{{bowm}}
\n
Date of the beginning of the week (when week starts on Monday) based on the settings format
\n
\n
\n
\n
{{bows}}
\n
Date of the beginning of the week (when week starts on Sunday) based on the settings format
\n
\n
\n\n
\n
Plugins
\n
The desktop app has the ability to extend beyond its standard functionality by the way of plugins. These plugins adhere to the Joplin plugin API and can be installed & configured within the application via the Plugins page in the Configuration screen. This menu allows the manual installation of the plugin using the single 'Joplin Plugin Archive' (*.jpl) file. Once the application is reloaded the plugins will appear within the plugins menu where they can be toggled on/off or removed entirely.
Joplin implements the SQLite Full Text Search (FTS4) extension. It means the content of all the notes is indexed in real time and search queries return results very fast. Both Simple FTS Queries and Full-Text Index Queries are supported. See below for the list of supported queries:
\n
One caveat of SQLite FTS is that it does not support languages which do not use Latin word boundaries (spaces, tabs, punctuation). To solve this issue, Joplin has a custom search mode, that does not use FTS, but still has all of its features (multi term search, filters, etc.). One of its drawbacks is that it can get slow on larger note collections. Also, the sorting of the results will be less accurate, as the ranking algorithm (BM25) is, for now, only implemented for FTS. Finally, in this mode there are no restrictions on using the * wildcard (swim*, *swim and ast*rix all work). This search mode is currently enabled if one of the following languages are detected:
\n
\n
Chinese
\n
Japanese
\n
Korean
\n
Thai
\n
\n
Supported queries
\n
\n\n
\n
Search type
\n
Description
\n
Example
\n
\n\n\n
\n
Single word
\n
Returns all the notes that contain this term.
\n
For example, searching for cat will return all the notes that contain this exact word. Note: it will not return the notes that contain the substring - thus, for \"cat\", notes that contain \"cataclysmic\" or \"prevaricate\" will not be returned.
\n
\n
\n
Multiple word
\n
Returns all the notes that contain all these words, but not necessarily next to each other.
\n
dog cat - will return any notes that contain the words \"dog\" and \"cat\" anywhere in the note, no necessarily in that order nor next to each other. It will not return results that contain \"dog\" or \"cat\" only.
\n
\n
\n
Phrase
\n
Add double quotes to return the notes that contain exactly this phrase.
\n
\"shopping list\" - will return the notes that contain these exact terms next to each other and in this order. It will not return for example a note that contains \"going shopping with my list\".
\n
\n
\n
Prefix
\n
Add a wildcard to return all the notes that contain a term with a specified prefix.
\n
swim* - will return all the notes that contain eg. \"swim\", but also \"swimming\", \"swimsuit\", etc. IMPORTANT: The wildcard can only be at the end - it will be ignored at the beginning of a word (eg. *swim) and will be treated as a literal asterisk in the middle of a word (eg. ast*rix)
\n
\n
\n
Switch to basic search
\n
One drawback of Full Text Search is that it ignores most non-alphabetical characters. However in some cases you might want to search for this too. To do that, you can use basic search. You switch to this mode by prefixing your search with a slash /. This won't provide the benefits of FTS but it will allow searching exactly for what you need. Note that it can also be much slower, even extremely slow, depending on your query.
\n
/\"- [ ]\" - will return all the notes that contain unchecked checkboxes.
\n
\n\n
\n
Search filters
\n
You can also use search filters to further restrict the search.
\n
\n\n
\n
Operator
\n
Description
\n
Example
\n
\n\n\n
\n
-
\n
If placed before a text term, it excludes the notes that contain that term. You can also place it before a filter to negate it.
\n
-spam searches for all notes without the word spam. office -trash searches for all notes with the wordoffice and without the word trash.
\n
\n
\n
any:
\n
Return notes that satisfy any/all of the required conditions. any:0 is the default, which means all conditions must be satisfied.
\n
any:1 cat dog will return notes that have the word cat or dog. any:0 cat dog will return notes with both the words cat and dog.
\n
\n
\n
title: body:
\n
Restrict your search to just the title or the body field.
\n
title:\"hello world\" searches for notes whose title contains hello and world. title:hello -body:world searches for notes whose title contains hello and body does not contain world.
\n
\n
\n
tag:
\n
Restrict the search to the notes with the specified tags.
\n
tag:office searches for all notes having tag office. tag:office tag:important searches for all notes having both office and important tags. tag:office -tag:spam searches for notes having tag office which do not have tag spam. any:1 tag:office tag:spam searches for notes having tag office or tag spam. tag:be*ful does a search with wildcards. tag:* returns all notes with tags. -tag:* returns all notes without tags.
\n
\n
\n
notebook:
\n
Restrict the search to the specified notebook(s).
\n
notebook:books limits the search scope within books and all its subnotebooks. notebook:wheel*time does a wildcard search.
\n
\n
\n
created: updated: due:
\n
Searches for notes created/updated on dates specified using YYYYMMDD format. You can also search relative to the current day, week, month, or year.
\n
created:20201218 will return notes created on or after December 18, 2020. -updated:20201218 will return notes updated before December 18, 2020. created:20200118 -created:20201215 will return notes created between January 18, 2020, and before December 15, 2020. created:202001 -created:202003 will return notes created on or after January and before March 2020. updated:1997 -updated:2020 will return all notes updated between the years 1997 and 2019. created:day-2 searches for all notes created in the past two days. updated:year-0 searches all notes updated in the current year. -due:day+7 will return all todos which are due or will be due in the next seven days. -due:day-5 searches all todos that are overdue for more than 5 days.
\n
\n
\n
type:
\n
Restrict the search to either notes or todos.
\n
type:note to return all notes type:todo to return all todos
\n
\n
\n
iscompleted:
\n
Restrict the search to either completed or uncompleted todos.
\n
iscompleted:1 to return all completed todos iscompleted:0 to return all uncompleted todos
\n
\n
\n
latitude: longitude: altitude:
\n
Filter by location
\n
latitude:40 -latitude:50 to return notes with latitude >= 40 and < 50
\n
\n
\n
resource:
\n
Filter by attachment MIME type
\n
resource:image/jpeg to return notes with a jpeg attachment. -resource:application/pdf to return notes without a pdf attachment. resource:image/* to return notes with any images.
\n
\n
\n
sourceurl:
\n
Filter by source URL
\n
sourceurl:https://www.google.com sourceurl:*joplinapp.org to perform a wildcard search.
\n
\n
\n
id:
\n
Filter by note ID
\n
id:9cbc1b4f242043a9b8a50627508bccd5 return a note with the specified id
\n
\n\n
\n
Note: In the CLI client you have to escape the query using -- when using negated filters.\nEg. :search -- \"-tag:tag1\".
\n
The filters are implicitly connected by and/or connectives depending on the following rules:
\n
\n
By default, all filters are connected by \"AND\".
\n
To override this default behaviour, use the any filter, in which case the search terms will be connected by \"OR\" instead.
\n
There's an exception for the notebook filters which are connected by \"OR\". The reason being that no note can be in multiple notebooks at once.
\n
\n
Incorrect search filters are interpreted as a phrase search, e.g. misspelled nootebook:Example or non-existing https://joplinapp.org.
\n
Search order
\n
Notes are sorted by \"relevance\". Currently it means the notes that contain the requested terms the most times are on top. For queries with multiple terms, it also matters how close to each other the terms are. This is a bit experimental so if you notice a search query that returns unexpected results, please report it in the forum, providing as many details as possible to replicate the issue.
\n
Goto Anything
\n
In the desktop application, press Ctrl+P or Cmd+P and type a note title or part of its content to jump to it. Or type # followed by a tag name, or @ followed by a notebook name.
\n
Privacy
\n
Joplin values your privacy and security by giving you complete control over your information and digital footprint.
\n
Joplin applications do not send any data to any service without your authorisation. Any data that Joplin saves, such as notes or images, are saved to your own device and you are free to delete this data at any time.
\n
Joplin has many modern features, some of which use third-party services. You can disable any or all of these features in the application settings. These features are:
\n
\n\n
\n
Feature
\n
Description
\n
Default
\n
\n\n\n
\n
Auto-update
\n
Joplin periodically connects to GitHub to check for new releases.
\n
Enabled
\n
\n
\n
Geo-location
\n
Joplin saves geo-location information in note properties when you create a note.
\n
Enabled
\n
\n
\n
Synchronisation
\n
Joplin supports synchronisation of your notes across multiple devices. If you choose to synchronise with a third-party, such as OneDrive, the notes will be sent to your OneDrive account, in which case the third-party privacy policy applies.
\n
Disabled
\n
\n\n
\n
Joplin is developed as an open-source application and the source code is freely available online to inspect.
\n
For any question about Joplin privacy, please leave a message on the Joplin Forum.
\n
Donations
\n
Donations to Joplin support the development of the project. Developing quality applications mostly takes time, but there are also some expenses, such as digital certificates to sign the applications, app store fees, hosting, etc. Most of all, your donation will make it possible to keep up the current development standard.
\n
Please see the donation page for information on how to support the development of Joplin.
This is the main place for general discussion about Joplin, user support, software development questions, and to discuss new features. Also where the latest beta versions are released and discussed.
Joplin is currently available in the languages below. If you would like to contribute a new translation, it is quite straightforward, please follow these steps:
In Poedit, open this .pot file, go into the Catalog menu and click Configuration. Change \"Country\" and \"Language\" to your own country and language.
Joplin is a free, open source note taking and to-do application, which can handle a large number of notes organised into notebooks. The notes are searchable, can be copied, tagged and modified either from the applications directly or from your own text editor. The notes are in Markdown format.
\n
Notes exported from Evernote via .enex files can be imported into Joplin, including the formatted content (which is converted to Markdown), resources (images, attachments, etc.) and complete metadata (geolocation, updated time, created time, etc.). Plain Markdown files can also be imported.
\n
The notes can be synchronised with various cloud services including Nextcloud, Dropbox, OneDrive, WebDAV or the file system (for example with a network directory). When synchronising the notes, notebooks, tags and other metadata are saved to plain text files which can be easily inspected, backed up and moved around.
\n
The application is available for Windows, Linux, macOS, Android and iOS (the terminal app also works on FreeBSD). A Web Clipper, to save web pages and screenshots from your browser, is also available for Firefox and Chrome.
\n
\n
Installation
\n
Three types of applications are available: for the desktop (Windows, macOS and Linux), for mobile (Android and iOS) and for terminal (Windows, macOS, Linux and FreeBSD). All applications have similar user interfaces and can synchronise with each other.
\n
Desktop applications
\n
\n\n
\n
Operating System
\n
Download
\n
\n\n\n
\n
Windows (32 and 64-bit)
\n
\n
\n
\n
macOS
\n
\n
\n
\n
Linux
\n
\n
\n\n
\n
On Windows, you may also use the Portable version. The portable application allows installing the software on a portable device such as a USB key. Simply copy the file JoplinPortable.exe in any directory on that USB key ; the application will then create a directory called \"JoplinProfile\" next to the executable file.
\n
On Linux, the recommended way is to use the following installation script as it will handle the desktop icon too:
By default, the application binary will be installed under ~/.joplin-bin. You may change this directory if needed. Alternatively, if your npm permissions are setup as described here (Option 2) then simply running npm -g install joplin would work.
There are other ways to install the terminal application. However, they are not supported and problems must be reported to the upstream projects.
\n
\n\n
\n
Operating system
\n
Method
\n
\n\n\n
\n
macOS
\n
brew install joplin
\n
\n
\n
Arch Linux
\n
An Arch Linux package is available here. To install it, use an AUR wrapper such as yay: yay -S joplin. Both the CLI tool (type joplin) and desktop app (type joplin-desktop) are packaged. You can also install a compiled version with the chaotic-aur repository. For support, please go to the GitHub repo. If you are interested in pre-release you have joplin-beta.
\n
\n\n
\n
Web Clipper
\n
The Web Clipper is a browser extension that allows you to save web pages and screenshots from your browser. For more information on how to install and use it, see the Web Clipper Help Page.
Synchronisation with various services, including Nextcloud, Dropbox, WebDAV and OneDrive.
\n
Offline first, so the entire data is always available on the device even without an internet connection.
\n
Import Enex files (Evernote export format) and Markdown files.
\n
Export JEX files (Joplin Export format) and raw files.
\n
Support notes, to-dos, tags and notebooks.
\n
Sort notes by multiple criteria - title, updated time, etc.
\n
Support for alarms (notifications) in mobile and desktop applications.
\n
Markdown notes, which are rendered with images and formatting in the desktop and mobile applications. Support for extra features such as math notation and checkboxes.
\n
Choice of both Markdown and Rich Text (WYSIWYG) editors.
\n
File attachment support - images are displayed, other files are linked and can be opened in the relevant application.
\n
Inline display of PDF, video and audio files.
\n
Goto Anything feature.
\n
Search functionality.
\n
Geo-location support.
\n
Supports multiple languages.
\n
External editor support - open notes in your favorite external editor with one click in Joplin.
\n
Extensible functionality through plugin and data APIs.
\n
Template support with data variables for auto creation of time & dates.
\n
Custom CSS support for customisation of both the rendered markdown and overall user interface.
\n
Customisable layout allows toggling, movement and sizing of various elements.
\n
Keyboard shortcuts are editable and allow binding of most Joplin commands with export/import functionality.
\n
\n
Importing
\n
Importing from Evernote
\n
Joplin was designed as a replacement for Evernote and so can import complete Evernote notebooks, as well as notes, tags, resources (attached files) and note metadata (such as author, geo-location, etc.) via ENEX files. In terms of data, the only two things that might slightly differ are:
\n
\n
\n
Recognition data - Evernote images, in particular scanned (or photographed) documents have recognition data associated with them. It is the text that Evernote has been able to recognise in the document. This data is not preserved when the note are imported into Joplin. However, should it become supported in the search tool or other parts of Joplin, it should be possible to regenerate this recognition data since the actual image would still be available.
\n
\n
\n
Colour, font sizes and faces - Evernote text is stored as HTML and this is converted to Markdown during the import process. For notes that are mostly plain text or with basic formatting (bold, italic, bullet points, links, etc.) this is a lossless conversion, and the note, once rendered back to HTML should be very similar. Tables are also imported and converted to Markdown tables. For very complex notes, some formatting data might be lost - in particular colours, font sizes and font faces will not be imported. The text itself however is always imported in full regardless of formatting. If it is essential that this extra data is preserved then Joplin also allows import of ENEX files as HTML.
\n
\n
\n
To import Evernote data, first export your Evernote notebooks to ENEX files as described here. Then follow these steps:
\n
In the desktop application, open File > Import > ENEX and select your file. The notes will be imported into a new separate notebook. If needed they can then be moved to a different notebook, or the notebook can be renamed, etc.
\n
In the terminal application, in command-line mode, type import /path/to/file.enex. This will import the notes into a new notebook named after the filename.
\n
Importing from Markdown files
\n
Joplin can import notes from plain Markdown file. You can either import a complete directory of Markdown files or individual files.
\n
In the desktop application:
\n
\n
File import: Go to File > Import > MD - Markdown (file) and select the Markdown file. This file will then be imported to the currently selected Notebook.
\n
Directory import: Go to File > Import > MD - Markdown (directory) and select the top level of the directory that is being imported. Directory (folder) structure will be preserved in the Notebook > Subnotebook > Note structure within Joplin.
\n
\n
In the terminal application, in command-line mode, type import --format md /path/to/file.md or import --format md /path/to/directory/.
\n
Importing from other applications
\n
In general the way to import notes from any application into Joplin is to convert the notes to ENEX files (Evernote format) and to import these ENEX files into Joplin using the method above. Most note-taking applications support ENEX files so it should be relatively straightforward. For help about specific applications, see below:
NixNote: Synchronise with Evernote, then export the ENEX files and import them into Joplin. More info in this thread.
\n
\n
Exporting
\n
Joplin can export to the JEX format (Joplin Export file), which is a tar file that can contain multiple notes, notebooks, etc. This is a lossless format in that all the notes, but also metadata such as geo-location, updated time, tags, etc. are preserved. This format is convenient for backup purposes and can be re-imported into Joplin. A \"raw\" format is also available. This is the same as the JEX format except that the data is saved to a directory and each item represented by a single file.\nJoplin is also capable of exporting to a number of other formats including HTML and PDF which can be done for single notes, notebooks or everything.
\n
Synchronisation
\n
One of the goals of Joplin is to avoid being tied to any particular company or service, whether it is Evernote, Google or Microsoft. As such the synchronisation is designed without any hard dependency to any particular service. Most of the synchronisation process is done at an abstract level and access to external services, such as Nextcloud or Dropbox, is done via lightweight drivers. It is easy to support new services by creating simple drivers that provide a filesystem-like interface, i.e. the ability to read, write, delete and list items. It is also simple to switch from one service to another or to even sync to multiple services at once. Each note, notebook, tags, as well as the relation between items is transmitted as plain text files during synchronisation, which means the data can also be moved to a different application, can be easily backed up, inspected, etc.
\n
Currently, synchronisation is possible with Nextcloud, WebDAV, Dropbox, OneDrive or the local filesystem. To enable synchronisation please follow the instructions below. After that, the application will synchronise in the background whenever it is running, or you can click on \"Synchronise\" to start a synchronisation manually. Joplin will background sync automatically after any content change is made on the local application.
\n
If the terminal client has been installed, it is possible to also synchronise outside of the user interface by typing joplin sync from the terminal. This can be used to setup a cron script to synchronise at a regular interval. For example, this would do it every 30 minutes:
\n
*/30 * * * * /path/to/joplin sync
\n
Nextcloud synchronisation
\n
Nextcloud is a self-hosted, private cloud solution. It can store documents, images and videos but also calendars, passwords and countless other things and can sync them to your laptop or phone. As you can host your own Nextcloud server, you own both the data on your device and infrastructure used for synchronisation. As such it is a good fit for Joplin. The platform is also well supported and with a strong community, so it is likely to be around for a while - since it's open source anyway, it is not a service that can be closed, it can exist on a server for as long as one chooses.
\n
In the desktop application or mobile application, go to the Configuration screen and select Nextcloud as the synchronisation target. Then input the WebDAV URL (to get it, click on Settings in the bottom left corner of the page, in Nextcloud), this is normally https://example.com/nextcloud/remote.php/webdav/Joplin (make sure to create the \"Joplin\" directory in Nextcloud), and set the username and password. If it does not work, please see this explanation for more details.
\n
In the terminal application, you will need to set the sync.target config variable and all the sync.5.path, sync.5.username and sync.5.password config variables to, respectively the Nextcloud WebDAV URL, your username and your password. This can be done from the command line mode using:
If synchronisation does not work, please consult the logs in the app profile directory - it is often due to a misconfigured URL or password. The log should indicate what the exact issue is.
\n
WebDAV synchronisation
\n
Select the \"WebDAV\" synchronisation target and follow the same instructions as for Nextcloud above (for the terminal application you will need to select sync target 6 rather than 5)
\n
WebDAV-compatible services that are known to work with Joplin:
When syncing with Dropbox, Joplin creates a sub-directory in Dropbox, in /Apps/Joplin and read/write the notes and notebooks from it. The application does not have access to anything outside this directory.
\n
In the desktop application or mobile application, select \"Dropbox\" as the synchronisation target in the Configuration screen (it is selected by default). Then, to initiate the synchronisation process, click on the \"Synchronise\" button in the sidebar and follow the instructions.
\n
In the terminal application, to initiate the synchronisation process, type :sync. You will be asked to follow a link to authorise the application.
\n
OneDrive synchronisation
\n
When syncing with OneDrive, Joplin creates a sub-directory in OneDrive, in /Apps/Joplin and read/write the notes and notebooks from it. The application does not have access to anything outside this directory.
\n
In the desktop application or mobile application, select \"OneDrive\" as the synchronisation target in the Configuration screen. Then, to initiate the synchronisation process, click on the \"Synchronise\" button in the sidebar and follow the instructions.
\n
In the terminal application, to initiate the synchronisation process, type :sync. You will be asked to follow a link to authorise the application (simply input your Microsoft credentials - you do not need to register with OneDrive).
\n
AWS S3 synchronisation
\n
In the desktop application or mobile application, select \"AWS S3 (Beta)\" as the synchronisation target in the Configuration screen.
\n
\n
AWS S3 Bucket: The name of your Bucket, such as joplin-bucket
\n
AWS S3 URL: Fully qualified URL; By default this should be https://s3.amazonaws.com/
\n
AWS key & AWS secret: IAM user's programmatic access key. To create a new key & secret, visit IAM Security Credentials.
\n
\n
While creating a new Bucket for Joplin, disable Bucket Versioning, enable Block all public access and enable Default encryption with Amazon S3 key (SSE-S3).
\n
To add a Bucket Policy from the AWS S3 Web Console, navigate to the Permissions tab. Temporarily disable Block all public access to edit the Bucket policy, something along the lines of:
Joplin supports end-to-end encryption (E2EE) on all the applications. E2EE is a system where only the owner of the notes, notebooks, tags or resources can read them. It prevents potential eavesdroppers - including telecom providers, internet providers, and even the developers of Joplin from being able to access the data. Please see the End-To-End Encryption Tutorial for more information about this feature and how to enable it.
\n
For a more technical description, mostly relevant for development or to review the method being used, please see the Encryption specification.
\n
Note history
\n
The Joplin applications automatically save previous versions of your notes at regular intervals. These versions are synced across devices and can be viewed from the desktop application. To do so, click on the \"Information\" button on a note, then click on \"Previous version of this note\". From this screen you can view the previous versions of the note as well as restore any of them.
\n
This feature can be disabled from the \"Note history\" section in the Configuration screen, and it is also possible to change for how long the history of a note is saved.
Joplin notes can be opened and edited using an external editor of your choice. It can be a simple text editor like Notepad++ or Sublime Text or an actual Markdown editor like Typora. In that case, images will also be displayed within the editor. To open the note in an external editor, click on the icon in the toolbar or press Ctrl+E (or Cmd+E). Your default text editor will be used to open the note. If needed, you can also specify the editor directly in the General Options, under \"Text editor command\".
\n
Attachments
\n
Any kind of file can be attached to a note. In Markdown, links to these files are represented as a simple ID to the attachment, clicking on this link will open the file in the default application. In the case of audio, video and pdf files, these will be displayed inline with the note and so can be viewed or played within Joplin.
\n
In the desktop application, files can be attached either by clicking the \"Attach file\" icon in the editor or via drag and drop. If you prefer to create a link to a local file instead, hold the ALT key while performing the drag and drop operation. You can also copy and paste images directly in the editor via Ctrl+V.
\n
Resources that are not attached to any note will be automatically deleted in accordance to the Note History settings.
\n
Important: Resources larger than 10 MB are not currently supported on mobile. They will crash the application when synchronising so it is recommended not to attach such resources at the moment. The issue is being looked at.
\n
Downloading attachments
\n
The way the attachments are downloaded during synchronisation can be customised in the Configuration screen, under \"Attachment download behaviour\". The default option (\"Always\") is to download all the attachments, all the time, so that the data is available even when the device is offline. There is also the option to download the attachments manually (option \"Manual\"), by clicking on it, or automatically (Option \"Auto\"), in which case the attachments are downloaded only when a note is opened. These options should help saving disk space and network bandwidth, especially on mobile.
\n
Notifications
\n
In the desktop and mobile apps, an alarm can be associated with any to-do. It will be triggered at the given time by displaying a notification. How the notification will be displayed depends on the operating system since each has a different way to handle this. Please see below for the requirements for the desktop applications:
\n
\n
Windows: >= 8. Make sure the Action Center is enabled on Windows. Task bar balloon for Windows < 8. Growl as fallback. Growl takes precedence over Windows balloons.
\n
macOS: >= 10.8 or Growl if earlier.
\n
Linux: notify-send tool, delivered through packages notify-osd, libnotify-bin or libnotify-tools. GNOME should have this by default, but install libnotify-tools if using KDE Plasma.
On mobile, the alarms will be displayed using the built-in notification system.
\n
If for any reason the notifications do not work, please open an issue.
\n
Sub-notebooks
\n
Sub-notebooks allow organising multiple notebooks into a tree of notebooks. For example it can be used to regroup all the notebooks related to work, to family or to a particular project under a parent notebook.
\n
\n
\n
In the desktop application, to create a subnotebook, drag and drop it onto another notebook. To move it back to the root, drag and drop it on the \"Notebooks\" header. Currently only the desktop app can be used to organise the notebooks.
\n
The mobile application supports displaying and collapsing/expanding the tree of notebooks, however it does not currently support moving the subnotebooks to different notebooks.
\n
The terminal app supports displaying the tree of subnotebooks but it does not support collapsing/expanding them or moving the subnotebooks around.
\n
\n
Markdown
\n
Joplin uses and renders a Github-flavoured Markdown with a few variations and additions. In particular it adds math formula support, interactive checkboxes and support for note links. Joplin also supports Markdown plugins which allow enabling and disabling various advanced Markdown features. Have a look at the Markdown Guide for more information.
\n
Custom CSS
\n
Rendered markdown can be customized by placing a userstyle file in the profile directory ~/.config/joplin-desktop/userstyle.css (This path might be different on your device - check at the top of the General page of the Configuration menu for the exact path). This file supports standard CSS syntax. Joplin must be restarted for the new css to be applied, please ensure that Joplin is not closing to the tray, but is actually exiting. Note that this file is used for both displaying the notes and printing the notes. Be aware how the CSS may look printed (for example, printing white text over a black background is usually not wanted).
\n
The whole UI can be customized by placing a custom editor style file in the profile directory ~/.config/joplin-desktop/userchrome.css.
\n
Important: userstyle.css and userchrome.css are provided for your convenience, but they are advanced settings, and styles you define may break from one version to the next. If you want to use them, please know that it might require regular development work from you to keep them working. The Joplin team cannot make a commitment to keep the application HTML structure stable.
\n
Note templates
\n
In the desktop app, templates can be used to create new notes or to insert into existing ones by adding a template file to the templates directory (File > Templates). For example creating the file hours.md in the templates directory with the contents:
\n
Date: {{date}}\nHours:\nDetails:
\n
Templates can then be inserted from the menu (File->Templates).
\n
The currently supported template variables are:
\n
\n\n
\n
Variable
\n
Description
\n
Example
\n
\n\n\n
\n
{{date}}
\n
Today's date formatted based on the settings format
\n
2019-01-01
\n
\n
\n
{{time}}
\n
Current time formatted based on the settings format
\n
13:00
\n
\n
\n
{{datetime}}
\n
Current date and time formatted based on the settings format
\n
01/01/19 1:00 PM
\n
\n
\n
{{#custom_datetime}}
\n
Current date and/or time formatted based on a supplied string (using moment.js formatting)
\n
{{#custom_datetime}}M d{{/custom_datetime}}
\n
\n
\n
{{bowm}}
\n
Date of the beginning of the week (when week starts on Monday) based on the settings format
\n
\n
\n
\n
{{bows}}
\n
Date of the beginning of the week (when week starts on Sunday) based on the settings format
\n
\n
\n\n
\n
Plugins
\n
The desktop app has the ability to extend beyond its standard functionality by the way of plugins. These plugins adhere to the Joplin plugin API and can be installed & configured within the application via the Plugins page in the Configuration screen. This menu allows the manual installation of the plugin using the single 'Joplin Plugin Archive' (*.jpl) file. Once the application is reloaded the plugins will appear within the plugins menu where they can be toggled on/off or removed entirely.
Joplin implements the SQLite Full Text Search (FTS4) extension. It means the content of all the notes is indexed in real time and search queries return results very fast. Both Simple FTS Queries and Full-Text Index Queries are supported. See below for the list of supported queries:
\n
One caveat of SQLite FTS is that it does not support languages which do not use Latin word boundaries (spaces, tabs, punctuation). To solve this issue, Joplin has a custom search mode, that does not use FTS, but still has all of its features (multi term search, filters, etc.). One of its drawbacks is that it can get slow on larger note collections. Also, the sorting of the results will be less accurate, as the ranking algorithm (BM25) is, for now, only implemented for FTS. Finally, in this mode there are no restrictions on using the * wildcard (swim*, *swim and ast*rix all work). This search mode is currently enabled if one of the following languages are detected:
\n
\n
Chinese
\n
Japanese
\n
Korean
\n
Thai
\n
\n
Supported queries
\n
\n\n
\n
Search type
\n
Description
\n
Example
\n
\n\n\n
\n
Single word
\n
Returns all the notes that contain this term.
\n
For example, searching for cat will return all the notes that contain this exact word. Note: it will not return the notes that contain the substring - thus, for \"cat\", notes that contain \"cataclysmic\" or \"prevaricate\" will not be returned.
\n
\n
\n
Multiple word
\n
Returns all the notes that contain all these words, but not necessarily next to each other.
\n
dog cat - will return any notes that contain the words \"dog\" and \"cat\" anywhere in the note, no necessarily in that order nor next to each other. It will not return results that contain \"dog\" or \"cat\" only.
\n
\n
\n
Phrase
\n
Add double quotes to return the notes that contain exactly this phrase.
\n
\"shopping list\" - will return the notes that contain these exact terms next to each other and in this order. It will not return for example a note that contains \"going shopping with my list\".
\n
\n
\n
Prefix
\n
Add a wildcard to return all the notes that contain a term with a specified prefix.
\n
swim* - will return all the notes that contain eg. \"swim\", but also \"swimming\", \"swimsuit\", etc. IMPORTANT: The wildcard can only be at the end - it will be ignored at the beginning of a word (eg. *swim) and will be treated as a literal asterisk in the middle of a word (eg. ast*rix)
\n
\n
\n
Switch to basic search
\n
One drawback of Full Text Search is that it ignores most non-alphabetical characters. However in some cases you might want to search for this too. To do that, you can use basic search. You switch to this mode by prefixing your search with a slash /. This won't provide the benefits of FTS but it will allow searching exactly for what you need. Note that it can also be much slower, even extremely slow, depending on your query.
\n
/\"- [ ]\" - will return all the notes that contain unchecked checkboxes.
\n
\n\n
\n
Search filters
\n
You can also use search filters to further restrict the search.
\n
\n\n
\n
Operator
\n
Description
\n
Example
\n
\n\n\n
\n
-
\n
If placed before a text term, it excludes the notes that contain that term. You can also place it before a filter to negate it.
\n
-spam searches for all notes without the word spam. office -trash searches for all notes with the wordoffice and without the word trash.
\n
\n
\n
any:
\n
Return notes that satisfy any/all of the required conditions. any:0 is the default, which means all conditions must be satisfied.
\n
any:1 cat dog will return notes that have the word cat or dog. any:0 cat dog will return notes with both the words cat and dog.
\n
\n
\n
title: body:
\n
Restrict your search to just the title or the body field.
\n
title:\"hello world\" searches for notes whose title contains hello and world. title:hello -body:world searches for notes whose title contains hello and body does not contain world.
\n
\n
\n
tag:
\n
Restrict the search to the notes with the specified tags.
\n
tag:office searches for all notes having tag office. tag:office tag:important searches for all notes having both office and important tags. tag:office -tag:spam searches for notes having tag office which do not have tag spam. any:1 tag:office tag:spam searches for notes having tag office or tag spam. tag:be*ful does a search with wildcards. tag:* returns all notes with tags. -tag:* returns all notes without tags.
\n
\n
\n
notebook:
\n
Restrict the search to the specified notebook(s).
\n
notebook:books limits the search scope within books and all its subnotebooks. notebook:wheel*time does a wildcard search.
\n
\n
\n
created: updated: due:
\n
Searches for notes created/updated on dates specified using YYYYMMDD format. You can also search relative to the current day, week, month, or year.
\n
created:20201218 will return notes created on or after December 18, 2020. -updated:20201218 will return notes updated before December 18, 2020. created:20200118 -created:20201215 will return notes created between January 18, 2020, and before December 15, 2020. created:202001 -created:202003 will return notes created on or after January and before March 2020. updated:1997 -updated:2020 will return all notes updated between the years 1997 and 2019. created:day-2 searches for all notes created in the past two days. updated:year-0 searches all notes updated in the current year. -due:day+7 will return all todos which are due or will be due in the next seven days. -due:day-5 searches all todos that are overdue for more than 5 days.
\n
\n
\n
type:
\n
Restrict the search to either notes or todos.
\n
type:note to return all notes type:todo to return all todos
\n
\n
\n
iscompleted:
\n
Restrict the search to either completed or uncompleted todos.
\n
iscompleted:1 to return all completed todos iscompleted:0 to return all uncompleted todos
\n
\n
\n
latitude: longitude: altitude:
\n
Filter by location
\n
latitude:40 -latitude:50 to return notes with latitude >= 40 and < 50
\n
\n
\n
resource:
\n
Filter by attachment MIME type
\n
resource:image/jpeg to return notes with a jpeg attachment. -resource:application/pdf to return notes without a pdf attachment. resource:image/* to return notes with any images.
\n
\n
\n
sourceurl:
\n
Filter by source URL
\n
sourceurl:https://www.google.com sourceurl:*joplinapp.org to perform a wildcard search.
\n
\n
\n
id:
\n
Filter by note ID
\n
id:9cbc1b4f242043a9b8a50627508bccd5 return a note with the specified id
\n
\n\n
\n
Note: In the CLI client you have to escape the query using -- when using negated filters.\nEg. :search -- \"-tag:tag1\".
\n
The filters are implicitly connected by and/or connectives depending on the following rules:
\n
\n
By default, all filters are connected by \"AND\".
\n
To override this default behaviour, use the any filter, in which case the search terms will be connected by \"OR\" instead.
\n
There's an exception for the notebook filters which are connected by \"OR\". The reason being that no note can be in multiple notebooks at once.
\n
\n
Incorrect search filters are interpreted as a phrase search, e.g. misspelled nootebook:Example or non-existing https://joplinapp.org.
\n
Search order
\n
Notes are sorted by \"relevance\". Currently it means the notes that contain the requested terms the most times are on top. For queries with multiple terms, it also matters how close to each other the terms are. This is a bit experimental so if you notice a search query that returns unexpected results, please report it in the forum, providing as many details as possible to replicate the issue.
\n
Goto Anything
\n
In the desktop application, press Ctrl+P or Cmd+P and type a note title or part of its content to jump to it. Or type # followed by a tag name, or @ followed by a notebook name.
\n
Privacy
\n
Joplin values your privacy and security by giving you complete control over your information and digital footprint.
\n
Joplin applications do not send any data to any service without your authorisation. Any data that Joplin saves, such as notes or images, are saved to your own device and you are free to delete this data at any time.
\n
Joplin has many modern features, some of which use third-party services. You can disable any or all of these features in the application settings. These features are:
\n
\n\n
\n
Feature
\n
Description
\n
Default
\n
\n\n\n
\n
Auto-update
\n
Joplin periodically connects to GitHub to check for new releases.
\n
Enabled
\n
\n
\n
Geo-location
\n
Joplin saves geo-location information in note properties when you create a note.
\n
Enabled
\n
\n
\n
Synchronisation
\n
Joplin supports synchronisation of your notes across multiple devices. If you choose to synchronise with a third-party, such as OneDrive, the notes will be sent to your OneDrive account, in which case the third-party privacy policy applies.
\n
Disabled
\n
\n\n
\n
Joplin is developed as an open-source application and the source code is freely available online to inspect.
\n
For any question about Joplin privacy, please leave a message on the Joplin Forum.
\n
Donations
\n
Donations to Joplin support the development of the project. Developing quality applications mostly takes time, but there are also some expenses, such as digital certificates to sign the applications, app store fees, hosting, etc. Most of all, your donation will make it possible to keep up the current development standard.
\n
Please see the donation page for information on how to support the development of Joplin.
This is the main place for general discussion about Joplin, user support, software development questions, and to discuss new features. Also where the latest beta versions are released and discussed.
Joplin is currently available in the languages below. If you would like to contribute a new translation, it is quite straightforward, please follow these steps:
In Poedit, open this .pot file, go into the Catalog menu and click Configuration. Change \"Country\" and \"Language\" to your own country and language.
You will be able to read, track and discover many active issues very flexibly by using Jasper in GitHub. It is enabled by a powerful function called \"stream\" of Jasper.
You will be able to read, track and discover many active issues very flexibly by using Jasper in GitHub. It is enabled by a powerful function called \"stream\" of Jasper.
Juggernaut utilizes the Lightning Network to provide end-to-end encrypted, onion-routed, censorship resistanst, peer-to-peer messaging with native payment capabilities.
\n \n
\n
Install
\n
Download the latest release for your OS and follow the instructions below.
\n
macOS
\n
Double click the .dmg file and then drag Juggernaut.app into your Applications folder.
If you are having problems with Juggernaut, please report the issue on Github or Telegram with screenshots and how to reproduce the issue.
\n
Requirements
\n
\n
\n
LND 0.9.x (or greater) with KeySend Enabled
\n
How to enable Keysend
\n
On lnd.conf add :
\n
\n
accept-keysend=1
\n
\n
Or run lnd with this argument:
\n
\n
--accept-keysend
\n
\n
Keysend is currently an experimental feature. Your node will now accept payments from any node on the network without having to provide them with a n invoice first. Note: This is still an experimental feature so please be careful.
\n
\n
\n
Running From Source
\n
\n
download the source git clone git@github.com:LN-Juggernaut/juggernaut-desktop.git
\n
navigate to project directory cd juggernaut-desktop
\n
install dependencies yarn
\n
start the project yarn dev
\n
\n
Building From Source
\n
You can run yarn package to build an executable that will be output in the release directory.
\n
Running more than one instance while testing
\n
Currently the only way I've been able to do this for testing is to run one using yarn dev and the other using a built release from yarn package. If anyone knows how to run two separate instances of an electron app in development, please let me know!
This project follows the all-contributors specification. Contributions of any kind welcome!
\n
",
"readmeOriginal": "
\n \n
Juggernaut utilizes the Lightning Network to provide end-to-end encrypted, onion-routed, censorship resistanst, peer-to-peer messaging with native payment capabilities.
\n \n
\n
Install
\n
Download the latest release for your OS and follow the instructions below.
\n
macOS
\n
Double click the .dmg file and then drag Juggernaut.app into your Applications folder.
If you are having problems with Juggernaut, please report the issue on Github or Telegram with screenshots and how to reproduce the issue.
\n
Requirements
\n
\n
\n
LND 0.9.x (or greater) with KeySend Enabled
\n
How to enable Keysend
\n
On lnd.conf add :
\n
\n
accept-keysend=1
\n
\n
Or run lnd with this argument:
\n
\n
--accept-keysend
\n
\n
Keysend is currently an experimental feature. Your node will now accept payments from any node on the network without having to provide them with a n invoice first. Note: This is still an experimental feature so please be careful.
\n
\n
\n
Running From Source
\n
\n
download the source git clone git@github.com:LN-Juggernaut/juggernaut-desktop.git
\n
navigate to project directory cd juggernaut-desktop
\n
install dependencies yarn
\n
start the project yarn dev
\n
\n
Building From Source
\n
You can run yarn package to build an executable that will be output in the release directory.
\n
Running more than one instance while testing
\n
Currently the only way I've been able to do this for testing is to run one using yarn dev and the other using a built release from yarn package. If anyone knows how to run two separate instances of an electron app in development, please let me know!
Welcome to Hypnos(beta), a streamlined desktop application to sandbox GraphQL calls to RESTful APIs using the Apollo-link-rest package from Apollo Client, as well as giving detailed, helpful error messages.
\n\n\n
* We recently added tabs to handle multiple entries!
\n
Getting Started
\n
Requirements
\n
All you need to do is download your respective OS package, install, and go!
Hypnos will return the GraphQL response or meaningful errors
\n
If there are any errors in query formatting, they will be displayed on the right
\n
\n\n
\n
Features
\n
Hypnos History
\n
Hypnos will store your local query history, persisting queries from your sessions. You can delete your entire history, or you can delete individual queries. You also have the option of repopulating the current tab with a previous query.
\n
\n\n
\n
Tabs
\n
Want to submit another query, but don't want to submit your current query just yet? Just open up a new tab! Hypnos will save the endpoint and query, and you can come back to it later.
\n
\n\n
\n
Authenticated APIs
\n
A majority of APIs require a key in order to gain access to their endpoints, but have no fear: Hypnos supports API keys. Type in your endpoint and query as you would normally, but before you submit the query, go to Submit API Key. Clicking on it will open a new window in which you can enter the key for your headers and the API key given to you by the API itself. Once you submit the keys, you can go ahead and submit your query.
Welcome to Hypnos(beta), a streamlined desktop application to sandbox GraphQL calls to RESTful APIs using the Apollo-link-rest package from Apollo Client, as well as giving detailed, helpful error messages.
\n\n\n
* We recently added tabs to handle multiple entries!
\n
Getting Started
\n
Requirements
\n
All you need to do is download your respective OS package, install, and go!
Hypnos will return the GraphQL response or meaningful errors
\n
If there are any errors in query formatting, they will be displayed on the right
\n
\n\n
\n
Features
\n
Hypnos History
\n
Hypnos will store your local query history, persisting queries from your sessions. You can delete your entire history, or you can delete individual queries. You also have the option of repopulating the current tab with a previous query.
\n
\n\n
\n
Tabs
\n
Want to submit another query, but don't want to submit your current query just yet? Just open up a new tab! Hypnos will save the endpoint and query, and you can come back to it later.
\n
\n\n
\n
Authenticated APIs
\n
A majority of APIs require a key in order to gain access to their endpoints, but have no fear: Hypnos supports API keys. Type in your endpoint and query as you would normally, but before you submit the query, go to Submit API Key. Clicking on it will open a new window in which you can enter the key for your headers and the API key given to you by the API itself. Once you submit the keys, you can go ahead and submit your query.
You will be able to read, track and discover many active issues very flexibly by using Jasper in GitHub. It is enabled by a powerful function called \"stream\" of Jasper.
You will be able to read, track and discover many active issues very flexibly by using Jasper in GitHub. It is enabled by a powerful function called \"stream\" of Jasper.
Joplin is a free, open source note taking and to-do application, which can handle a large number of notes organised into notebooks. The notes are searchable, can be copied, tagged and modified either from the applications directly or from your own text editor. The notes are in Markdown format.
\n
Notes exported from Evernote via .enex files can be imported into Joplin, including the formatted content (which is converted to Markdown), resources (images, attachments, etc.) and complete metadata (geolocation, updated time, created time, etc.). Plain Markdown files can also be imported.
\n
The notes can be synchronised with various cloud services including Nextcloud, Dropbox, OneDrive, WebDAV or the file system (for example with a network directory). When synchronising the notes, notebooks, tags and other metadata are saved to plain text files which can be easily inspected, backed up and moved around.
\n
The application is available for Windows, Linux, macOS, Android and iOS (the terminal app also works on FreeBSD). A Web Clipper, to save web pages and screenshots from your browser, is also available for Firefox and Chrome.
\n
\n
Installation
\n
Three types of applications are available: for the desktop (Windows, macOS and Linux), for mobile (Android and iOS) and for terminal (Windows, macOS, Linux and FreeBSD). All applications have similar user interfaces and can synchronise with each other.
\n
Desktop applications
\n
\n\n
\n
Operating System
\n
Download
\n
\n\n\n
\n
Windows (32 and 64-bit)
\n
\n
\n
\n
macOS
\n
\n
\n
\n
Linux
\n
\n
\n\n
\n
On Windows, you may also use the Portable version. The portable application allows installing the software on a portable device such as a USB key. Simply copy the file JoplinPortable.exe in any directory on that USB key ; the application will then create a directory called \"JoplinProfile\" next to the executable file.
\n
On Linux, the recommended way is to use the following installation script as it will handle the desktop icon too:
By default, the application binary will be installed under ~/.joplin-bin. You may change this directory if needed. Alternatively, if your npm permissions are setup as described here (Option 2) then simply running npm -g install joplin would work.
There are other ways to install the terminal application. However, they are not supported and problems must be reported to the upstream projects.
\n
\n\n
\n
Operating system
\n
Method
\n
\n\n\n
\n
macOS
\n
brew install joplin
\n
\n
\n
Arch Linux
\n
An Arch Linux package is available here. To install it, use an AUR wrapper such as yay: yay -S joplin. Both the CLI tool (type joplin) and desktop app (type joplin-desktop) are packaged. You can also install a compiled version with the chaotic-aur repository. For support, please go to the GitHub repo. If you are interested in pre-release you have joplin-beta.
\n
\n\n
\n
Web Clipper
\n
The Web Clipper is a browser extension that allows you to save web pages and screenshots from your browser. For more information on how to install and use it, see the Web Clipper Help Page.
Synchronisation with various services, including Nextcloud, Dropbox, WebDAV and OneDrive.
\n
Offline first, so the entire data is always available on the device even without an internet connection.
\n
Import Enex files (Evernote export format) and Markdown files.
\n
Export JEX files (Joplin Export format) and raw files.
\n
Support notes, to-dos, tags and notebooks.
\n
Sort notes by multiple criteria - title, updated time, etc.
\n
Support for alarms (notifications) in mobile and desktop applications.
\n
Markdown notes, which are rendered with images and formatting in the desktop and mobile applications. Support for extra features such as math notation and checkboxes.
\n
Choice of both Markdown and Rich Text (WYSIWYG) editors.
\n
File attachment support - images are displayed, other files are linked and can be opened in the relevant application.
\n
Inline display of PDF, video and audio files.
\n
Goto Anything feature.
\n
Search functionality.
\n
Geo-location support.
\n
Supports multiple languages.
\n
External editor support - open notes in your favorite external editor with one click in Joplin.
\n
Extensible functionality through plugin and data APIs.
\n
Template support with data variables for auto creation of time & dates.
\n
Custom CSS support for customisation of both the rendered markdown and overall user interface.
\n
Customisable layout allows toggling, movement and sizing of various elements.
\n
Keyboard shortcuts are editable and allow binding of most Joplin commands with export/import functionality.
\n
\n
Importing
\n
Importing from Evernote
\n
Joplin was designed as a replacement for Evernote and so can import complete Evernote notebooks, as well as notes, tags, resources (attached files) and note metadata (such as author, geo-location, etc.) via ENEX files. In terms of data, the only two things that might slightly differ are:
\n
\n
\n
Recognition data - Evernote images, in particular scanned (or photographed) documents have recognition data associated with them. It is the text that Evernote has been able to recognise in the document. This data is not preserved when the note are imported into Joplin. However, should it become supported in the search tool or other parts of Joplin, it should be possible to regenerate this recognition data since the actual image would still be available.
\n
\n
\n
Colour, font sizes and faces - Evernote text is stored as HTML and this is converted to Markdown during the import process. For notes that are mostly plain text or with basic formatting (bold, italic, bullet points, links, etc.) this is a lossless conversion, and the note, once rendered back to HTML should be very similar. Tables are also imported and converted to Markdown tables. For very complex notes, some formatting data might be lost - in particular colours, font sizes and font faces will not be imported. The text itself however is always imported in full regardless of formatting. If it is essential that this extra data is preserved then Joplin also allows import of ENEX files as HTML.
\n
\n
\n
To import Evernote data, first export your Evernote notebooks to ENEX files as described here. Then follow these steps:
\n
In the desktop application, open File > Import > ENEX and select your file. The notes will be imported into a new separate notebook. If needed they can then be moved to a different notebook, or the notebook can be renamed, etc.
\n
In the terminal application, in command-line mode, type import /path/to/file.enex. This will import the notes into a new notebook named after the filename.
\n
Importing from Markdown files
\n
Joplin can import notes from plain Markdown file. You can either import a complete directory of Markdown files or individual files.
\n
In the desktop application:
\n
\n
File import: Go to File > Import > MD - Markdown (file) and select the Markdown file. This file will then be imported to the currently selected Notebook.
\n
Directory import: Go to File > Import > MD - Markdown (directory) and select the top level of the directory that is being imported. Directory (folder) structure will be preserved in the Notebook > Subnotebook > Note structure within Joplin.
\n
\n
In the terminal application, in command-line mode, type import --format md /path/to/file.md or import --format md /path/to/directory/.
\n
Importing from other applications
\n
In general the way to import notes from any application into Joplin is to convert the notes to ENEX files (Evernote format) and to import these ENEX files into Joplin using the method above. Most note-taking applications support ENEX files so it should be relatively straightforward. For help about specific applications, see below:
NixNote: Synchronise with Evernote, then export the ENEX files and import them into Joplin. More info in this thread.
\n
\n
Exporting
\n
Joplin can export to the JEX format (Joplin Export file), which is a tar file that can contain multiple notes, notebooks, etc. This is a lossless format in that all the notes, but also metadata such as geo-location, updated time, tags, etc. are preserved. This format is convenient for backup purposes and can be re-imported into Joplin. A \"raw\" format is also available. This is the same as the JEX format except that the data is saved to a directory and each item represented by a single file.\nJoplin is also capable of exporting to a number of other formats including HTML and PDF which can be done for single notes, notebooks or everything.
\n
Synchronisation
\n
One of the goals of Joplin is to avoid being tied to any particular company or service, whether it is Evernote, Google or Microsoft. As such the synchronisation is designed without any hard dependency to any particular service. Most of the synchronisation process is done at an abstract level and access to external services, such as Nextcloud or Dropbox, is done via lightweight drivers. It is easy to support new services by creating simple drivers that provide a filesystem-like interface, i.e. the ability to read, write, delete and list items. It is also simple to switch from one service to another or to even sync to multiple services at once. Each note, notebook, tags, as well as the relation between items is transmitted as plain text files during synchronisation, which means the data can also be moved to a different application, can be easily backed up, inspected, etc.
\n
Currently, synchronisation is possible with Nextcloud, WebDAV, Dropbox, OneDrive or the local filesystem. To enable synchronisation please follow the instructions below. After that, the application will synchronise in the background whenever it is running, or you can click on \"Synchronise\" to start a synchronisation manually. Joplin will background sync automatically after any content change is made on the local application.
\n
If the terminal client has been installed, it is possible to also synchronise outside of the user interface by typing joplin sync from the terminal. This can be used to setup a cron script to synchronise at a regular interval. For example, this would do it every 30 minutes:
\n
*/30 * * * * /path/to/joplin sync
\n
Nextcloud synchronisation
\n
Nextcloud is a self-hosted, private cloud solution. It can store documents, images and videos but also calendars, passwords and countless other things and can sync them to your laptop or phone. As you can host your own Nextcloud server, you own both the data on your device and infrastructure used for synchronisation. As such it is a good fit for Joplin. The platform is also well supported and with a strong community, so it is likely to be around for a while - since it's open source anyway, it is not a service that can be closed, it can exist on a server for as long as one chooses.
\n
In the desktop application or mobile application, go to the Configuration screen and select Nextcloud as the synchronisation target. Then input the WebDAV URL (to get it, click on Settings in the bottom left corner of the page, in Nextcloud), this is normally https://example.com/nextcloud/remote.php/webdav/Joplin (make sure to create the \"Joplin\" directory in Nextcloud), and set the username and password. If it does not work, please see this explanation for more details.
\n
In the terminal application, you will need to set the sync.target config variable and all the sync.5.path, sync.5.username and sync.5.password config variables to, respectively the Nextcloud WebDAV URL, your username and your password. This can be done from the command line mode using:
If synchronisation does not work, please consult the logs in the app profile directory - it is often due to a misconfigured URL or password. The log should indicate what the exact issue is.
\n
WebDAV synchronisation
\n
Select the \"WebDAV\" synchronisation target and follow the same instructions as for Nextcloud above (for the terminal application you will need to select sync target 6 rather than 5)
\n
WebDAV-compatible services that are known to work with Joplin:
When syncing with Dropbox, Joplin creates a sub-directory in Dropbox, in /Apps/Joplin and read/write the notes and notebooks from it. The application does not have access to anything outside this directory.
\n
In the desktop application or mobile application, select \"Dropbox\" as the synchronisation target in the Configuration screen (it is selected by default). Then, to initiate the synchronisation process, click on the \"Synchronise\" button in the sidebar and follow the instructions.
\n
In the terminal application, to initiate the synchronisation process, type :sync. You will be asked to follow a link to authorise the application.
\n
OneDrive synchronisation
\n
When syncing with OneDrive, Joplin creates a sub-directory in OneDrive, in /Apps/Joplin and read/write the notes and notebooks from it. The application does not have access to anything outside this directory.
\n
In the desktop application or mobile application, select \"OneDrive\" as the synchronisation target in the Configuration screen. Then, to initiate the synchronisation process, click on the \"Synchronise\" button in the sidebar and follow the instructions.
\n
In the terminal application, to initiate the synchronisation process, type :sync. You will be asked to follow a link to authorise the application (simply input your Microsoft credentials - you do not need to register with OneDrive).
\n
AWS S3 synchronisation
\n
In the desktop application or mobile application, select \"AWS S3 (Beta)\" as the synchronisation target in the Configuration screen.
\n
\n
AWS S3 Bucket: The name of your Bucket, such as joplin-bucket
\n
AWS S3 URL: Fully qualified URL; By default this should be https://s3.amazonaws.com/
\n
AWS key & AWS secret: IAM user's programmatic access key. To create a new key & secret, visit IAM Security Credentials.
\n
\n
While creating a new Bucket for Joplin, disable Bucket Versioning, enable Block all public access and enable Default encryption with Amazon S3 key (SSE-S3).
\n
To add a Bucket Policy from the AWS S3 Web Console, navigate to the Permissions tab. Temporarily disable Block all public access to edit the Bucket policy, something along the lines of:
Joplin supports end-to-end encryption (E2EE) on all the applications. E2EE is a system where only the owner of the notes, notebooks, tags or resources can read them. It prevents potential eavesdroppers - including telecom providers, internet providers, and even the developers of Joplin from being able to access the data. Please see the End-To-End Encryption Tutorial for more information about this feature and how to enable it.
\n
For a more technical description, mostly relevant for development or to review the method being used, please see the Encryption specification.
\n
Note history
\n
The Joplin applications automatically save previous versions of your notes at regular intervals. These versions are synced across devices and can be viewed from the desktop application. To do so, click on the \"Information\" button on a note, then click on \"Previous version of this note\". From this screen you can view the previous versions of the note as well as restore any of them.
\n
This feature can be disabled from the \"Note history\" section in the Configuration screen, and it is also possible to change for how long the history of a note is saved.
Joplin notes can be opened and edited using an external editor of your choice. It can be a simple text editor like Notepad++ or Sublime Text or an actual Markdown editor like Typora. In that case, images will also be displayed within the editor. To open the note in an external editor, click on the icon in the toolbar or press Ctrl+E (or Cmd+E). Your default text editor will be used to open the note. If needed, you can also specify the editor directly in the General Options, under \"Text editor command\".
\n
Attachments
\n
Any kind of file can be attached to a note. In Markdown, links to these files are represented as a simple ID to the attachment, clicking on this link will open the file in the default application. In the case of audio, video and pdf files, these will be displayed inline with the note and so can be viewed or played within Joplin.
\n
In the desktop application, files can be attached either by clicking the \"Attach file\" icon in the editor or via drag and drop. If you prefer to create a link to a local file instead, hold the ALT key while performing the drag and drop operation. You can also copy and paste images directly in the editor via Ctrl+V.
\n
Resources that are not attached to any note will be automatically deleted in accordance to the Note History settings.
\n
Important: Resources larger than 10 MB are not currently supported on mobile. They will crash the application when synchronising so it is recommended not to attach such resources at the moment. The issue is being looked at.
\n
Downloading attachments
\n
The way the attachments are downloaded during synchronisation can be customised in the Configuration screen, under \"Attachment download behaviour\". The default option (\"Always\") is to download all the attachments, all the time, so that the data is available even when the device is offline. There is also the option to download the attachments manually (option \"Manual\"), by clicking on it, or automatically (Option \"Auto\"), in which case the attachments are downloaded only when a note is opened. These options should help saving disk space and network bandwidth, especially on mobile.
\n
Notifications
\n
In the desktop and mobile apps, an alarm can be associated with any to-do. It will be triggered at the given time by displaying a notification. How the notification will be displayed depends on the operating system since each has a different way to handle this. Please see below for the requirements for the desktop applications:
\n
\n
Windows: >= 8. Make sure the Action Center is enabled on Windows. Task bar balloon for Windows < 8. Growl as fallback. Growl takes precedence over Windows balloons.
\n
macOS: >= 10.8 or Growl if earlier.
\n
Linux: notify-send tool, delivered through packages notify-osd, libnotify-bin or libnotify-tools. GNOME should have this by default, but install libnotify-tools if using KDE Plasma.
On mobile, the alarms will be displayed using the built-in notification system.
\n
If for any reason the notifications do not work, please open an issue.
\n
Sub-notebooks
\n
Sub-notebooks allow organising multiple notebooks into a tree of notebooks. For example it can be used to regroup all the notebooks related to work, to family or to a particular project under a parent notebook.
\n
\n
\n
In the desktop application, to create a subnotebook, drag and drop it onto another notebook. To move it back to the root, drag and drop it on the \"Notebooks\" header. Currently only the desktop app can be used to organise the notebooks.
\n
The mobile application supports displaying and collapsing/expanding the tree of notebooks, however it does not currently support moving the subnotebooks to different notebooks.
\n
The terminal app supports displaying the tree of subnotebooks but it does not support collapsing/expanding them or moving the subnotebooks around.
\n
\n
Markdown
\n
Joplin uses and renders a Github-flavoured Markdown with a few variations and additions. In particular it adds math formula support, interactive checkboxes and support for note links. Joplin also supports Markdown plugins which allow enabling and disabling various advanced Markdown features. Have a look at the Markdown Guide for more information.
\n
Custom CSS
\n
Rendered markdown can be customized by placing a userstyle file in the profile directory ~/.config/joplin-desktop/userstyle.css (This path might be different on your device - check at the top of the General page of the Configuration menu for the exact path). This file supports standard CSS syntax. Joplin must be restarted for the new css to be applied, please ensure that Joplin is not closing to the tray, but is actually exiting. Note that this file is used for both displaying the notes and printing the notes. Be aware how the CSS may look printed (for example, printing white text over a black background is usually not wanted).
\n
The whole UI can be customized by placing a custom editor style file in the profile directory ~/.config/joplin-desktop/userchrome.css.
\n
Important: userstyle.css and userchrome.css are provided for your convenience, but they are advanced settings, and styles you define may break from one version to the next. If you want to use them, please know that it might require regular development work from you to keep them working. The Joplin team cannot make a commitment to keep the application HTML structure stable.
\n
Note templates
\n
In the desktop app, templates can be used to create new notes or to insert into existing ones by adding a template file to the templates directory (File > Templates). For example creating the file hours.md in the templates directory with the contents:
\n
Date: {{date}}\nHours:\nDetails:
\n
Templates can then be inserted from the menu (File->Templates).
\n
The currently supported template variables are:
\n
\n\n
\n
Variable
\n
Description
\n
Example
\n
\n\n\n
\n
{{date}}
\n
Today's date formatted based on the settings format
\n
2019-01-01
\n
\n
\n
{{time}}
\n
Current time formatted based on the settings format
\n
13:00
\n
\n
\n
{{datetime}}
\n
Current date and time formatted based on the settings format
\n
01/01/19 1:00 PM
\n
\n
\n
{{#custom_datetime}}
\n
Current date and/or time formatted based on a supplied string (using moment.js formatting)
\n
{{#custom_datetime}}M d{{/custom_datetime}}
\n
\n
\n
{{bowm}}
\n
Date of the beginning of the week (when week starts on Monday) based on the settings format
\n
\n
\n
\n
{{bows}}
\n
Date of the beginning of the week (when week starts on Sunday) based on the settings format
\n
\n
\n\n
\n
Plugins
\n
The desktop app has the ability to extend beyond its standard functionality by the way of plugins. These plugins adhere to the Joplin plugin API and can be installed & configured within the application via the Plugins page in the Configuration screen. This menu allows the manual installation of the plugin using the single 'Joplin Plugin Archive' (*.jpl) file. Once the application is reloaded the plugins will appear within the plugins menu where they can be toggled on/off or removed entirely.
Joplin implements the SQLite Full Text Search (FTS4) extension. It means the content of all the notes is indexed in real time and search queries return results very fast. Both Simple FTS Queries and Full-Text Index Queries are supported. See below for the list of supported queries:
\n
One caveat of SQLite FTS is that it does not support languages which do not use Latin word boundaries (spaces, tabs, punctuation). To solve this issue, Joplin has a custom search mode, that does not use FTS, but still has all of its features (multi term search, filters, etc.). One of its drawbacks is that it can get slow on larger note collections. Also, the sorting of the results will be less accurate, as the ranking algorithm (BM25) is, for now, only implemented for FTS. Finally, in this mode there are no restrictions on using the * wildcard (swim*, *swim and ast*rix all work). This search mode is currently enabled if one of the following languages are detected:
\n
\n
Chinese
\n
Japanese
\n
Korean
\n
Thai
\n
\n
Supported queries
\n
\n\n
\n
Search type
\n
Description
\n
Example
\n
\n\n\n
\n
Single word
\n
Returns all the notes that contain this term.
\n
For example, searching for cat will return all the notes that contain this exact word. Note: it will not return the notes that contain the substring - thus, for \"cat\", notes that contain \"cataclysmic\" or \"prevaricate\" will not be returned.
\n
\n
\n
Multiple word
\n
Returns all the notes that contain all these words, but not necessarily next to each other.
\n
dog cat - will return any notes that contain the words \"dog\" and \"cat\" anywhere in the note, no necessarily in that order nor next to each other. It will not return results that contain \"dog\" or \"cat\" only.
\n
\n
\n
Phrase
\n
Add double quotes to return the notes that contain exactly this phrase.
\n
\"shopping list\" - will return the notes that contain these exact terms next to each other and in this order. It will not return for example a note that contains \"going shopping with my list\".
\n
\n
\n
Prefix
\n
Add a wildcard to return all the notes that contain a term with a specified prefix.
\n
swim* - will return all the notes that contain eg. \"swim\", but also \"swimming\", \"swimsuit\", etc. IMPORTANT: The wildcard can only be at the end - it will be ignored at the beginning of a word (eg. *swim) and will be treated as a literal asterisk in the middle of a word (eg. ast*rix)
\n
\n
\n
Switch to basic search
\n
One drawback of Full Text Search is that it ignores most non-alphabetical characters. However in some cases you might want to search for this too. To do that, you can use basic search. You switch to this mode by prefixing your search with a slash /. This won't provide the benefits of FTS but it will allow searching exactly for what you need. Note that it can also be much slower, even extremely slow, depending on your query.
\n
/\"- [ ]\" - will return all the notes that contain unchecked checkboxes.
\n
\n\n
\n
Search filters
\n
You can also use search filters to further restrict the search.
\n
\n\n
\n
Operator
\n
Description
\n
Example
\n
\n\n\n
\n
-
\n
If placed before a text term, it excludes the notes that contain that term. You can also place it before a filter to negate it.
\n
-spam searches for all notes without the word spam. office -trash searches for all notes with the wordoffice and without the word trash.
\n
\n
\n
any:
\n
Return notes that satisfy any/all of the required conditions. any:0 is the default, which means all conditions must be satisfied.
\n
any:1 cat dog will return notes that have the word cat or dog. any:0 cat dog will return notes with both the words cat and dog.
\n
\n
\n
title: body:
\n
Restrict your search to just the title or the body field.
\n
title:\"hello world\" searches for notes whose title contains hello and world. title:hello -body:world searches for notes whose title contains hello and body does not contain world.
\n
\n
\n
tag:
\n
Restrict the search to the notes with the specified tags.
\n
tag:office searches for all notes having tag office. tag:office tag:important searches for all notes having both office and important tags. tag:office -tag:spam searches for notes having tag office which do not have tag spam. any:1 tag:office tag:spam searches for notes having tag office or tag spam. tag:be*ful does a search with wildcards. tag:* returns all notes with tags. -tag:* returns all notes without tags.
\n
\n
\n
notebook:
\n
Restrict the search to the specified notebook(s).
\n
notebook:books limits the search scope within books and all its subnotebooks. notebook:wheel*time does a wildcard search.
\n
\n
\n
created: updated: due:
\n
Searches for notes created/updated on dates specified using YYYYMMDD format. You can also search relative to the current day, week, month, or year.
\n
created:20201218 will return notes created on or after December 18, 2020. -updated:20201218 will return notes updated before December 18, 2020. created:20200118 -created:20201215 will return notes created between January 18, 2020, and before December 15, 2020. created:202001 -created:202003 will return notes created on or after January and before March 2020. updated:1997 -updated:2020 will return all notes updated between the years 1997 and 2019. created:day-2 searches for all notes created in the past two days. updated:year-0 searches all notes updated in the current year. -due:day+7 will return all todos which are due or will be due in the next seven days. -due:day-5 searches all todos that are overdue for more than 5 days.
\n
\n
\n
type:
\n
Restrict the search to either notes or todos.
\n
type:note to return all notes type:todo to return all todos
\n
\n
\n
iscompleted:
\n
Restrict the search to either completed or uncompleted todos.
\n
iscompleted:1 to return all completed todos iscompleted:0 to return all uncompleted todos
\n
\n
\n
latitude: longitude: altitude:
\n
Filter by location
\n
latitude:40 -latitude:50 to return notes with latitude >= 40 and < 50
\n
\n
\n
resource:
\n
Filter by attachment MIME type
\n
resource:image/jpeg to return notes with a jpeg attachment. -resource:application/pdf to return notes without a pdf attachment. resource:image/* to return notes with any images.
\n
\n
\n
sourceurl:
\n
Filter by source URL
\n
sourceurl:https://www.google.com sourceurl:*joplinapp.org to perform a wildcard search.
\n
\n
\n
id:
\n
Filter by note ID
\n
id:9cbc1b4f242043a9b8a50627508bccd5 return a note with the specified id
\n
\n\n
\n
Note: In the CLI client you have to escape the query using -- when using negated filters.\nEg. :search -- \"-tag:tag1\".
\n
The filters are implicitly connected by and/or connectives depending on the following rules:
\n
\n
By default, all filters are connected by \"AND\".
\n
To override this default behaviour, use the any filter, in which case the search terms will be connected by \"OR\" instead.
\n
There's an exception for the notebook filters which are connected by \"OR\". The reason being that no note can be in multiple notebooks at once.
\n
\n
Incorrect search filters are interpreted as a phrase search, e.g. misspelled nootebook:Example or non-existing https://joplinapp.org.
\n
Search order
\n
Notes are sorted by \"relevance\". Currently it means the notes that contain the requested terms the most times are on top. For queries with multiple terms, it also matters how close to each other the terms are. This is a bit experimental so if you notice a search query that returns unexpected results, please report it in the forum, providing as many details as possible to replicate the issue.
\n
Goto Anything
\n
In the desktop application, press Ctrl+P or Cmd+P and type a note title or part of its content to jump to it. Or type # followed by a tag name, or @ followed by a notebook name.
\n
Privacy
\n
Joplin values your privacy and security by giving you complete control over your information and digital footprint.
\n
Joplin applications do not send any data to any service without your authorisation. Any data that Joplin saves, such as notes or images, are saved to your own device and you are free to delete this data at any time.
\n
Joplin has many modern features, some of which use third-party services. You can disable any or all of these features in the application settings. These features are:
\n
\n\n
\n
Feature
\n
Description
\n
Default
\n
\n\n\n
\n
Auto-update
\n
Joplin periodically connects to GitHub to check for new releases.
\n
Enabled
\n
\n
\n
Geo-location
\n
Joplin saves geo-location information in note properties when you create a note.
\n
Enabled
\n
\n
\n
Synchronisation
\n
Joplin supports synchronisation of your notes across multiple devices. If you choose to synchronise with a third-party, such as OneDrive, the notes will be sent to your OneDrive account, in which case the third-party privacy policy applies.
\n
Disabled
\n
\n\n
\n
Joplin is developed as an open-source application and the source code is freely available online to inspect.
\n
For any question about Joplin privacy, please leave a message on the Joplin Forum.
\n
Donations
\n
Donations to Joplin support the development of the project. Developing quality applications mostly takes time, but there are also some expenses, such as digital certificates to sign the applications, app store fees, hosting, etc. Most of all, your donation will make it possible to keep up the current development standard.
\n
Please see the donation page for information on how to support the development of Joplin.
This is the main place for general discussion about Joplin, user support, software development questions, and to discuss new features. Also where the latest beta versions are released and discussed.
Joplin is currently available in the languages below. If you would like to contribute a new translation, it is quite straightforward, please follow these steps:
In Poedit, open this .pot file, go into the Catalog menu and click Configuration. Change \"Country\" and \"Language\" to your own country and language.
Joplin is a free, open source note taking and to-do application, which can handle a large number of notes organised into notebooks. The notes are searchable, can be copied, tagged and modified either from the applications directly or from your own text editor. The notes are in Markdown format.
\n
Notes exported from Evernote via .enex files can be imported into Joplin, including the formatted content (which is converted to Markdown), resources (images, attachments, etc.) and complete metadata (geolocation, updated time, created time, etc.). Plain Markdown files can also be imported.
\n
The notes can be synchronised with various cloud services including Nextcloud, Dropbox, OneDrive, WebDAV or the file system (for example with a network directory). When synchronising the notes, notebooks, tags and other metadata are saved to plain text files which can be easily inspected, backed up and moved around.
\n
The application is available for Windows, Linux, macOS, Android and iOS (the terminal app also works on FreeBSD). A Web Clipper, to save web pages and screenshots from your browser, is also available for Firefox and Chrome.
\n
\n
Installation
\n
Three types of applications are available: for the desktop (Windows, macOS and Linux), for mobile (Android and iOS) and for terminal (Windows, macOS, Linux and FreeBSD). All applications have similar user interfaces and can synchronise with each other.
\n
Desktop applications
\n
\n\n
\n
Operating System
\n
Download
\n
\n\n\n
\n
Windows (32 and 64-bit)
\n
\n
\n
\n
macOS
\n
\n
\n
\n
Linux
\n
\n
\n\n
\n
On Windows, you may also use the Portable version. The portable application allows installing the software on a portable device such as a USB key. Simply copy the file JoplinPortable.exe in any directory on that USB key ; the application will then create a directory called \"JoplinProfile\" next to the executable file.
\n
On Linux, the recommended way is to use the following installation script as it will handle the desktop icon too:
By default, the application binary will be installed under ~/.joplin-bin. You may change this directory if needed. Alternatively, if your npm permissions are setup as described here (Option 2) then simply running npm -g install joplin would work.
There are other ways to install the terminal application. However, they are not supported and problems must be reported to the upstream projects.
\n
\n\n
\n
Operating system
\n
Method
\n
\n\n\n
\n
macOS
\n
brew install joplin
\n
\n
\n
Arch Linux
\n
An Arch Linux package is available here. To install it, use an AUR wrapper such as yay: yay -S joplin. Both the CLI tool (type joplin) and desktop app (type joplin-desktop) are packaged. You can also install a compiled version with the chaotic-aur repository. For support, please go to the GitHub repo. If you are interested in pre-release you have joplin-beta.
\n
\n\n
\n
Web Clipper
\n
The Web Clipper is a browser extension that allows you to save web pages and screenshots from your browser. For more information on how to install and use it, see the Web Clipper Help Page.
Synchronisation with various services, including Nextcloud, Dropbox, WebDAV and OneDrive.
\n
Offline first, so the entire data is always available on the device even without an internet connection.
\n
Import Enex files (Evernote export format) and Markdown files.
\n
Export JEX files (Joplin Export format) and raw files.
\n
Support notes, to-dos, tags and notebooks.
\n
Sort notes by multiple criteria - title, updated time, etc.
\n
Support for alarms (notifications) in mobile and desktop applications.
\n
Markdown notes, which are rendered with images and formatting in the desktop and mobile applications. Support for extra features such as math notation and checkboxes.
\n
Choice of both Markdown and Rich Text (WYSIWYG) editors.
\n
File attachment support - images are displayed, other files are linked and can be opened in the relevant application.
\n
Inline display of PDF, video and audio files.
\n
Goto Anything feature.
\n
Search functionality.
\n
Geo-location support.
\n
Supports multiple languages.
\n
External editor support - open notes in your favorite external editor with one click in Joplin.
\n
Extensible functionality through plugin and data APIs.
\n
Template support with data variables for auto creation of time & dates.
\n
Custom CSS support for customisation of both the rendered markdown and overall user interface.
\n
Customisable layout allows toggling, movement and sizing of various elements.
\n
Keyboard shortcuts are editable and allow binding of most Joplin commands with export/import functionality.
\n
\n
Importing
\n
Importing from Evernote
\n
Joplin was designed as a replacement for Evernote and so can import complete Evernote notebooks, as well as notes, tags, resources (attached files) and note metadata (such as author, geo-location, etc.) via ENEX files. In terms of data, the only two things that might slightly differ are:
\n
\n
\n
Recognition data - Evernote images, in particular scanned (or photographed) documents have recognition data associated with them. It is the text that Evernote has been able to recognise in the document. This data is not preserved when the note are imported into Joplin. However, should it become supported in the search tool or other parts of Joplin, it should be possible to regenerate this recognition data since the actual image would still be available.
\n
\n
\n
Colour, font sizes and faces - Evernote text is stored as HTML and this is converted to Markdown during the import process. For notes that are mostly plain text or with basic formatting (bold, italic, bullet points, links, etc.) this is a lossless conversion, and the note, once rendered back to HTML should be very similar. Tables are also imported and converted to Markdown tables. For very complex notes, some formatting data might be lost - in particular colours, font sizes and font faces will not be imported. The text itself however is always imported in full regardless of formatting. If it is essential that this extra data is preserved then Joplin also allows import of ENEX files as HTML.
\n
\n
\n
To import Evernote data, first export your Evernote notebooks to ENEX files as described here. Then follow these steps:
\n
In the desktop application, open File > Import > ENEX and select your file. The notes will be imported into a new separate notebook. If needed they can then be moved to a different notebook, or the notebook can be renamed, etc.
\n
In the terminal application, in command-line mode, type import /path/to/file.enex. This will import the notes into a new notebook named after the filename.
\n
Importing from Markdown files
\n
Joplin can import notes from plain Markdown file. You can either import a complete directory of Markdown files or individual files.
\n
In the desktop application:
\n
\n
File import: Go to File > Import > MD - Markdown (file) and select the Markdown file. This file will then be imported to the currently selected Notebook.
\n
Directory import: Go to File > Import > MD - Markdown (directory) and select the top level of the directory that is being imported. Directory (folder) structure will be preserved in the Notebook > Subnotebook > Note structure within Joplin.
\n
\n
In the terminal application, in command-line mode, type import --format md /path/to/file.md or import --format md /path/to/directory/.
\n
Importing from other applications
\n
In general the way to import notes from any application into Joplin is to convert the notes to ENEX files (Evernote format) and to import these ENEX files into Joplin using the method above. Most note-taking applications support ENEX files so it should be relatively straightforward. For help about specific applications, see below:
NixNote: Synchronise with Evernote, then export the ENEX files and import them into Joplin. More info in this thread.
\n
\n
Exporting
\n
Joplin can export to the JEX format (Joplin Export file), which is a tar file that can contain multiple notes, notebooks, etc. This is a lossless format in that all the notes, but also metadata such as geo-location, updated time, tags, etc. are preserved. This format is convenient for backup purposes and can be re-imported into Joplin. A \"raw\" format is also available. This is the same as the JEX format except that the data is saved to a directory and each item represented by a single file.\nJoplin is also capable of exporting to a number of other formats including HTML and PDF which can be done for single notes, notebooks or everything.
\n
Synchronisation
\n
One of the goals of Joplin is to avoid being tied to any particular company or service, whether it is Evernote, Google or Microsoft. As such the synchronisation is designed without any hard dependency to any particular service. Most of the synchronisation process is done at an abstract level and access to external services, such as Nextcloud or Dropbox, is done via lightweight drivers. It is easy to support new services by creating simple drivers that provide a filesystem-like interface, i.e. the ability to read, write, delete and list items. It is also simple to switch from one service to another or to even sync to multiple services at once. Each note, notebook, tags, as well as the relation between items is transmitted as plain text files during synchronisation, which means the data can also be moved to a different application, can be easily backed up, inspected, etc.
\n
Currently, synchronisation is possible with Nextcloud, WebDAV, Dropbox, OneDrive or the local filesystem. To enable synchronisation please follow the instructions below. After that, the application will synchronise in the background whenever it is running, or you can click on \"Synchronise\" to start a synchronisation manually. Joplin will background sync automatically after any content change is made on the local application.
\n
If the terminal client has been installed, it is possible to also synchronise outside of the user interface by typing joplin sync from the terminal. This can be used to setup a cron script to synchronise at a regular interval. For example, this would do it every 30 minutes:
\n
*/30 * * * * /path/to/joplin sync
\n
Nextcloud synchronisation
\n
Nextcloud is a self-hosted, private cloud solution. It can store documents, images and videos but also calendars, passwords and countless other things and can sync them to your laptop or phone. As you can host your own Nextcloud server, you own both the data on your device and infrastructure used for synchronisation. As such it is a good fit for Joplin. The platform is also well supported and with a strong community, so it is likely to be around for a while - since it's open source anyway, it is not a service that can be closed, it can exist on a server for as long as one chooses.
\n
In the desktop application or mobile application, go to the Configuration screen and select Nextcloud as the synchronisation target. Then input the WebDAV URL (to get it, click on Settings in the bottom left corner of the page, in Nextcloud), this is normally https://example.com/nextcloud/remote.php/webdav/Joplin (make sure to create the \"Joplin\" directory in Nextcloud), and set the username and password. If it does not work, please see this explanation for more details.
\n
In the terminal application, you will need to set the sync.target config variable and all the sync.5.path, sync.5.username and sync.5.password config variables to, respectively the Nextcloud WebDAV URL, your username and your password. This can be done from the command line mode using:
If synchronisation does not work, please consult the logs in the app profile directory - it is often due to a misconfigured URL or password. The log should indicate what the exact issue is.
\n
WebDAV synchronisation
\n
Select the \"WebDAV\" synchronisation target and follow the same instructions as for Nextcloud above (for the terminal application you will need to select sync target 6 rather than 5)
\n
WebDAV-compatible services that are known to work with Joplin:
When syncing with Dropbox, Joplin creates a sub-directory in Dropbox, in /Apps/Joplin and read/write the notes and notebooks from it. The application does not have access to anything outside this directory.
\n
In the desktop application or mobile application, select \"Dropbox\" as the synchronisation target in the Configuration screen (it is selected by default). Then, to initiate the synchronisation process, click on the \"Synchronise\" button in the sidebar and follow the instructions.
\n
In the terminal application, to initiate the synchronisation process, type :sync. You will be asked to follow a link to authorise the application.
\n
OneDrive synchronisation
\n
When syncing with OneDrive, Joplin creates a sub-directory in OneDrive, in /Apps/Joplin and read/write the notes and notebooks from it. The application does not have access to anything outside this directory.
\n
In the desktop application or mobile application, select \"OneDrive\" as the synchronisation target in the Configuration screen. Then, to initiate the synchronisation process, click on the \"Synchronise\" button in the sidebar and follow the instructions.
\n
In the terminal application, to initiate the synchronisation process, type :sync. You will be asked to follow a link to authorise the application (simply input your Microsoft credentials - you do not need to register with OneDrive).
\n
AWS S3 synchronisation
\n
In the desktop application or mobile application, select \"AWS S3 (Beta)\" as the synchronisation target in the Configuration screen.
\n
\n
AWS S3 Bucket: The name of your Bucket, such as joplin-bucket
\n
AWS S3 URL: Fully qualified URL; By default this should be https://s3.amazonaws.com/
\n
AWS key & AWS secret: IAM user's programmatic access key. To create a new key & secret, visit IAM Security Credentials.
\n
\n
While creating a new Bucket for Joplin, disable Bucket Versioning, enable Block all public access and enable Default encryption with Amazon S3 key (SSE-S3).
\n
To add a Bucket Policy from the AWS S3 Web Console, navigate to the Permissions tab. Temporarily disable Block all public access to edit the Bucket policy, something along the lines of:
Joplin supports end-to-end encryption (E2EE) on all the applications. E2EE is a system where only the owner of the notes, notebooks, tags or resources can read them. It prevents potential eavesdroppers - including telecom providers, internet providers, and even the developers of Joplin from being able to access the data. Please see the End-To-End Encryption Tutorial for more information about this feature and how to enable it.
\n
For a more technical description, mostly relevant for development or to review the method being used, please see the Encryption specification.
\n
Note history
\n
The Joplin applications automatically save previous versions of your notes at regular intervals. These versions are synced across devices and can be viewed from the desktop application. To do so, click on the \"Information\" button on a note, then click on \"Previous version of this note\". From this screen you can view the previous versions of the note as well as restore any of them.
\n
This feature can be disabled from the \"Note history\" section in the Configuration screen, and it is also possible to change for how long the history of a note is saved.
Joplin notes can be opened and edited using an external editor of your choice. It can be a simple text editor like Notepad++ or Sublime Text or an actual Markdown editor like Typora. In that case, images will also be displayed within the editor. To open the note in an external editor, click on the icon in the toolbar or press Ctrl+E (or Cmd+E). Your default text editor will be used to open the note. If needed, you can also specify the editor directly in the General Options, under \"Text editor command\".
\n
Attachments
\n
Any kind of file can be attached to a note. In Markdown, links to these files are represented as a simple ID to the attachment, clicking on this link will open the file in the default application. In the case of audio, video and pdf files, these will be displayed inline with the note and so can be viewed or played within Joplin.
\n
In the desktop application, files can be attached either by clicking the \"Attach file\" icon in the editor or via drag and drop. If you prefer to create a link to a local file instead, hold the ALT key while performing the drag and drop operation. You can also copy and paste images directly in the editor via Ctrl+V.
\n
Resources that are not attached to any note will be automatically deleted in accordance to the Note History settings.
\n
Important: Resources larger than 10 MB are not currently supported on mobile. They will crash the application when synchronising so it is recommended not to attach such resources at the moment. The issue is being looked at.
\n
Downloading attachments
\n
The way the attachments are downloaded during synchronisation can be customised in the Configuration screen, under \"Attachment download behaviour\". The default option (\"Always\") is to download all the attachments, all the time, so that the data is available even when the device is offline. There is also the option to download the attachments manually (option \"Manual\"), by clicking on it, or automatically (Option \"Auto\"), in which case the attachments are downloaded only when a note is opened. These options should help saving disk space and network bandwidth, especially on mobile.
\n
Notifications
\n
In the desktop and mobile apps, an alarm can be associated with any to-do. It will be triggered at the given time by displaying a notification. How the notification will be displayed depends on the operating system since each has a different way to handle this. Please see below for the requirements for the desktop applications:
\n
\n
Windows: >= 8. Make sure the Action Center is enabled on Windows. Task bar balloon for Windows < 8. Growl as fallback. Growl takes precedence over Windows balloons.
\n
macOS: >= 10.8 or Growl if earlier.
\n
Linux: notify-send tool, delivered through packages notify-osd, libnotify-bin or libnotify-tools. GNOME should have this by default, but install libnotify-tools if using KDE Plasma.
On mobile, the alarms will be displayed using the built-in notification system.
\n
If for any reason the notifications do not work, please open an issue.
\n
Sub-notebooks
\n
Sub-notebooks allow organising multiple notebooks into a tree of notebooks. For example it can be used to regroup all the notebooks related to work, to family or to a particular project under a parent notebook.
\n
\n
\n
In the desktop application, to create a subnotebook, drag and drop it onto another notebook. To move it back to the root, drag and drop it on the \"Notebooks\" header. Currently only the desktop app can be used to organise the notebooks.
\n
The mobile application supports displaying and collapsing/expanding the tree of notebooks, however it does not currently support moving the subnotebooks to different notebooks.
\n
The terminal app supports displaying the tree of subnotebooks but it does not support collapsing/expanding them or moving the subnotebooks around.
\n
\n
Markdown
\n
Joplin uses and renders a Github-flavoured Markdown with a few variations and additions. In particular it adds math formula support, interactive checkboxes and support for note links. Joplin also supports Markdown plugins which allow enabling and disabling various advanced Markdown features. Have a look at the Markdown Guide for more information.
\n
Custom CSS
\n
Rendered markdown can be customized by placing a userstyle file in the profile directory ~/.config/joplin-desktop/userstyle.css (This path might be different on your device - check at the top of the General page of the Configuration menu for the exact path). This file supports standard CSS syntax. Joplin must be restarted for the new css to be applied, please ensure that Joplin is not closing to the tray, but is actually exiting. Note that this file is used for both displaying the notes and printing the notes. Be aware how the CSS may look printed (for example, printing white text over a black background is usually not wanted).
\n
The whole UI can be customized by placing a custom editor style file in the profile directory ~/.config/joplin-desktop/userchrome.css.
\n
Important: userstyle.css and userchrome.css are provided for your convenience, but they are advanced settings, and styles you define may break from one version to the next. If you want to use them, please know that it might require regular development work from you to keep them working. The Joplin team cannot make a commitment to keep the application HTML structure stable.
\n
Note templates
\n
In the desktop app, templates can be used to create new notes or to insert into existing ones by adding a template file to the templates directory (File > Templates). For example creating the file hours.md in the templates directory with the contents:
\n
Date: {{date}}\nHours:\nDetails:
\n
Templates can then be inserted from the menu (File->Templates).
\n
The currently supported template variables are:
\n
\n\n
\n
Variable
\n
Description
\n
Example
\n
\n\n\n
\n
{{date}}
\n
Today's date formatted based on the settings format
\n
2019-01-01
\n
\n
\n
{{time}}
\n
Current time formatted based on the settings format
\n
13:00
\n
\n
\n
{{datetime}}
\n
Current date and time formatted based on the settings format
\n
01/01/19 1:00 PM
\n
\n
\n
{{#custom_datetime}}
\n
Current date and/or time formatted based on a supplied string (using moment.js formatting)
\n
{{#custom_datetime}}M d{{/custom_datetime}}
\n
\n
\n
{{bowm}}
\n
Date of the beginning of the week (when week starts on Monday) based on the settings format
\n
\n
\n
\n
{{bows}}
\n
Date of the beginning of the week (when week starts on Sunday) based on the settings format
\n
\n
\n\n
\n
Plugins
\n
The desktop app has the ability to extend beyond its standard functionality by the way of plugins. These plugins adhere to the Joplin plugin API and can be installed & configured within the application via the Plugins page in the Configuration screen. This menu allows the manual installation of the plugin using the single 'Joplin Plugin Archive' (*.jpl) file. Once the application is reloaded the plugins will appear within the plugins menu where they can be toggled on/off or removed entirely.
Joplin implements the SQLite Full Text Search (FTS4) extension. It means the content of all the notes is indexed in real time and search queries return results very fast. Both Simple FTS Queries and Full-Text Index Queries are supported. See below for the list of supported queries:
\n
One caveat of SQLite FTS is that it does not support languages which do not use Latin word boundaries (spaces, tabs, punctuation). To solve this issue, Joplin has a custom search mode, that does not use FTS, but still has all of its features (multi term search, filters, etc.). One of its drawbacks is that it can get slow on larger note collections. Also, the sorting of the results will be less accurate, as the ranking algorithm (BM25) is, for now, only implemented for FTS. Finally, in this mode there are no restrictions on using the * wildcard (swim*, *swim and ast*rix all work). This search mode is currently enabled if one of the following languages are detected:
\n
\n
Chinese
\n
Japanese
\n
Korean
\n
Thai
\n
\n
Supported queries
\n
\n\n
\n
Search type
\n
Description
\n
Example
\n
\n\n\n
\n
Single word
\n
Returns all the notes that contain this term.
\n
For example, searching for cat will return all the notes that contain this exact word. Note: it will not return the notes that contain the substring - thus, for \"cat\", notes that contain \"cataclysmic\" or \"prevaricate\" will not be returned.
\n
\n
\n
Multiple word
\n
Returns all the notes that contain all these words, but not necessarily next to each other.
\n
dog cat - will return any notes that contain the words \"dog\" and \"cat\" anywhere in the note, no necessarily in that order nor next to each other. It will not return results that contain \"dog\" or \"cat\" only.
\n
\n
\n
Phrase
\n
Add double quotes to return the notes that contain exactly this phrase.
\n
\"shopping list\" - will return the notes that contain these exact terms next to each other and in this order. It will not return for example a note that contains \"going shopping with my list\".
\n
\n
\n
Prefix
\n
Add a wildcard to return all the notes that contain a term with a specified prefix.
\n
swim* - will return all the notes that contain eg. \"swim\", but also \"swimming\", \"swimsuit\", etc. IMPORTANT: The wildcard can only be at the end - it will be ignored at the beginning of a word (eg. *swim) and will be treated as a literal asterisk in the middle of a word (eg. ast*rix)
\n
\n
\n
Switch to basic search
\n
One drawback of Full Text Search is that it ignores most non-alphabetical characters. However in some cases you might want to search for this too. To do that, you can use basic search. You switch to this mode by prefixing your search with a slash /. This won't provide the benefits of FTS but it will allow searching exactly for what you need. Note that it can also be much slower, even extremely slow, depending on your query.
\n
/\"- [ ]\" - will return all the notes that contain unchecked checkboxes.
\n
\n\n
\n
Search filters
\n
You can also use search filters to further restrict the search.
\n
\n\n
\n
Operator
\n
Description
\n
Example
\n
\n\n\n
\n
-
\n
If placed before a text term, it excludes the notes that contain that term. You can also place it before a filter to negate it.
\n
-spam searches for all notes without the word spam. office -trash searches for all notes with the wordoffice and without the word trash.
\n
\n
\n
any:
\n
Return notes that satisfy any/all of the required conditions. any:0 is the default, which means all conditions must be satisfied.
\n
any:1 cat dog will return notes that have the word cat or dog. any:0 cat dog will return notes with both the words cat and dog.
\n
\n
\n
title: body:
\n
Restrict your search to just the title or the body field.
\n
title:\"hello world\" searches for notes whose title contains hello and world. title:hello -body:world searches for notes whose title contains hello and body does not contain world.
\n
\n
\n
tag:
\n
Restrict the search to the notes with the specified tags.
\n
tag:office searches for all notes having tag office. tag:office tag:important searches for all notes having both office and important tags. tag:office -tag:spam searches for notes having tag office which do not have tag spam. any:1 tag:office tag:spam searches for notes having tag office or tag spam. tag:be*ful does a search with wildcards. tag:* returns all notes with tags. -tag:* returns all notes without tags.
\n
\n
\n
notebook:
\n
Restrict the search to the specified notebook(s).
\n
notebook:books limits the search scope within books and all its subnotebooks. notebook:wheel*time does a wildcard search.
\n
\n
\n
created: updated: due:
\n
Searches for notes created/updated on dates specified using YYYYMMDD format. You can also search relative to the current day, week, month, or year.
\n
created:20201218 will return notes created on or after December 18, 2020. -updated:20201218 will return notes updated before December 18, 2020. created:20200118 -created:20201215 will return notes created between January 18, 2020, and before December 15, 2020. created:202001 -created:202003 will return notes created on or after January and before March 2020. updated:1997 -updated:2020 will return all notes updated between the years 1997 and 2019. created:day-2 searches for all notes created in the past two days. updated:year-0 searches all notes updated in the current year. -due:day+7 will return all todos which are due or will be due in the next seven days. -due:day-5 searches all todos that are overdue for more than 5 days.
\n
\n
\n
type:
\n
Restrict the search to either notes or todos.
\n
type:note to return all notes type:todo to return all todos
\n
\n
\n
iscompleted:
\n
Restrict the search to either completed or uncompleted todos.
\n
iscompleted:1 to return all completed todos iscompleted:0 to return all uncompleted todos
\n
\n
\n
latitude: longitude: altitude:
\n
Filter by location
\n
latitude:40 -latitude:50 to return notes with latitude >= 40 and < 50
\n
\n
\n
resource:
\n
Filter by attachment MIME type
\n
resource:image/jpeg to return notes with a jpeg attachment. -resource:application/pdf to return notes without a pdf attachment. resource:image/* to return notes with any images.
\n
\n
\n
sourceurl:
\n
Filter by source URL
\n
sourceurl:https://www.google.com sourceurl:*joplinapp.org to perform a wildcard search.
\n
\n
\n
id:
\n
Filter by note ID
\n
id:9cbc1b4f242043a9b8a50627508bccd5 return a note with the specified id
\n
\n\n
\n
Note: In the CLI client you have to escape the query using -- when using negated filters.\nEg. :search -- \"-tag:tag1\".
\n
The filters are implicitly connected by and/or connectives depending on the following rules:
\n
\n
By default, all filters are connected by \"AND\".
\n
To override this default behaviour, use the any filter, in which case the search terms will be connected by \"OR\" instead.
\n
There's an exception for the notebook filters which are connected by \"OR\". The reason being that no note can be in multiple notebooks at once.
\n
\n
Incorrect search filters are interpreted as a phrase search, e.g. misspelled nootebook:Example or non-existing https://joplinapp.org.
\n
Search order
\n
Notes are sorted by \"relevance\". Currently it means the notes that contain the requested terms the most times are on top. For queries with multiple terms, it also matters how close to each other the terms are. This is a bit experimental so if you notice a search query that returns unexpected results, please report it in the forum, providing as many details as possible to replicate the issue.
\n
Goto Anything
\n
In the desktop application, press Ctrl+P or Cmd+P and type a note title or part of its content to jump to it. Or type # followed by a tag name, or @ followed by a notebook name.
\n
Privacy
\n
Joplin values your privacy and security by giving you complete control over your information and digital footprint.
\n
Joplin applications do not send any data to any service without your authorisation. Any data that Joplin saves, such as notes or images, are saved to your own device and you are free to delete this data at any time.
\n
Joplin has many modern features, some of which use third-party services. You can disable any or all of these features in the application settings. These features are:
\n
\n\n
\n
Feature
\n
Description
\n
Default
\n
\n\n\n
\n
Auto-update
\n
Joplin periodically connects to GitHub to check for new releases.
\n
Enabled
\n
\n
\n
Geo-location
\n
Joplin saves geo-location information in note properties when you create a note.
\n
Enabled
\n
\n
\n
Synchronisation
\n
Joplin supports synchronisation of your notes across multiple devices. If you choose to synchronise with a third-party, such as OneDrive, the notes will be sent to your OneDrive account, in which case the third-party privacy policy applies.
\n
Disabled
\n
\n\n
\n
Joplin is developed as an open-source application and the source code is freely available online to inspect.
\n
For any question about Joplin privacy, please leave a message on the Joplin Forum.
\n
Donations
\n
Donations to Joplin support the development of the project. Developing quality applications mostly takes time, but there are also some expenses, such as digital certificates to sign the applications, app store fees, hosting, etc. Most of all, your donation will make it possible to keep up the current development standard.
\n
Please see the donation page for information on how to support the development of Joplin.
This is the main place for general discussion about Joplin, user support, software development questions, and to discuss new features. Also where the latest beta versions are released and discussed.
Joplin is currently available in the languages below. If you would like to contribute a new translation, it is quite straightforward, please follow these steps:
In Poedit, open this .pot file, go into the Catalog menu and click Configuration. Change \"Country\" and \"Language\" to your own country and language.
There are many ways to contribute to the project: logging bugs, submitting pull requests, reporting issues, and creating suggestions.
\n
Even if you have push rights on the repository, you should create a personal fork and create feature branches there when you need them. This keeps the main repository clean, and your personal workflow cruft out of sight.
\n
We're also interested in your feedback for the future of this project. You can submit a suggestion or feature request through the issue tracker. To make this process more effective, we're asking that these include more information to help define them more clearly.
There are many ways to contribute to the project: logging bugs, submitting pull requests, reporting issues, and creating suggestions.
\n
Even if you have push rights on the repository, you should create a personal fork and create feature branches there when you need them. This keeps the main repository clean, and your personal workflow cruft out of sight.
\n
We're also interested in your feedback for the future of this project. You can submit a suggestion or feature request through the issue tracker. To make this process more effective, we're asking that these include more information to help define them more clearly.
Kaku is a highly integrated music player that supports different online platforms like YouTube, SoundCloud, Vimeo and more. Available on Windows, Linux and macOS!
\n
Some social media that you should know and follow for the latest news 😆
If you are keen to help Kaku, you can first try to help by translating it into your native language! For more details, please check this post! Can't wait to see you in our community :)
Support us with a monthly donation and help us continue our activities. [Become a backer]
\n
\n
Sponsors
\n
Become a sponsor and get your logo on our README on Github with a link to your site. [Become a sponsor]
\n
\n
License
\n
MIT
\n
",
"readmeOriginal": "
Kaku
\n
\n
Kaku is a highly integrated music player that supports different online platforms like YouTube, SoundCloud, Vimeo and more. Available on Windows, Linux and macOS!
\n
Some social media that you should know and follow for the latest news 😆
If you are keen to help Kaku, you can first try to help by translating it into your native language! For more details, please check this post! Can't wait to see you in our community :)
As yout can see, the image preview software of Mac OS has a terrible experience: it can't be zoomed in with the scroll wheel, and it doesn't support viewing all the pictures in the folder directly... \nSo, I developed this software. \nKankan is a Mac OS software to help you quickly look pictures. The experience is similar to win10's \"image\" and \"king of pictures\" apps.
\n
SCREENSHOT
\n
Day Mode \n\nDark Mode \n
\n
WHAT WE HAVE
\n
1.Fully comply with the Mac OS native design language, and the UI is simple and generous \n2.\"Dark mode\" is supported natively, which can be switched automatically or manually between \"light\" and \"dark\" themes \n3.Enlarge image by wheeling support \n4.Drag image support \n5.Support browsing all images under the folder \n6.Support previous, next and cycle browsing \n7.Support setting wallpaper \n8.Support to copy file name and path \n9.Support for copying images
\n
More content will be added according to user feedback in the future...
\n
SUPPORTED IMAGE FORMATS
\n
\n\n
\n
Suffix
\n
Support
\n
\n\n\n
\n
.jpg
\n
✅
\n
\n
\n
.jpeg
\n
✅
\n
\n
\n
.png
\n
✅
\n
\n
\n
.bmp
\n
✅
\n
\n
\n
.gif
\n
✅
\n
\n
\n
.ico
\n
✅
\n
\n\n
\n
SHORTCUTS
\n
\n\n
\n
Key
\n
Function
\n
\n\n\n
\n
↓,→
\n
Next
\n
\n
\n
↑,←
\n
Previous
\n
\n
\n
Esc
\n
Exit app
\n
\n
\n
Double-click
\n
Original size ↔ Fit to window
\n
\n\n
\n
BUTTON FUNCTIONS
\n
\n\n
\n
Button
\n
Function
\n
\n\n\n
\n
◀
\n
previous
\n
\n
\n
▶
\n
next
\n
\n
\n
↗
\n
Maximize to window size
\n
\n
\n
↙
\n
Minimize to original size
\n
\n
\n
✂
\n
Copy to clipboard
\n
\n
\n
♡
\n
Set as wallpaper (Authorization is required to operate 'Finder')
\n
\n
\n
↺
\n
Rotate picture counter-clockwise
\n
\n
\n
↻
\n
Rotate picture clockwise
\n
\n
\n
◐
\n
Change to the dark theme
\n
\n\n
\n
UPDATE
\n
\n\n
\n
version
\n
time
\n
content
\n
download
\n
\n\n\n
\n
0.2.0
\n
2020.04.03
\n
first version,A small amount bugs
\n
-
\n
\n
\n
0.2.3
\n
2020.04.03
\n
Fix bugs, basically complete functions
\n
-
\n
\n
\n
0.2.4
\n
2020.04.16
\n
New features: 1. Add the magnification display. 2. Add the resolution display. 3. Add new original size function. 4. Modify some menus and button positions
\n
-
\n
\n
\n
0.2.5
\n
2020.05.31
\n
New features: 1.Globalization support,3 languages supported: zh-CN en en-US More work needs yours help and feedback. If you need support from other languages, please give me feedback ! 2.Fix the bug that you can still right-click to open the menu in Hello page.
\n
-
\n
\n
\n
0.3.1
\n
2020.08.09
\n
New features: 1. Add drag and drop support, drag the picture to the window to open it! 2. Fix the problem of scrollbar in Y-axis when browsing large images in version <= mac os 10.14. 3. Fix the bug that the welcome window cannot be moved.
\n
-
\n
\n
\n
*0.4.0
\n
2021.07.02
\n
New feature: clockwise / counter-clockwise rotation of pictures supported
As yout can see, the image preview software of Mac OS has a terrible experience: it can't be zoomed in with the scroll wheel, and it doesn't support viewing all the pictures in the folder directly... \nSo, I developed this software. \nKankan is a Mac OS software to help you quickly look pictures. The experience is similar to win10's \"image\" and \"king of pictures\" apps.
\n
SCREENSHOT
\n
Day Mode \n\nDark Mode \n
\n
WHAT WE HAVE
\n
1.Fully comply with the Mac OS native design language, and the UI is simple and generous \n2.\"Dark mode\" is supported natively, which can be switched automatically or manually between \"light\" and \"dark\" themes \n3.Enlarge image by wheeling support \n4.Drag image support \n5.Support browsing all images under the folder \n6.Support previous, next and cycle browsing \n7.Support setting wallpaper \n8.Support to copy file name and path \n9.Support for copying images
\n
More content will be added according to user feedback in the future...
\n
SUPPORTED IMAGE FORMATS
\n
\n\n
\n
Suffix
\n
Support
\n
\n\n\n
\n
.jpg
\n
✅
\n
\n
\n
.jpeg
\n
✅
\n
\n
\n
.png
\n
✅
\n
\n
\n
.bmp
\n
✅
\n
\n
\n
.gif
\n
✅
\n
\n
\n
.ico
\n
✅
\n
\n\n
\n
SHORTCUTS
\n
\n\n
\n
Key
\n
Function
\n
\n\n\n
\n
↓,→
\n
Next
\n
\n
\n
↑,←
\n
Previous
\n
\n
\n
Esc
\n
Exit app
\n
\n
\n
Double-click
\n
Original size ↔ Fit to window
\n
\n\n
\n
BUTTON FUNCTIONS
\n
\n\n
\n
Button
\n
Function
\n
\n\n\n
\n
◀
\n
previous
\n
\n
\n
▶
\n
next
\n
\n
\n
↗
\n
Maximize to window size
\n
\n
\n
↙
\n
Minimize to original size
\n
\n
\n
✂
\n
Copy to clipboard
\n
\n
\n
♡
\n
Set as wallpaper (Authorization is required to operate 'Finder')
\n
\n
\n
↺
\n
Rotate picture counter-clockwise
\n
\n
\n
↻
\n
Rotate picture clockwise
\n
\n
\n
◐
\n
Change to the dark theme
\n
\n\n
\n
UPDATE
\n
\n\n
\n
version
\n
time
\n
content
\n
download
\n
\n\n\n
\n
0.2.0
\n
2020.04.03
\n
first version,A small amount bugs
\n
-
\n
\n
\n
0.2.3
\n
2020.04.03
\n
Fix bugs, basically complete functions
\n
-
\n
\n
\n
0.2.4
\n
2020.04.16
\n
New features: 1. Add the magnification display. 2. Add the resolution display. 3. Add new original size function. 4. Modify some menus and button positions
\n
-
\n
\n
\n
0.2.5
\n
2020.05.31
\n
New features: 1.Globalization support,3 languages supported: zh-CN en en-US More work needs yours help and feedback. If you need support from other languages, please give me feedback ! 2.Fix the bug that you can still right-click to open the menu in Hello page.
\n
-
\n
\n
\n
0.3.1
\n
2020.08.09
\n
New features: 1. Add drag and drop support, drag the picture to the window to open it! 2. Fix the problem of scrollbar in Y-axis when browsing large images in version <= mac os 10.14. 3. Fix the bug that the welcome window cannot be moved.
\n
-
\n
\n
\n
*0.4.0
\n
2021.07.02
\n
New feature: clockwise / counter-clockwise rotation of pictures supported
Hello. Welcome to the source repo for Kaplan Desktop. It’s been in the works for quite some time and it is exciting to go out and show it to fellow linguists. Please do not hesitate to reach out to contact@kaplan.pro should you have any inquiries.
\n
The documentation for the app itself is available here.
\n
Installation
\n
There are a few options:
\n\n
Microsoft Store
\n
.exe, .deb, and .rpm releases
\n
Building from source (for advanced users)
\n\n
Microsoft Store
\n
The Microsoft Store page for Kaplan Desktop is located here.
NB: Ubuntu users may experience a bug where they cannot run the .deb file, unless they save it in a directory other than the default download directory.
\n
Building from source
\n
This is by far the most efficient method and the steps are more or less the same for all operating systems.
\n\n
\n
Install Python 3, if it’s not installed on your computer.
\n
\n
\n
Get the source code from the repo.
\n
\n
\n
Navigate to /backend/ and create a Python 3 virtual environment.
\n
\n
\n
Activate the virtual environment.
\n
\n
\n
Update pip and install the required Python libraries:
Hello. Welcome to the source repo for Kaplan Desktop. It’s been in the works for quite some time and it is exciting to go out and show it to fellow linguists. Please do not hesitate to reach out to contact@kaplan.pro should you have any inquiries.
\n
The documentation for the app itself is available here.
\n
Installation
\n
There are a few options:
\n\n
Microsoft Store
\n
.exe, .deb, and .rpm releases
\n
Building from source (for advanced users)
\n\n
Microsoft Store
\n
The Microsoft Store page for Kaplan Desktop is located here.
NB: Ubuntu users may experience a bug where they cannot run the .deb file, unless they save it in a directory other than the default download directory.
\n
Building from source
\n
This is by far the most efficient method and the steps are more or less the same for all operating systems.
\n\n
\n
Install Python 3, if it’s not installed on your computer.
\n
\n
\n
Get the source code from the repo.
\n
\n
\n
Navigate to /backend/ and create a Python 3 virtual environment.
\n
\n
\n
Activate the virtual environment.
\n
\n
\n
Update pip and install the required Python libraries:
Free cross-platform password manager compatible with KeePass
\n
This webapp is a browser and desktop password manager compatible with KeePass databases. It doesn't require any server or additional resources.\nThe app can run either in browser, or as a desktop app.
The app is quite stable now. Basic stuff, as well as more advanced operations, should be rather reliable.
\n
Self-hosting
\n
Everything you need to host this app on your server is any static file server. The app is a single HTML file + a service worker (optionally; for offline access).\nYou can download the latest distribution files from gh-pages branch.
\n
If you are using Docker:
\n\n
put your dh.pem, cert.pem, key.pem to /etc/nginx/external/
The app can be built with grunt: grunt (html files will be in dist/). \nDesktop apps are built with grunt desktop. This requires some magic and currently works only on CI,\nyou can find more details in the GitHub Actions workflow.
\n
To run the desktop (electron) app without building an installer, build the app with grunt and start it this way:
\n
npm run dev\nnpm run electron
\n
For debug build:
\n\n
run npm run dev
\n
open http://localhost:8085
\n\n
To build desktop apps, use these goals, the result can be found in tmp:
\n
npm run dev-desktop-macos\nnpm run dev-desktop-windows\nnpm run dev-desktop-linux\n
Other ways of contribution can be found on this page.
\n
Important notes for pull requests
\n
\n
please branch from develop, not master
\n
don't edit translation files except base.json, they will be replaced
\n
\n
Donations
\n
KeeWeb is not free to develop. It takes time, requires paid code signing certificates and domains. \nYou can help the project or say \"thank you\" with this button: \n
\n
You can also sponsor the developer directly on GitHub.
\n
Please note: donation does not imply any type of service contract.
Free cross-platform password manager compatible with KeePass
\n
This webapp is a browser and desktop password manager compatible with KeePass databases. It doesn't require any server or additional resources.\nThe app can run either in browser, or as a desktop app.
The app is quite stable now. Basic stuff, as well as more advanced operations, should be rather reliable.
\n
Self-hosting
\n
Everything you need to host this app on your server is any static file server. The app is a single HTML file + a service worker (optionally; for offline access).\nYou can download the latest distribution files from gh-pages branch.
\n
If you are using Docker:
\n\n
put your dh.pem, cert.pem, key.pem to /etc/nginx/external/
The app can be built with grunt: grunt (html files will be in dist/). \nDesktop apps are built with grunt desktop. This requires some magic and currently works only on CI,\nyou can find more details in the GitHub Actions workflow.
\n
To run the desktop (electron) app without building an installer, build the app with grunt and start it this way:
\n
npm run dev\nnpm run electron
\n
For debug build:
\n\n
run npm run dev
\n
open http://localhost:8085
\n\n
To build desktop apps, use these goals, the result can be found in tmp:
\n
npm run dev-desktop-macos\nnpm run dev-desktop-windows\nnpm run dev-desktop-linux\n
Other ways of contribution can be found on this page.
\n
Important notes for pull requests
\n
\n
please branch from develop, not master
\n
don't edit translation files except base.json, they will be replaced
\n
\n
Donations
\n
KeeWeb is not free to develop. It takes time, requires paid code signing certificates and domains. \nYou can help the project or say \"thank you\" with this button: \n
\n
You can also sponsor the developer directly on GitHub.
\n
Please note: donation does not imply any type of service contract.
An app to organize, learn, and practice keyboard shortcuts!
\n
\n \n
This repository serves as a public bug and request tracker, and as a Wiki for advanced users.
\n
If you encountered a bug or have a feature request, please create create an issue. If you have a general question, you can contact us via mail or use GitHub Discussions.
An app to organize, learn, and practice keyboard shortcuts!
\n
\n \n
This repository serves as a public bug and request tracker, and as a Wiki for advanced users.
\n
If you encountered a bug or have a feature request, please create create an issue. If you have a general question, you can contact us via mail or use GitHub Discussions.
Education and innovation is a sample project for users of the Kinesis CI tool for Tableau.\nKinesis CI is a test framework that adds automated testing and continuous integration capability to Tableau Server.\nFor more information on Kinesis CI, please visit http://kinesis-ci.com
\n
\n
Concept
\n
This project is designed to give you an example for setting up your testing projects in Kinesis CI.
\n
It contains a collection of test cases for a Tableau Workbook – Education and Innovation,\nincluding the following test cases:
\n
Functional Testing
\n
\n
Load data into a database
\n
Publish Tableau workbooks and data sources to Tableau Server
\n
Refresh data extracts
\n
Filters
\n
Parameters
\n
Checking data against an expected data set
\n
Checking the layout of the Dashboard to an expected layout
\n
Checking data against pre-defined rules and criterias
\n
Checking data against the datasource by an SQL query in the underlying database
\n
Running custom webdriver commands (required for SSO and custom login pages)
\n
Switch Tab
\n
Selecting Marks for testing interactivity/ user clicks
\n
\n
Regression Testing
\n
\n
Running regression test on a Tableau dashboard to compare against a baseline in terms of data, layout, filter and parameter consitency
\n
\n
Cross Environment Testing
\n
\n
Comparing the same Tableau View on two different environments i.e. dev and prod or two different Tableau Server versions, when doing and upgrade, in terms of data, layout, filter and parameter consitency
\n
\n
Performance Testing
\n
\n
Testing the performance of your Tableau Server by driving load against it
Clone the repository in Kinesis Designer (File -> Clone Git Repository and enter https://github.com/Kinesis-CI/education-and-innovation.git) and open project.json. This project.json file contains key\ninformation to identify the individual test projects within this directory.\nAlternatively, you can use the Kinesis Command Line Interface and open the files in a text editor.
\n
\n
\n
Edit context variables to fit your environment. i.e. reference the Tableau Server you are using within your organization and use a database you have access to. For more information on context variables visit\nhttps://kinesis-ci.com/documents/#/context-variables
In Cross Environment test, update the target environment to fit your target environment you want to compare to your source environment. For more information on Cross Environment tests visit https://kinesis-ci.com/documents/#/cross-environment-test
\n
\n\n
Directory layout
\n
\n\n
\n
File Type
\n
Description
\n
\n\n\n
\n
src
\n
Contains the Tableau source files that have been imported into the given Project
Contains files related to the individual Tests that have been created within the Project
\n
\n
\n
test/<TEST_NAME>/resources
\n
Test resources. These are typically data files (.csv) needed to load data into source systems (i.e. databases) or validate data to expected results
\n
\n
\n
test/<TEST_NAME>/kinesis.json
\n
JSON files that describe the individual Test steps that have been created within the Project
\n
\n
\n
project.json
\n
JSON file that contains the key information to identify the individual Projects. This is only needed for Kinesis Designer, but not to run tests from the Command Line Interface
If you want to run tests automatically on a Continuous Integration Server, for example on Jenkins, TeamCity or any other similar tool, then you will need to install the Kinesis Command Line Interface to the server where your CI/CD server is running.
\n
Command Line Interface allows you to run previously created Kinesis tests and integrate it with the CI tool of your choice.
Education and innovation is a sample project for users of the Kinesis CI tool for Tableau.\nKinesis CI is a test framework that adds automated testing and continuous integration capability to Tableau Server.\nFor more information on Kinesis CI, please visit http://kinesis-ci.com
\n
\n
Concept
\n
This project is designed to give you an example for setting up your testing projects in Kinesis CI.
\n
It contains a collection of test cases for a Tableau Workbook – Education and Innovation,\nincluding the following test cases:
\n
Functional Testing
\n
\n
Load data into a database
\n
Publish Tableau workbooks and data sources to Tableau Server
\n
Refresh data extracts
\n
Filters
\n
Parameters
\n
Checking data against an expected data set
\n
Checking the layout of the Dashboard to an expected layout
\n
Checking data against pre-defined rules and criterias
\n
Checking data against the datasource by an SQL query in the underlying database
\n
Running custom webdriver commands (required for SSO and custom login pages)
\n
Switch Tab
\n
Selecting Marks for testing interactivity/ user clicks
\n
\n
Regression Testing
\n
\n
Running regression test on a Tableau dashboard to compare against a baseline in terms of data, layout, filter and parameter consitency
\n
\n
Cross Environment Testing
\n
\n
Comparing the same Tableau View on two different environments i.e. dev and prod or two different Tableau Server versions, when doing and upgrade, in terms of data, layout, filter and parameter consitency
\n
\n
Performance Testing
\n
\n
Testing the performance of your Tableau Server by driving load against it
Clone the repository in Kinesis Designer (File -> Clone Git Repository and enter https://github.com/Kinesis-CI/education-and-innovation.git) and open project.json. This project.json file contains key\ninformation to identify the individual test projects within this directory.\nAlternatively, you can use the Kinesis Command Line Interface and open the files in a text editor.
\n
\n
\n
Edit context variables to fit your environment. i.e. reference the Tableau Server you are using within your organization and use a database you have access to. For more information on context variables visit\nhttps://kinesis-ci.com/documents/#/context-variables
In Cross Environment test, update the target environment to fit your target environment you want to compare to your source environment. For more information on Cross Environment tests visit https://kinesis-ci.com/documents/#/cross-environment-test
\n
\n\n
Directory layout
\n
\n\n
\n
File Type
\n
Description
\n
\n\n\n
\n
src
\n
Contains the Tableau source files that have been imported into the given Project
Contains files related to the individual Tests that have been created within the Project
\n
\n
\n
test/<TEST_NAME>/resources
\n
Test resources. These are typically data files (.csv) needed to load data into source systems (i.e. databases) or validate data to expected results
\n
\n
\n
test/<TEST_NAME>/kinesis.json
\n
JSON files that describe the individual Test steps that have been created within the Project
\n
\n
\n
project.json
\n
JSON file that contains the key information to identify the individual Projects. This is only needed for Kinesis Designer, but not to run tests from the Command Line Interface
If you want to run tests automatically on a Continuous Integration Server, for example on Jenkins, TeamCity or any other similar tool, then you will need to install the Kinesis Command Line Interface to the server where your CI/CD server is running.
\n
Command Line Interface allows you to run previously created Kinesis tests and integrate it with the CI tool of your choice.
# For development,\n# Start development server with Webpack\nyarn run dev:one\n# Start Electron\nyarn run dev:two\n\n# For production,\n# Build files with Webpack\nyarn run prod\n# Make executable\nyarn run pack
# For development,\n# Start development server with Webpack\nyarn run dev:one\n# Start Electron\nyarn run dev:two\n\n# For production,\n# Build files with Webpack\nyarn run prod\n# Make executable\nyarn run pack
Before you start forwarding internal resources to your local machine, you have to add cluster configuration.\nTo do this we have 3 different options in the app:
\n\n
Auto-detection of ~/.kube/config file and parsing settings from it
\n
Manual adding of Kubernetes config by selecting a file(s)
\n
Manual adding of Kubernetes config by pasting a text
\n
Import of the JSON file that could be generated via Kube Forwarder export functionality
\n\n
When you add a new cluster via auto-detection (option 1) or manually using a file(a) selection (option 2), we could parse\nconfigs and if there are multiple contexts inside we will suggest you to add multiple clusters to the app.\nFew examples of yaml files we expect to have you could find there
\n
Also, you could add a cluster by filling a form manually (option 3). The form has the following fields:
\n
\n
\n
Name - the name of a cluster withing Kube Forwarder app.
\n
\n
\n
Storing method (Set destination to your kube config or paste it as a text) - the method of storing a config It has two options:
\n
\n
Set a path - storing a path to the config file. It will be read every time when you forwarding a port. It allows\na user to don't do any changes in Kube Forwarder's settings when a third-party app updates the config file.\nFor example, when azure-cli updates an access token (#13).
\n
Paste as a text - storing a config just as a yml text.
\n
\n
\n
\n
Path (if storing method is Set a path) - the path to a config file.
\n
\n
\n
Content (if storing method is Paste as a text) - Yml config as a text.
\n
\n
\n
Current Context (if storing method is Set a path) - When you use Set a path, you must select a context from a file\nwhich will be used to connect to a resource. Let's see an example of a problem that the field solves.
\n\n
Let's say we don't have Current context field.
\n
A user has a config file with two contexts: local-cluster and remote-cluster.\ncurrent-context in the yml file is local-cluster.
\n
The user configured a cluster in Kube Forwarder with Set a path option.
\n
The user created a resource postgres and successfully forwarded ports for some time.
\n
Then the user executed kubectl config use-context remote-cluster
\n
If the user tries to forward the resource in Kube Forwarder again, most likely there will be an error\nsince a connection will be established with remote-cluster, not local-cluster as the user expected,\nand remote-cluster couldn't have postgres resource.
\n\n
So, to avoid the error we should store the current context in a separate field.
\n
\n
\n
\n
Add a resource
\n
Kube Forwarder supports forwarding of all types of resources that supported by kubectl – Pod, Deployment, Service.
\n
We ask you to fill the form with the following fields:
\n
Cluster Name - pick a cluster from one of the added clusters.
\n
Namespace - the namespace of the resource you plan to forward.
\n
Kind – pick one of the options Pod, Deployment or Service.
\n
Name - name of the Pod, Deployment or Service.
\n
Alias - alternative name of the resource that will be displayed on the homepage(optional)
\n
Port Forwarding
\n
\n
Local port - port from your local machine where the resource will be forwarded. Note that ports <= 1024 are\nrestricted to user root
\n
Resource port - port of the resource from the Kubernetes cluster
\n
\n
Use Custom Local Address - Check this and put an IP address or hostname into the text field to\nuse a different listen address. Putting each service on its own address avoids sharing/collisions between\nservices on cookies and port number. Specify a loopback address like 127.0.x.x or add entries to your\nhosts file like 127.0.1.1 dashboard.production.kbf and put the assigned name in this column. If blank or\nunchecked, localhost / 127.0.0.1 will be used.
\n
\n
Import/Export
\n
Kube Forwarder allows you export cluster configuration in JSON that you could use to share with your team members or for the backup purpose. You could easily store it on Github. When you export cluster, you could export it with or without confidential information.
\n
\n
Install with Homebrew
\n
brew cask install kube-forwarder\n
\n
Contributing
\n
We encourage you to contribute to Kube Forwarder!
\n
We expect contributors to abide by our underlying code of conduct.\nAll conversations and discussions on GitHub (issues, pull requests)\nmust be respectful and harassment-free.
\n
This project was generated with electron-vue@8fae476 using vue-cli. Documentation about the original structure can be found here.
\n
How to contribute
\n\n
Fork the project & clone locally. Follow the initial setup here.
\n
Create a branch, naming it either a feature or bug: git checkout -b feature/that-new-feature or bug/fixing-that-bug
\n
Code and commit your changes. Bonus points if you write a good commit message: git commit -m 'Add some feature'
\n
Push to the branch: git push origin feature/that-new-feature
/kube-forwarder\n\n# install dependencies\nnpm install\n\n# prepare .env files\ncp .env.example .env\ncp .env.example .env.production\n\n# serve with hot reload in Electron Dev app\nnpm run dev\n\n# serve WEB version with hot reload at localhost:9081\nnpm run web\n\">
# Clone source code\ngit clone https://github.com/<your-username>/kube-forwarder\n\n# install dependencies\nnpm install\n\n# prepare .env files\ncp .env.example .env\ncp .env.example .env.production\n\n# serve with hot reload in Electron Dev app\nnpm run dev\n\n# serve WEB version with hot reload at localhost:9081\nnpm run web\n
\n
Build
\n
Build an application for production
\n
# Build a target for current OS\nnpm run build\n\n# Build a target for Windows\nnpm run build -- -- --win\n\n# Build a target for Linux\nnpm run build -- -- --linux\n\n# You can mix targets\nnpm run build -- -- --win --linux\n\n# You can build static and target separately\nnpm run build:dist\nnpm run build:target -- --win\n
\n
A built version will be appear in build directory.
\n
Running the tests
\n
We are using Cypress to run integration tests.\nThere are visual regression tests. It's important to run them inside docker\ncontainer to get same screenshots as in Drone CI.
\n
npm run test:cypress\n
\n
Or you can run it manually on a local machine.
\n
# Run the web version to test it\nnpm run web\n\n# Run this command in a separate terminal tab\nnpm run test:cypress:onhost\n\n# Or you can open Cypress GUI\nnpm run test:cypress:open\n
\n
Troubleshooting
\n
Q) Node Sass could not find a binding for your current environment: OS X 64-bit with Node.js 12.x\nA) npm rebuild node-sass
Before you start forwarding internal resources to your local machine, you have to add cluster configuration.\nTo do this we have 3 different options in the app:
\n\n
Auto-detection of ~/.kube/config file and parsing settings from it
\n
Manual adding of Kubernetes config by selecting a file(s)
\n
Manual adding of Kubernetes config by pasting a text
\n
Import of the JSON file that could be generated via Kube Forwarder export functionality
\n\n
When you add a new cluster via auto-detection (option 1) or manually using a file(a) selection (option 2), we could parse\nconfigs and if there are multiple contexts inside we will suggest you to add multiple clusters to the app.\nFew examples of yaml files we expect to have you could find there
\n
Also, you could add a cluster by filling a form manually (option 3). The form has the following fields:
\n
\n
\n
Name - the name of a cluster withing Kube Forwarder app.
\n
\n
\n
Storing method (Set destination to your kube config or paste it as a text) - the method of storing a config It has two options:
\n
\n
Set a path - storing a path to the config file. It will be read every time when you forwarding a port. It allows\na user to don't do any changes in Kube Forwarder's settings when a third-party app updates the config file.\nFor example, when azure-cli updates an access token (#13).
\n
Paste as a text - storing a config just as a yml text.
\n
\n
\n
\n
Path (if storing method is Set a path) - the path to a config file.
\n
\n
\n
Content (if storing method is Paste as a text) - Yml config as a text.
\n
\n
\n
Current Context (if storing method is Set a path) - When you use Set a path, you must select a context from a file\nwhich will be used to connect to a resource. Let's see an example of a problem that the field solves.
\n\n
Let's say we don't have Current context field.
\n
A user has a config file with two contexts: local-cluster and remote-cluster.\ncurrent-context in the yml file is local-cluster.
\n
The user configured a cluster in Kube Forwarder with Set a path option.
\n
The user created a resource postgres and successfully forwarded ports for some time.
\n
Then the user executed kubectl config use-context remote-cluster
\n
If the user tries to forward the resource in Kube Forwarder again, most likely there will be an error\nsince a connection will be established with remote-cluster, not local-cluster as the user expected,\nand remote-cluster couldn't have postgres resource.
\n\n
So, to avoid the error we should store the current context in a separate field.
\n
\n
\n
\n
Add a resource
\n
Kube Forwarder supports forwarding of all types of resources that supported by kubectl – Pod, Deployment, Service.
\n
We ask you to fill the form with the following fields:
\n
Cluster Name - pick a cluster from one of the added clusters.
\n
Namespace - the namespace of the resource you plan to forward.
\n
Kind – pick one of the options Pod, Deployment or Service.
\n
Name - name of the Pod, Deployment or Service.
\n
Alias - alternative name of the resource that will be displayed on the homepage(optional)
\n
Port Forwarding
\n
\n
Local port - port from your local machine where the resource will be forwarded. Note that ports <= 1024 are\nrestricted to user root
\n
Resource port - port of the resource from the Kubernetes cluster
\n
\n
Use Custom Local Address - Check this and put an IP address or hostname into the text field to\nuse a different listen address. Putting each service on its own address avoids sharing/collisions between\nservices on cookies and port number. Specify a loopback address like 127.0.x.x or add entries to your\nhosts file like 127.0.1.1 dashboard.production.kbf and put the assigned name in this column. If blank or\nunchecked, localhost / 127.0.0.1 will be used.
\n
\n
Import/Export
\n
Kube Forwarder allows you export cluster configuration in JSON that you could use to share with your team members or for the backup purpose. You could easily store it on Github. When you export cluster, you could export it with or without confidential information.
\n
\n
Install with Homebrew
\n
brew cask install kube-forwarder\n
\n
Contributing
\n
We encourage you to contribute to Kube Forwarder!
\n
We expect contributors to abide by our underlying code of conduct.\nAll conversations and discussions on GitHub (issues, pull requests)\nmust be respectful and harassment-free.
\n
This project was generated with electron-vue@8fae476 using vue-cli. Documentation about the original structure can be found here.
\n
How to contribute
\n\n
Fork the project & clone locally. Follow the initial setup here.
\n
Create a branch, naming it either a feature or bug: git checkout -b feature/that-new-feature or bug/fixing-that-bug
\n
Code and commit your changes. Bonus points if you write a good commit message: git commit -m 'Add some feature'
\n
Push to the branch: git push origin feature/that-new-feature
# Clone source code\ngit clone https://github.com/<your-username>/kube-forwarder\n\n# install dependencies\nnpm install\n\n# prepare .env files\ncp .env.example .env\ncp .env.example .env.production\n\n# serve with hot reload in Electron Dev app\nnpm run dev\n\n# serve WEB version with hot reload at localhost:9081\nnpm run web\n
\n
Build
\n
Build an application for production
\n
# Build a target for current OS\nnpm run build\n\n# Build a target for Windows\nnpm run build -- -- --win\n\n# Build a target for Linux\nnpm run build -- -- --linux\n\n# You can mix targets\nnpm run build -- -- --win --linux\n\n# You can build static and target separately\nnpm run build:dist\nnpm run build:target -- --win\n
\n
A built version will be appear in build directory.
\n
Running the tests
\n
We are using Cypress to run integration tests.\nThere are visual regression tests. It's important to run them inside docker\ncontainer to get same screenshots as in Drone CI.
\n
npm run test:cypress\n
\n
Or you can run it manually on a local machine.
\n
# Run the web version to test it\nnpm run web\n\n# Run this command in a separate terminal tab\nnpm run test:cypress:onhost\n\n# Or you can open Cypress GUI\nnpm run test:cypress:open\n
\n
Troubleshooting
\n
Q) Node Sass could not find a binding for your current environment: OS X 64-bit with Node.js 12.x\nA) npm rebuild node-sass
Knowte is a note taking application that allows you to quickly and easily organize and find your notes. This version is written using Electron, Angular and Typescript. The original Knowte (for Windows), which is written in WPF and C#, remains available here.
\n
\n\n
\n
\n
\n
Screenshot
\n
\n
Build prerequisites
\n
\n
wine: required to build Windows package
\n
rpm: required to build rpm package
\n
libarchive-tools: contains bsdtar, which is required to build pacman package.
\n
\n
To install the prerequisites on Ubuntu:
\n
sudo apt install wine rpm libarchive-tools
\n
To install the prerequisites on Manjaro:
\n
sudo pacman -S wine rpm-tools
\n
Build instructions
\n
$ git clone https://github.com/digimezzo/knowte.git\n$ cd knowte\n$ npm install # Download dependencies\n$ npm start # Start Knowte\n$ npm run electron:windows # Build for Windows\n$ npm run electron:linux # Build for Linux\n$ npm run electron:mac # Build for Mac
\n
Pacman installation notes
\n
The pacman package contains a dependency to package libappindicator-sharp, which is no longer distributed with Arch Linux. I cannot remove this dependency for now, because it is an issue in electron-builder (the packaging tool which is used in this project). It is, however, possible to install Knowte on Arch Linux or Manjaro using this command (replace x.y.z with the correct version number):
Knowte is a note taking application that allows you to quickly and easily organize and find your notes. This version is written using Electron, Angular and Typescript. The original Knowte (for Windows), which is written in WPF and C#, remains available here.
\n
\n\n
\n
\n
\n
Screenshot
\n
\n
Build prerequisites
\n
\n
wine: required to build Windows package
\n
rpm: required to build rpm package
\n
libarchive-tools: contains bsdtar, which is required to build pacman package.
\n
\n
To install the prerequisites on Ubuntu:
\n
sudo apt install wine rpm libarchive-tools
\n
To install the prerequisites on Manjaro:
\n
sudo pacman -S wine rpm-tools
\n
Build instructions
\n
$ git clone https://github.com/digimezzo/knowte.git\n$ cd knowte\n$ npm install # Download dependencies\n$ npm start # Start Knowte\n$ npm run electron:windows # Build for Windows\n$ npm run electron:linux # Build for Linux\n$ npm run electron:mac # Build for Mac
\n
Pacman installation notes
\n
The pacman package contains a dependency to package libappindicator-sharp, which is no longer distributed with Arch Linux. I cannot remove this dependency for now, because it is an issue in electron-builder (the packaging tool which is used in this project). It is, however, possible to install Knowte on Arch Linux or Manjaro using this command (replace x.y.z with the correct version number):
# For development,\n# Start development server with Webpack\nyarn run dev:one\n# Start Electron\nyarn run dev:two\n\n# For production,\n# Build files with Webpack\nyarn run prod\n# Make executable\nyarn run pack
# For development,\n# Start development server with Webpack\nyarn run dev:one\n# Start Electron\nyarn run dev:two\n\n# For production,\n# Build files with Webpack\nyarn run prod\n# Make executable\nyarn run pack
First UI automation testing tool design for all team members.
\n
\n\n
\n
last-hit-quick-start
\n
Last-hit is an automation testing solution aimed at development and operations teams.\nIt is focused on web test, gives you broad, deep and exact control over your web apps automation testing
\n
A quick guide to set up and start your first automation test with last-hit, a free test automation tool built on top of electron and puppeteer. You now can begin automation testing on web & mobile with the least amount of effort. Free download at site.
Not supported yet. You can clone source code repo and package by yourself. We use Electron Builder.
\n
Install from source code
\n
To clone and run this repository you'll need Git and Node.js (which comes with npm) installed on your computer. From your command line:
\n
# Clone this repository\ngit clone https://github.com/last-hit-aab/last-hit.git\n# Install dependencies\nnpm install\n# Go into the repository\ncd last-hit\n# Install dependencies\nnpm install\n# Go into the render folder\ncd render\n# Install dependencies\nnpm install\n# Back to the root directory of the repository\ncd ../\n# Run the app\nnpm run start
\n
\n
Note: If you want to use the Installation package, \nPlease download Release Package,
First UI automation testing tool design for all team members.
\n
\n\n
\n
last-hit-quick-start
\n
Last-hit is an automation testing solution aimed at development and operations teams.\nIt is focused on web test, gives you broad, deep and exact control over your web apps automation testing
\n
A quick guide to set up and start your first automation test with last-hit, a free test automation tool built on top of electron and puppeteer. You now can begin automation testing on web & mobile with the least amount of effort. Free download at site.
Not supported yet. You can clone source code repo and package by yourself. We use Electron Builder.
\n
Install from source code
\n
To clone and run this repository you'll need Git and Node.js (which comes with npm) installed on your computer. From your command line:
\n
# Clone this repository\ngit clone https://github.com/last-hit-aab/last-hit.git\n# Install dependencies\nnpm install\n# Go into the repository\ncd last-hit\n# Install dependencies\nnpm install\n# Go into the render folder\ncd render\n# Install dependencies\nnpm install\n# Back to the root directory of the repository\ncd ../\n# Run the app\nnpm run start
\n
\n
Note: If you want to use the Installation package, \nPlease download Release Package,
This repo contains the UI code that powers the official LBRY desktop app, as well as lbry.tv. The LBRY app is a graphical browser for the decentralized content marketplace provided by the\nLBRY protocol. It is essentially the\nlbry daemon bundled with a UI using\nElectron.
We provide installers for Windows, macOS (v10.12.4, Sierra, or greater), and Debian-based Linux. See community maintained builds section for alternative Linux installations.
Our releases page also contains the latest\nrelease, pre-releases, and past builds.\nNote: If the deb fails to install using the Ubuntu Software Center, install manually via sudo dpkg -i <path to deb>. You'll need to run sudo apt-get install -f if this is the first time installing it to install dependencies
\n
To install from source or make changes to the application, continue to the next section below.
\n
Community maintained builds for Arch Linux and Flatpak are available, see below. These installs will need to be updated manually as the in-app update process only supports Debian installs at this time.\nNote: If coming from a deb install, the directory structure is different and you'll need to migrate data.
Clone (or fork) this repository: git clone https://github.com/lbryio/lbry-desktop
\n
Change directory into the cloned repository: cd lbry-desktop
\n
Install the dependencies: yarn
\n\n
Run the electron app
\n
yarn dev
\n
\n
If you want to build and launch the production app you can run yarn build. This will give you an executable inside the /dist folder. We use electron-builder to create distributable packages.
\n
\n
Run the web app for development
\n
yarn dev:web
\n
\n
This uses webpack-dev-server and includes hot-reloading. If you want to debug the web server we use in production you can run yarn dev:web-server. This starts a server at localhost:1337 and does not include hot reloading.
\n
\n
Customize the web app
\n
\n
In root directory, duplicate the .env.default file and rename it to .env then copy the code below and paste it anywhere in the .env file.
\n
\n
cp .env.defaults .env\nnano .env\n
\n
\n
\n
To specify your own OG-IMAGE\nYou can either place a png named v2-og.png in the /custom folder or specify the OG_IMAGE_URL in .env
\n
\n
\n
To specify your own channels to be followed on first run\nAUTO_FOLLOW_URLS=lbry://@chan#123...a lbry://@chan2#456...a
\n
\n
\n
If you want to customize the homepage content
\n
\n
\n\n
add CUSTOM_HOMEPAGE=true to the '.env' file
\n
copy /custom/homepage.example.js to /custom/homepage.js and make desired changes to homepage.js
Finally NODE_ENV=production yarn compile:web to rebuild\nNote: You don't need to edit the .env file in the /web folder - that is copied during compile.
\n
\n
Deploy the web app (experimental)
\n\n
Create a server with a domain name and a reverse proxy https to port 1337.
\n
Install pm2, node v10, yarn
\n
Clone this repo
\n
Make any customizations as above
\n
Run yarn to install
\n
Run NODE_ENV=production yarn compile:web to build
\n
Set up pm2 to start ./web/index.js
\n\n
Run both at the same time
\n
Run the two commands above in separate terminal windows
\n
yarn dev\n\n// in another terminal window\nyarn dev:web\n
\n
Resetting your Packages
\n
If the app isn't building, or yarn xxx commands aren't working you may need to just reset your node_modules. To do so you can run: rm -r node_modules && yarn or del /s /q node_modules && yarn on Windows.
\n
If you really think something might have gone wrong, you can force your repo to clear everything that doesn't match the repo with git reset --hard HEAD && git clean -fxd && git pull -r
\n
Contributing
\n
We ❤️ contributions from everyone and contributions to this project are encouraged, and compensated. We welcome bug reports, bug fixes and feedback is always appreciated. For more details, see CONTRIBUTING.md.
\n
\n
License
\n
This project is MIT licensed. For the full license, see LICENSE.
\n
Security
\n
We take security seriously. Please contact security@lbry.com regarding any security issues. Our PGP key is here if you need it. Previous versions up to v0.50.2 were signed by Sean Yesmunt.\nNew Releases are signed by Jessop Breth.
This repo contains the UI code that powers the official LBRY desktop app, as well as lbry.tv. The LBRY app is a graphical browser for the decentralized content marketplace provided by the\nLBRY protocol. It is essentially the\nlbry daemon bundled with a UI using\nElectron.
We provide installers for Windows, macOS (v10.12.4, Sierra, or greater), and Debian-based Linux. See community maintained builds section for alternative Linux installations.
Our releases page also contains the latest\nrelease, pre-releases, and past builds.\nNote: If the deb fails to install using the Ubuntu Software Center, install manually via sudo dpkg -i <path to deb>. You'll need to run sudo apt-get install -f if this is the first time installing it to install dependencies
\n
To install from source or make changes to the application, continue to the next section below.
\n
Community maintained builds for Arch Linux and Flatpak are available, see below. These installs will need to be updated manually as the in-app update process only supports Debian installs at this time.\nNote: If coming from a deb install, the directory structure is different and you'll need to migrate data.
Clone (or fork) this repository: git clone https://github.com/lbryio/lbry-desktop
\n
Change directory into the cloned repository: cd lbry-desktop
\n
Install the dependencies: yarn
\n\n
Run the electron app
\n
yarn dev
\n
\n
If you want to build and launch the production app you can run yarn build. This will give you an executable inside the /dist folder. We use electron-builder to create distributable packages.
\n
\n
Run the web app for development
\n
yarn dev:web
\n
\n
This uses webpack-dev-server and includes hot-reloading. If you want to debug the web server we use in production you can run yarn dev:web-server. This starts a server at localhost:1337 and does not include hot reloading.
\n
\n
Customize the web app
\n
\n
In root directory, duplicate the .env.default file and rename it to .env then copy the code below and paste it anywhere in the .env file.
\n
\n
cp .env.defaults .env\nnano .env\n
\n
\n
\n
To specify your own OG-IMAGE\nYou can either place a png named v2-og.png in the /custom folder or specify the OG_IMAGE_URL in .env
\n
\n
\n
To specify your own channels to be followed on first run\nAUTO_FOLLOW_URLS=lbry://@chan#123...a lbry://@chan2#456...a
\n
\n
\n
If you want to customize the homepage content
\n
\n
\n\n
add CUSTOM_HOMEPAGE=true to the '.env' file
\n
copy /custom/homepage.example.js to /custom/homepage.js and make desired changes to homepage.js
Finally NODE_ENV=production yarn compile:web to rebuild\nNote: You don't need to edit the .env file in the /web folder - that is copied during compile.
\n
\n
Deploy the web app (experimental)
\n\n
Create a server with a domain name and a reverse proxy https to port 1337.
\n
Install pm2, node v10, yarn
\n
Clone this repo
\n
Make any customizations as above
\n
Run yarn to install
\n
Run NODE_ENV=production yarn compile:web to build
\n
Set up pm2 to start ./web/index.js
\n\n
Run both at the same time
\n
Run the two commands above in separate terminal windows
\n
yarn dev\n\n// in another terminal window\nyarn dev:web\n
\n
Resetting your Packages
\n
If the app isn't building, or yarn xxx commands aren't working you may need to just reset your node_modules. To do so you can run: rm -r node_modules && yarn or del /s /q node_modules && yarn on Windows.
\n
If you really think something might have gone wrong, you can force your repo to clear everything that doesn't match the repo with git reset --hard HEAD && git clean -fxd && git pull -r
\n
Contributing
\n
We ❤️ contributions from everyone and contributions to this project are encouraged, and compensated. We welcome bug reports, bug fixes and feedback is always appreciated. For more details, see CONTRIBUTING.md.
\n
\n
License
\n
This project is MIT licensed. For the full license, see LICENSE.
\n
Security
\n
We take security seriously. Please contact security@lbry.com regarding any security issues. Our PGP key is here if you need it. Previous versions up to v0.50.2 were signed by Sean Yesmunt.\nNew Releases are signed by Jessop Breth.
A Software to create aliases for commands, applications to type in cmd, terminal. Just type the original command and type an alias for it. You can also assign a program for it. Browse through the directory to find the program or anything executable using the command line and you can create an alias for the same. Only Windows is supported for releases.
Full Windows install for 64-bit Windows.\nSetupx86.exe => Full Windows install for 32-bit Windows.\n\">
Setupx64.exe => Full Windows install for 64-bit Windows.\nSetupx86.exe => Full Windows install for 32-bit Windows.
\n
Contributing
\n
Big Kudos to Hitesh Peswani for his incredible UI contributions.
\n
We encourage you to contribute to Lazy Type!
\n
We expect contributors to abide by our underlying code of conduct.\nAll conversations and discussions on GitHub (issues, pull requests)\nmust be respectful and harassment-free.
\n
\n
License
\n
This project is licensed under the MIT License - see the LICENSE.md file for details.
\n
",
"readmeOriginal": "
\n\n\n\n
\n
Lazy Type
\n
A Software to create aliases for commands, applications to type in cmd, terminal. Just type the original command and type an alias for it. You can also assign a program for it. Browse through the directory to find the program or anything executable using the command line and you can create an alias for the same. Only Windows is supported for releases.
Setupx64.exe => Full Windows install for 64-bit Windows.\nSetupx86.exe => Full Windows install for 32-bit Windows.
\n
Contributing
\n
Big Kudos to Hitesh Peswani for his incredible UI contributions.
\n
We encourage you to contribute to Lazy Type!
\n
We expect contributors to abide by our underlying code of conduct.\nAll conversations and discussions on GitHub (issues, pull requests)\nmust be respectful and harassment-free.
\n
\n
License
\n
This project is licensed under the MIT License - see the LICENSE.md file for details.
This repo contains the UI code that powers the official LBRY desktop app, as well as lbry.tv. The LBRY app is a graphical browser for the decentralized content marketplace provided by the\nLBRY protocol. It is essentially the\nlbry daemon bundled with a UI using\nElectron.
We provide installers for Windows, macOS (v10.12.4, Sierra, or greater), and Debian-based Linux. See community maintained builds section for alternative Linux installations.
Our releases page also contains the latest\nrelease, pre-releases, and past builds.\nNote: If the deb fails to install using the Ubuntu Software Center, install manually via sudo dpkg -i <path to deb>. You'll need to run sudo apt-get install -f if this is the first time installing it to install dependencies
\n
To install from source or make changes to the application, continue to the next section below.
\n
Community maintained builds for Arch Linux and Flatpak are available, see below. These installs will need to be updated manually as the in-app update process only supports Debian installs at this time.\nNote: If coming from a deb install, the directory structure is different and you'll need to migrate data.
Clone (or fork) this repository: git clone https://github.com/lbryio/lbry-desktop
\n
Change directory into the cloned repository: cd lbry-desktop
\n
Install the dependencies: yarn
\n\n
Run the electron app
\n
yarn dev
\n
\n
If you want to build and launch the production app you can run yarn build. This will give you an executable inside the /dist folder. We use electron-builder to create distributable packages.
\n
\n
Run the web app for development
\n
yarn dev:web
\n
\n
This uses webpack-dev-server and includes hot-reloading. If you want to debug the web server we use in production you can run yarn dev:web-server. This starts a server at localhost:1337 and does not include hot reloading.
\n
\n
Customize the web app
\n
\n
In root directory, duplicate the .env.default file and rename it to .env then copy the code below and paste it anywhere in the .env file.
\n
\n
cp .env.defaults .env\nnano .env\n
\n
\n
\n
To specify your own OG-IMAGE\nYou can either place a png named v2-og.png in the /custom folder or specify the OG_IMAGE_URL in .env
\n
\n
\n
To specify your own channels to be followed on first run\nAUTO_FOLLOW_URLS=lbry://@chan#123...a lbry://@chan2#456...a
\n
\n
\n
If you want to customize the homepage content
\n
\n
\n\n
add CUSTOM_HOMEPAGE=true to the '.env' file
\n
copy /custom/homepage.example.js to /custom/homepage.js and make desired changes to homepage.js
Finally NODE_ENV=production yarn compile:web to rebuild\nNote: You don't need to edit the .env file in the /web folder - that is copied during compile.
\n
\n
Deploy the web app (experimental)
\n\n
Create a server with a domain name and a reverse proxy https to port 1337.
\n
Install pm2, node v10, yarn
\n
Clone this repo
\n
Make any customizations as above
\n
Run yarn to install
\n
Run NODE_ENV=production yarn compile:web to build
\n
Set up pm2 to start ./web/index.js
\n\n
Run both at the same time
\n
Run the two commands above in separate terminal windows
\n
yarn dev\n\n// in another terminal window\nyarn dev:web\n
\n
Resetting your Packages
\n
If the app isn't building, or yarn xxx commands aren't working you may need to just reset your node_modules. To do so you can run: rm -r node_modules && yarn or del /s /q node_modules && yarn on Windows.
\n
If you really think something might have gone wrong, you can force your repo to clear everything that doesn't match the repo with git reset --hard HEAD && git clean -fxd && git pull -r
\n
Contributing
\n
We ❤️ contributions from everyone and contributions to this project are encouraged, and compensated. We welcome bug reports, bug fixes and feedback is always appreciated. For more details, see CONTRIBUTING.md.
\n
\n
License
\n
This project is MIT licensed. For the full license, see LICENSE.
\n
Security
\n
We take security seriously. Please contact security@lbry.com regarding any security issues. Our PGP key is here if you need it. Previous versions up to v0.50.2 were signed by Sean Yesmunt.\nNew Releases are signed by Jessop Breth.
This repo contains the UI code that powers the official LBRY desktop app, as well as lbry.tv. The LBRY app is a graphical browser for the decentralized content marketplace provided by the\nLBRY protocol. It is essentially the\nlbry daemon bundled with a UI using\nElectron.
We provide installers for Windows, macOS (v10.12.4, Sierra, or greater), and Debian-based Linux. See community maintained builds section for alternative Linux installations.
Our releases page also contains the latest\nrelease, pre-releases, and past builds.\nNote: If the deb fails to install using the Ubuntu Software Center, install manually via sudo dpkg -i <path to deb>. You'll need to run sudo apt-get install -f if this is the first time installing it to install dependencies
\n
To install from source or make changes to the application, continue to the next section below.
\n
Community maintained builds for Arch Linux and Flatpak are available, see below. These installs will need to be updated manually as the in-app update process only supports Debian installs at this time.\nNote: If coming from a deb install, the directory structure is different and you'll need to migrate data.
Clone (or fork) this repository: git clone https://github.com/lbryio/lbry-desktop
\n
Change directory into the cloned repository: cd lbry-desktop
\n
Install the dependencies: yarn
\n\n
Run the electron app
\n
yarn dev
\n
\n
If you want to build and launch the production app you can run yarn build. This will give you an executable inside the /dist folder. We use electron-builder to create distributable packages.
\n
\n
Run the web app for development
\n
yarn dev:web
\n
\n
This uses webpack-dev-server and includes hot-reloading. If you want to debug the web server we use in production you can run yarn dev:web-server. This starts a server at localhost:1337 and does not include hot reloading.
\n
\n
Customize the web app
\n
\n
In root directory, duplicate the .env.default file and rename it to .env then copy the code below and paste it anywhere in the .env file.
\n
\n
cp .env.defaults .env\nnano .env\n
\n
\n
\n
To specify your own OG-IMAGE\nYou can either place a png named v2-og.png in the /custom folder or specify the OG_IMAGE_URL in .env
\n
\n
\n
To specify your own channels to be followed on first run\nAUTO_FOLLOW_URLS=lbry://@chan#123...a lbry://@chan2#456...a
\n
\n
\n
If you want to customize the homepage content
\n
\n
\n\n
add CUSTOM_HOMEPAGE=true to the '.env' file
\n
copy /custom/homepage.example.js to /custom/homepage.js and make desired changes to homepage.js
Finally NODE_ENV=production yarn compile:web to rebuild\nNote: You don't need to edit the .env file in the /web folder - that is copied during compile.
\n
\n
Deploy the web app (experimental)
\n\n
Create a server with a domain name and a reverse proxy https to port 1337.
\n
Install pm2, node v10, yarn
\n
Clone this repo
\n
Make any customizations as above
\n
Run yarn to install
\n
Run NODE_ENV=production yarn compile:web to build
\n
Set up pm2 to start ./web/index.js
\n\n
Run both at the same time
\n
Run the two commands above in separate terminal windows
\n
yarn dev\n\n// in another terminal window\nyarn dev:web\n
\n
Resetting your Packages
\n
If the app isn't building, or yarn xxx commands aren't working you may need to just reset your node_modules. To do so you can run: rm -r node_modules && yarn or del /s /q node_modules && yarn on Windows.
\n
If you really think something might have gone wrong, you can force your repo to clear everything that doesn't match the repo with git reset --hard HEAD && git clean -fxd && git pull -r
\n
Contributing
\n
We ❤️ contributions from everyone and contributions to this project are encouraged, and compensated. We welcome bug reports, bug fixes and feedback is always appreciated. For more details, see CONTRIBUTING.md.
\n
\n
License
\n
This project is MIT licensed. For the full license, see LICENSE.
\n
Security
\n
We take security seriously. Please contact security@lbry.com regarding any security issues. Our PGP key is here if you need it. Previous versions up to v0.50.2 were signed by Sean Yesmunt.\nNew Releases are signed by Jessop Breth.
Lectrote packages up IF interpreters with the Chromium browser as a Mac/Win/Linux app.
\n
When launched, it prompts you to select a game file to play. You can play several games at the same time in separate windows. Your position is always autosaved; when you launch a game, your last play session will automatically be resumed.
\n
Lectrote currently supports:
\n
\n
Glulx games (.ulx or .gblorb), as produced by Inform 7.
\n
Z-code games (.z3/.z4/.z5/.z8 or .zblorb), as produced by Inform 7 or earlier versions of Inform.
Ink compiled game files (.json), as produced by the Ink scripting language.
\n
\n
You can also use this package to construct a \"bound game\" -- an app which plays a single built-in game. This is a package containing Chromium, the interpreter, your game file, and perhaps some additional configuration. You can distribute this as a standalone game application; it's bulky but it lets people play your game.
\n
Linux note: Depending on your Linux configuration and how you install this package, you may have to add the --no-sandbox option when launching Lectrote.
\n
Glulx (Inform 7) support
\n
Because this relies on the Quixe interpreter, sound is not supported. It's also not as fast as a native interpreter.
\n
Z-code support
\n
Lectrote uses the ZVM interpreter for Z-machine support. (V3/4/5 and V8 only.)
\n
Hugo support
\n
The Hugo engine does not currently support autosave.
\n
TADS support
\n
The TADS 2/3 engine does not currently support autosave.
\n
Ink support
\n
This relies on the inkjs interpreter. It is a deliberately non-fancy presentation -- no attempt to slow-print the output or hide the choice list.
\n
License information
\n
\n
Lectrote is copyright (c) 2016-2021, Andrew Plotkin (MIT license)
\n
Electron is copyright (c) 2013-2021 GitHub Inc. (MIT license)
\n
Quixe is copyright (c) 2010-2020, Andrew Plotkin (MIT license)
\n
inkjs is copyright (c) 2017-2020 Yannick Lohse (MIT license)
\n
ifvms.js is copyright (c) 2016 Dannii Willis and other contributors (MIT license)
\n
emglken is copyright (c) 2012-2017, Andrew Plotkin, Dannii Willis (MIT license)
\n
Git (in emglken) is copyright (c) 2003 Iain Merrick (MIT license)
\n
Glulxe (in emglken) is copyright (c) 1999-2016, Andrew Plotkin (MIT license)
\n
Hugo (in emglken) is copyright (c) 2011 by Kent Tessman (BSD license)
To fetch all the necessary Node packages and place them in a node_modules directory:
\n
npm install\n
\n
This command also fetches the Quixe submodule (which will live in the quixe directory). You must have git installed for this to work.
\n
Now just type
\n
npm start\n
\n
...to launch the app.
\n
When run this way, the app will show up named as \"Electron\", not \"Lectrote\".
\n
Packaging Lectrote
\n
The makedist.py script builds the zip files which you see on the release page. (Yes, it is silly to use a Python packaging script in a Node.js package. Maybe I'll rewrite it into Javascript. Later.)
\n
python3 makedist.py\n
\n
This creates build directories and then zip files in a dist directory. Add -b to only generate the build dirs; -z to transform existing build dirs into zip files.
\n
You can add arguments to narrow down the platforms you are building, e.g.:
To build a universal (Intel/ARM) Mac binary, you must first build the Intel and ARM binaries. This command will build all three:
\n
python3 makedist.py darwin\n
\n
If you want to code-sign the Mac version, use the --macsign argument:
\n
python3 makedist.py darwin --macsign 'Developer ID Application: ...'\n
\n
You must be a registered Apple developer to do this. The argument must be the name of the \"Developer Id Application\" certificate in your keychain. Run the Keychain Access app to see this. If you don't have one, the easiest way to set it up is to run Xcode, open the Preferences, select Accounts, and hit Manage Certificates.
\n
Building a signed universal Mac version is unfortunately a pain in the butt. You must (a) build the darwin-x64 and darwin-arm64 versions unsigned; (b) build darwin-univ with the --macsign argument; (c) build the first two again with the --macsign argument. I may streamline this in the future.
\n
Packaging a bound game
\n
You will need to create a separate directory for your game's files. Copy package.json to the directory, adding or modifying these lines:
\n
\n
name: A node package name. This is not used anywhere, so it doesn't really matter.
\n
productName: The display name for the app.
\n
version: Version number of your game.
\n
author: You, the game's author.
\n
description: One-line description of your game.
\n
lectrotePackagedGame: Pathname to the game file.
\n
lectroteSoleInterpreter: Set to \"ifvms\", \"inkjs\", \"emglken\" to include just one of Lectrote's interpreter engines. (Optional, but it saves a little bit of space.) (Note that Git, Glulxe, Hugo, and TADS are all handled by the emglken package. There's currently no way to include just one of them.)
\n
lectroteExtraFiles: An array of extra files to include. These are assumed to be in the game directory, so you do not have to include the directory prefix. (This list must include the game file -- yes, it's redundant with lectrotePackagedGame.)
\n
lectroteMacAppID: If you plan to build a MacOS app, a reverse-DNS ID string to uniquely identify it.
\n
lectroteCopyright: Copyright string (applied to Windows binaries).
\n
\n
(Do not change lectroteVersion; that should always show the Lectrote release that you built your bound app from.)
\n
You may also copy any of Lectrote's content files to your game directory and customize them. You will probably want to customize about.html, for example.
\n
The samplegame directory in the Lectrote source demonstrates the layout. It will be simplest to clone that and alter it.
\n
Once your files are ready, do:
\n
python3 makedist.py --game GAMEDIR\n
\n
This will build and package apps for all platforms. (You can test this out of the box by using samplegame for the GAMEDIR.) As noted above, you can cut down the stages or targets with the -b, -z options or by naming platforms.
\n
You cannot launch a bound game by typing npm start. You have to package it, at least to the -b stage, and run it from the dist directory.
\n
Customizing your bound app
\n
As noted, you can copy play.html, el-glkote.css, or other Lectrote files into your gamedir and customize them. When packaging with the --game option, files found in the gamedir will replace normal Lectrote files.
\n
If you add new files (not replacing Lectrote files), be sure to list them in the lectroteExtraFiles array.
\n
You can extend the functionality of the app -- for example, adding or removing menu items. Add a Javascript file to your gamedir, and name it in your package.json file:
\n
\"lectroteMainExtension\": \"GAMEDIR/FILE.js\",\n
\n
(And add it to lectroteExtraFiles as well.)
\n
This file can define new functionality by exporting any of the following Javascript functions. For example, you could say:
\n
exports.launch = function() { ... }\n
\n
\n
exports.launch(): Called when the app starts up.
\n
exports.app_ready(): Called when the app is ready to open windows. At this point the game window has already been opened.
\n
exports.construct_menu_template(template, special): Called to customize the app menu template. The template argument is a Javascript data structure as described in the Electron Menu docs. special is null for the game window, or one of the strings \"about\", \"prefs\", \"card\" for one of Lectrote's special windows. Modify template and return it.
\n
exports.set_zoom_factor(val): Called when the app's zoom level changes. The argument is suitable for Electron's setZoomFactor() method.
\n
exports.set_darklight_mode(val): Called when the OS native theme changes. The argument is false for light theme, true for dark theme.
\n
exports.export_game_path(): The bound app normally has an \"Export Portable Game File...\" menu option, which lets the user extract your game file for use in other interpreters. You can implement this function and return null to suppress this menu option. You can also return the pathname of a different game file, which is not actually a useful thing to do.
\n
exports.cover_image_info: An object { url:URL, width:W, height:H } which provides cover art. This is only needed if your game is not a blorb file. (If it is not provided, Lectrote attempts to load the blorb cover art as usual.)
\n
exports.about_window_size: An object { width:W, height:H } which customizes the size of the about.html window. (Defaults to { width:600, height:450 }.)
\n
\n
The main Lectrote module exports several functions you can use in your extension code. I have not yet documented them; see the main.js file.
\n
Style customizations for dark/light mode
\n
As of release 1.3.6 (August 2020), Lectrote supports OS dark theme. You should do the same for any windows you have added or customized.
\n
Look at about.html to see how this works. The evhan_darklight() function alters the document style; the onready() function now sets up a callback for this function. The <body> tag now has <body id=\"body\"> to support this, and several .DarkMode stanzas have been added to the CSS. You should copy these changes in your own about.html.
\n
When opening a window, use a backgroundColor line to set the loading color, minimizing flash:
Also add a set_darklight_mode() routine to your extension code (see above). This routine should send the same message to all open windows.
\n
In the window, set up a handler for this message and adjust your body styles appropriately:
\n
require('electron').ipcRenderer.on('set-darklight-mode', function(ev, arg) {\n\t// arg is false for light mode, true for dark mode.\n});\n
\n
See about.html and if-card.html for examples of dark/light style handling.
\n
Be sure to test that your windows open with the appropriate theme (matching the OS theme), and also that they change dynamically when the OS theme changes.
Lectrote packages up IF interpreters with the Chromium browser as a Mac/Win/Linux app.
\n
When launched, it prompts you to select a game file to play. You can play several games at the same time in separate windows. Your position is always autosaved; when you launch a game, your last play session will automatically be resumed.
\n
Lectrote currently supports:
\n
\n
Glulx games (.ulx or .gblorb), as produced by Inform 7.
\n
Z-code games (.z3/.z4/.z5/.z8 or .zblorb), as produced by Inform 7 or earlier versions of Inform.
Ink compiled game files (.json), as produced by the Ink scripting language.
\n
\n
You can also use this package to construct a \"bound game\" -- an app which plays a single built-in game. This is a package containing Chromium, the interpreter, your game file, and perhaps some additional configuration. You can distribute this as a standalone game application; it's bulky but it lets people play your game.
\n
Linux note: Depending on your Linux configuration and how you install this package, you may have to add the --no-sandbox option when launching Lectrote.
\n
Glulx (Inform 7) support
\n
Because this relies on the Quixe interpreter, sound is not supported. It's also not as fast as a native interpreter.
\n
Z-code support
\n
Lectrote uses the ZVM interpreter for Z-machine support. (V3/4/5 and V8 only.)
\n
Hugo support
\n
The Hugo engine does not currently support autosave.
\n
TADS support
\n
The TADS 2/3 engine does not currently support autosave.
\n
Ink support
\n
This relies on the inkjs interpreter. It is a deliberately non-fancy presentation -- no attempt to slow-print the output or hide the choice list.
\n
License information
\n
\n
Lectrote is copyright (c) 2016-2021, Andrew Plotkin (MIT license)
\n
Electron is copyright (c) 2013-2021 GitHub Inc. (MIT license)
\n
Quixe is copyright (c) 2010-2020, Andrew Plotkin (MIT license)
\n
inkjs is copyright (c) 2017-2020 Yannick Lohse (MIT license)
\n
ifvms.js is copyright (c) 2016 Dannii Willis and other contributors (MIT license)
\n
emglken is copyright (c) 2012-2017, Andrew Plotkin, Dannii Willis (MIT license)
\n
Git (in emglken) is copyright (c) 2003 Iain Merrick (MIT license)
\n
Glulxe (in emglken) is copyright (c) 1999-2016, Andrew Plotkin (MIT license)
\n
Hugo (in emglken) is copyright (c) 2011 by Kent Tessman (BSD license)
To fetch all the necessary Node packages and place them in a node_modules directory:
\n
npm install\n
\n
This command also fetches the Quixe submodule (which will live in the quixe directory). You must have git installed for this to work.
\n
Now just type
\n
npm start\n
\n
...to launch the app.
\n
When run this way, the app will show up named as \"Electron\", not \"Lectrote\".
\n
Packaging Lectrote
\n
The makedist.py script builds the zip files which you see on the release page. (Yes, it is silly to use a Python packaging script in a Node.js package. Maybe I'll rewrite it into Javascript. Later.)
\n
python3 makedist.py\n
\n
This creates build directories and then zip files in a dist directory. Add -b to only generate the build dirs; -z to transform existing build dirs into zip files.
\n
You can add arguments to narrow down the platforms you are building, e.g.:
To build a universal (Intel/ARM) Mac binary, you must first build the Intel and ARM binaries. This command will build all three:
\n
python3 makedist.py darwin\n
\n
If you want to code-sign the Mac version, use the --macsign argument:
\n
python3 makedist.py darwin --macsign 'Developer ID Application: ...'\n
\n
You must be a registered Apple developer to do this. The argument must be the name of the \"Developer Id Application\" certificate in your keychain. Run the Keychain Access app to see this. If you don't have one, the easiest way to set it up is to run Xcode, open the Preferences, select Accounts, and hit Manage Certificates.
\n
Building a signed universal Mac version is unfortunately a pain in the butt. You must (a) build the darwin-x64 and darwin-arm64 versions unsigned; (b) build darwin-univ with the --macsign argument; (c) build the first two again with the --macsign argument. I may streamline this in the future.
\n
Packaging a bound game
\n
You will need to create a separate directory for your game's files. Copy package.json to the directory, adding or modifying these lines:
\n
\n
name: A node package name. This is not used anywhere, so it doesn't really matter.
\n
productName: The display name for the app.
\n
version: Version number of your game.
\n
author: You, the game's author.
\n
description: One-line description of your game.
\n
lectrotePackagedGame: Pathname to the game file.
\n
lectroteSoleInterpreter: Set to \"ifvms\", \"inkjs\", \"emglken\" to include just one of Lectrote's interpreter engines. (Optional, but it saves a little bit of space.) (Note that Git, Glulxe, Hugo, and TADS are all handled by the emglken package. There's currently no way to include just one of them.)
\n
lectroteExtraFiles: An array of extra files to include. These are assumed to be in the game directory, so you do not have to include the directory prefix. (This list must include the game file -- yes, it's redundant with lectrotePackagedGame.)
\n
lectroteMacAppID: If you plan to build a MacOS app, a reverse-DNS ID string to uniquely identify it.
\n
lectroteCopyright: Copyright string (applied to Windows binaries).
\n
\n
(Do not change lectroteVersion; that should always show the Lectrote release that you built your bound app from.)
\n
You may also copy any of Lectrote's content files to your game directory and customize them. You will probably want to customize about.html, for example.
\n
The samplegame directory in the Lectrote source demonstrates the layout. It will be simplest to clone that and alter it.
\n
Once your files are ready, do:
\n
python3 makedist.py --game GAMEDIR\n
\n
This will build and package apps for all platforms. (You can test this out of the box by using samplegame for the GAMEDIR.) As noted above, you can cut down the stages or targets with the -b, -z options or by naming platforms.
\n
You cannot launch a bound game by typing npm start. You have to package it, at least to the -b stage, and run it from the dist directory.
\n
Customizing your bound app
\n
As noted, you can copy play.html, el-glkote.css, or other Lectrote files into your gamedir and customize them. When packaging with the --game option, files found in the gamedir will replace normal Lectrote files.
\n
If you add new files (not replacing Lectrote files), be sure to list them in the lectroteExtraFiles array.
\n
You can extend the functionality of the app -- for example, adding or removing menu items. Add a Javascript file to your gamedir, and name it in your package.json file:
\n
\"lectroteMainExtension\": \"GAMEDIR/FILE.js\",\n
\n
(And add it to lectroteExtraFiles as well.)
\n
This file can define new functionality by exporting any of the following Javascript functions. For example, you could say:
\n
exports.launch = function() { ... }\n
\n
\n
exports.launch(): Called when the app starts up.
\n
exports.app_ready(): Called when the app is ready to open windows. At this point the game window has already been opened.
\n
exports.construct_menu_template(template, special): Called to customize the app menu template. The template argument is a Javascript data structure as described in the Electron Menu docs. special is null for the game window, or one of the strings \"about\", \"prefs\", \"card\" for one of Lectrote's special windows. Modify template and return it.
\n
exports.set_zoom_factor(val): Called when the app's zoom level changes. The argument is suitable for Electron's setZoomFactor() method.
\n
exports.set_darklight_mode(val): Called when the OS native theme changes. The argument is false for light theme, true for dark theme.
\n
exports.export_game_path(): The bound app normally has an \"Export Portable Game File...\" menu option, which lets the user extract your game file for use in other interpreters. You can implement this function and return null to suppress this menu option. You can also return the pathname of a different game file, which is not actually a useful thing to do.
\n
exports.cover_image_info: An object { url:URL, width:W, height:H } which provides cover art. This is only needed if your game is not a blorb file. (If it is not provided, Lectrote attempts to load the blorb cover art as usual.)
\n
exports.about_window_size: An object { width:W, height:H } which customizes the size of the about.html window. (Defaults to { width:600, height:450 }.)
\n
\n
The main Lectrote module exports several functions you can use in your extension code. I have not yet documented them; see the main.js file.
\n
Style customizations for dark/light mode
\n
As of release 1.3.6 (August 2020), Lectrote supports OS dark theme. You should do the same for any windows you have added or customized.
\n
Look at about.html to see how this works. The evhan_darklight() function alters the document style; the onready() function now sets up a callback for this function. The <body> tag now has <body id=\"body\"> to support this, and several .DarkMode stanzas have been added to the CSS. You should copy these changes in your own about.html.
\n
When opening a window, use a backgroundColor line to set the loading color, minimizing flash:
Also add a set_darklight_mode() routine to your extension code (see above). This routine should send the same message to all open windows.
\n
In the window, set up a handler for this message and adjust your body styles appropriately:
\n
require('electron').ipcRenderer.on('set-darklight-mode', function(ev, arg) {\n\t// arg is false for light mode, true for dark mode.\n});\n
\n
See about.html and if-card.html for examples of dark/light style handling.
\n
Be sure to test that your windows open with the appropriate theme (matching the OS theme), and also that they change dynamically when the OS theme changes.
This is an Electron app, scaffolded with electron-vue.
\n
\n
You will need to have Node/Yarn installed locally.
\n
You will need to have Docker for Mac or Docker for Windows installed and running. Older implementations of Docker, using docker-machine or boot2docker, are not supported.
\n
You will need a test project with a valid docker-compose.yml file. Consider using one of the example Docker Compose projects to test.
\n
\n
Build Setup
\n
# install dependencies\nyarn install\n\n# serve with hot reload at localhost:9080\nyarn run dev\n\n# build electron application for production\nyarn run build\n\n# quick build (.app only)\nyarn run build:dir\n\n# run unit tests\nyarn test\n\n# lint all JS/Vue component files in `src/`\nyarn run lint\n
\n
Writing Tests
\n
Unit tests are written for Vue components and should be placed in the test/specs directory. Here are a few guides for writing tests using Lifeboat's setup:
\n
\n
Vue Test Utils: The library of tool used to test shallow copies of Vue components.
\n
Expect: Part of Facebook's Jest testing suite. Used for assertions.
\n
Sinon: Used for spies, mocks, stubs, and fake timers.
\n
\n
Troubleshooting
\n
A valid Apple Developer ID signing certificate is required if you want to release a build. If you get an issue during code signing similar to ...resource fork, Finder information, or similar detritus not allowed, try inspecting which files are causing trouble with:
\n
xattr -lr /path/to/lifeboat/\n
\n
And clean up any files with:
\n
\n\">
xattr -cr /path/to/lifeboat/<optional pattern>\n
\n\n
This project was generated with electron-vue@331f85f using vue-cli. Documentation about the original structure can be found here.
\n
",
"readmeOriginal": "
lifeboat
\n
Update 11/14/2019: This project is archived and will no longer receive updates.
This is an Electron app, scaffolded with electron-vue.
\n
\n
You will need to have Node/Yarn installed locally.
\n
You will need to have Docker for Mac or Docker for Windows installed and running. Older implementations of Docker, using docker-machine or boot2docker, are not supported.
\n
You will need a test project with a valid docker-compose.yml file. Consider using one of the example Docker Compose projects to test.
\n
\n
Build Setup
\n
# install dependencies\nyarn install\n\n# serve with hot reload at localhost:9080\nyarn run dev\n\n# build electron application for production\nyarn run build\n\n# quick build (.app only)\nyarn run build:dir\n\n# run unit tests\nyarn test\n\n# lint all JS/Vue component files in `src/`\nyarn run lint\n
\n
Writing Tests
\n
Unit tests are written for Vue components and should be placed in the test/specs directory. Here are a few guides for writing tests using Lifeboat's setup:
\n
\n
Vue Test Utils: The library of tool used to test shallow copies of Vue components.
\n
Expect: Part of Facebook's Jest testing suite. Used for assertions.
\n
Sinon: Used for spies, mocks, stubs, and fake timers.
\n
\n
Troubleshooting
\n
A valid Apple Developer ID signing certificate is required if you want to release a build. If you get an issue during code signing similar to ...resource fork, Finder information, or similar detritus not allowed, try inspecting which files are causing trouble with:
\n
xattr -lr /path/to/lifeboat/\n
\n
And clean up any files with:
\n
xattr -cr /path/to/lifeboat/<optional pattern>\n
\n\n
This project was generated with electron-vue@331f85f using vue-cli. Documentation about the original structure can be found here.
To Lepton users around the world in more than 130 countries: We hope you all stay safe, healthy, and strong as we get through the COVID-19 pandemic. Lepton will continue to be free, as always. If you find this app helpful, we encourage you to make a donation to a local or global charity of your choice to help fight against the pandemic. Together, we can make the world a better place. ❤️
Lepton's can be customized by <home_dir>/.leptonrc! You can find its exact path in the About page by Command/Ctrl + ,. Create the file if it does not exist.
\n
\n
Theme (light/dark)
\n
Snippet
\n
Editor
\n
Logger
\n
Proxy
\n
Shortcuts
\n
Enterprise
\n
Notifications
\n
\n
Check out the configuration docs to explore different customization options.
To Lepton users around the world in more than 130 countries: We hope you all stay safe, healthy, and strong as we get through the COVID-19 pandemic. Lepton will continue to be free, as always. If you find this app helpful, we encourage you to make a donation to a local or global charity of your choice to help fight against the pandemic. Together, we can make the world a better place. ❤️
Lepton's can be customized by <home_dir>/.leptonrc! You can find its exact path in the About page by Command/Ctrl + ,. Create the file if it does not exist.
\n
\n
Theme (light/dark)
\n
Snippet
\n
Editor
\n
Logger
\n
Proxy
\n
Shortcuts
\n
Enterprise
\n
Notifications
\n
\n
Check out the configuration docs to explore different customization options.
A modern, electron and nodejs based image viewer for Mac, Windows and Linux.\n
\n
Main features
\n
\n
Built with Electron.\n
\n
LightGallery uses HTML, CSS, and JavaScript with Chromium and Node.js to build the app.
\n
\n
\n
Cross-platform.\n
\n
LightGallery works across operating systems. You can use it on OS X, Windows, or Linux.
\n
\n
\n
20+ Animations\n
\n
LightGallery comes with numerous number of beautiful in-built animations.
\n
\n
\n
Animated thumbnails\n
\n
You also have the option to enable animated thumbnails from the settings.
\n
\n
\n
Zoom & Fullscreen\n
\n
You can double-click on the image to see its actual size. Zoom-in and zoom-out controls can be used for changing the zoom values of the image.
\n
\n
\n
Mouse Drag & keyboard Navigations\n
\n
LightGallery allows users to navigate between slides via mouse drag and keyboard arrows.
\n
\n
\n
Pagers
\n
Auto slideshow
\n
Support various kind of image formats (jpg, png, gif, webp).
\n
Highly customizable
\n
And many more.
\n
\n
Watch ⭐ this repository. More features are coming
\n
Settings
\n
\n\n
\n
Name
\n
Default
\n
Description
\n
\n\n\n
\n
mode
\n
'lg-slide'
\n
Type of transition between images. lightGallery comes with lots of transition effects such as 'lg-slide', 'lg-fade', 'lg-zoom-in', 'lg-zoom-in-big', 'lg-zoom-out', 'lg-zoom-out-big', 'lg-zoom-out-in', 'lg-zoom-in-out', 'lg-soft-zoom', 'lg-scale-up', 'lg-slide-circular', 'lg-slide-circular-vertical', 'lg-slide-vertical', 'lg-slide-vertical-growth', 'lg-slide-skew-only', 'lg-slide-skew-only-rev', 'lg-slide-skew-only-y', 'lg-slide-skew-only-y-rev', 'lg-slide-skew', 'lg-slide-skew-rev', 'lg-slide-skew-cross', 'lg-slide-skew-cross-rev', 'lg-slide-skew-ver', 'lg-slide-skew-ver-rev', 'lg-slide-skew-ver-cross', 'lg-slide-skew-ver-cross-rev', 'lg-lollipop', 'lg-lollipop-rev', 'lg-rotate', 'lg-rotate-rev', 'lg-tube'
\n
\n
\n
cssEasing
\n
'ease'
\n
Type of easing to be used for animations
\n
\n
\n
speed
\n
600
\n
Transition duration (in ms).
\n
\n
\n
hideBarsDelay
\n
6000
\n
Delay for hiding gallery controls in ms
\n
\n
\n
useLeft
\n
false
\n
force lightgallery to use css left property instead of transform.
\n
\n
\n
closable
\n
true
\n
allows clicks on dimmer to close gallery.
\n
\n
\n
loop
\n
true
\n
If false, will disable the ability to loop back to the beginning of the gallery when on the last element.
\n
\n
\n
keyPress
\n
true
\n
Enable keyboard navigation
\n
\n
\n
controls
\n
true
\n
If false, prev/next buttons will not be displayed.
\n
\n
\n
slideEndAnimatoin
\n
true
\n
Enable slideEnd animation
\n
\n
\n
hideControlOnEnd
\n
false
\n
If true, prev/next button will be hidden on first/last image.
\n
\n
\n
mousewheel
\n
true
\n
Change slide on mousewheel
\n
\n
\n
preload
\n
1
\n
Number of preload slides. will exicute only after the current slide is fully loaded. ex:// you clicked on 4th image and if preload = 1 then 3rd slide and 5th slide will be loaded in the background after the 4th slide is fully loaded.. if preload is 2 then 2nd 3rd 5th 6th slides will be preloaded
\n
\n
\n
showAfterLoad
\n
true
\n
Show Content once it is fully loaded
\n
\n
\n
counter
\n
true
\n
Whether to show total number of images and index number of currently displayed image.
\n
\n
\n
swipeThreshold
\n
50
\n
By setting the swipeThreshold (in px) you can set how far the user must swipe for the next/prev image.
\n
\n
\n
enableDrag
\n
true
\n
Enables desktop mouse drag support
\n
\n
\n
thumbnail
\n
true
\n
Enable thumbnails for the gallery
\n
\n
\n
animateThumb
\n
true
\n
Enable thumbnail animation.
\n
\n
\n
currentPagerPosition
\n
'middle'
\n
Position of selected thumbnail. 'left' or 'middle' or 'right'
\n
\n
\n
thumbWidth
\n
100
\n
Width of each thumbnails.
\n
\n
\n
thumbContHeight
\n
100
\n
Height of the thumbnail container including padding and border
\n
\n
\n
thumbMargin
\n
5
\n
Spacing between each thumbnails
\n
\n
\n
toogleThumb
\n
true
\n
Whether to display thumbnail toggle button.
\n
\n
\n
enableThumbDrag
\n
true
\n
Enables desktop mouse drag support for thumbnails.
\n
\n
\n
swipeThreshold
\n
50
\n
By setting the swipeThreshold (in px) you can set how far the user must swipe for the next/prev slide.
\n
\n
\n
autoplay
\n
true
\n
Enable gallery autoplay
\n
\n
\n
pause
\n
5000
\n
The time (in ms) between each auto transition.
\n
\n
\n
progressBar
\n
true
\n
Enable autoplay progress bar
\n
\n
\n
fourceAutoplay
\n
false
\n
If false autoplay will be stopped after first user action
\n
\n
\n
autoplayControls
\n
true
\n
Show/hide autoplay controls.
\n
\n
\n
pager
\n
true
\n
Enable/Disable pager
\n
\n
\n
zoom
\n
true
\n
Enable/Disable zoom option
\n
\n
\n
scale
\n
1
\n
Value of zoom should be incremented/decremented
\n
\n\n
\n
Development
\n
Project's folders
\n
\n
app - code of your application goes here.
\n
config - place for you to declare environment specific stuff.
\n
build - in this folder lands built, runnable application.
\n
releases - ready for distribution installers will land here.
\n
resources - resources for particular operating system.
\n
tasks - build and development environment scripts.
\n
\n
Installation
\n
npm install\n
\n
It will also download Electron runtime, and install dependencies for second package.json file inside app folder.
\n
Starting the app
\n
npm start\n
\n
Making a release
\n
To make ready for distribution installer use command:
\n
npm run release\n
\n
It will start the packaging process for the operating system you are running this command on. The file which is ready for distribution will be outputted to releases directory.
\n
You can create Windows installer only when running on Windows, the same is true for Linux and OSX. So to generate all three installers you need all three operating systems.
Integrated Suite of Business Applications.. (Not an open source project but free for the first 1,000 Companies!)
\n
\n
Follow me on twitter @sachinchoolur for the latest news, updates about this project.
\n
Special thanks to Jakub Szwacz for electron boilerplate
\n
License
\n
MIT License
\n
",
+ "readmeOriginal": "
lightGallery
\n
A modern, electron and nodejs based image viewer for Mac, Windows and Linux.\n
\n
Main features
\n
\n
Built with Electron.\n
\n
LightGallery uses HTML, CSS, and JavaScript with Chromium and Node.js to build the app.
\n
\n
\n
Cross-platform.\n
\n
LightGallery works across operating systems. You can use it on OS X, Windows, or Linux.
\n
\n
\n
20+ Animations\n
\n
LightGallery comes with numerous number of beautiful in-built animations.
\n
\n
\n
Animated thumbnails\n
\n
You also have the option to enable animated thumbnails from the settings.
\n
\n
\n
Zoom & Fullscreen\n
\n
You can double-click on the image to see its actual size. Zoom-in and zoom-out controls can be used for changing the zoom values of the image.
\n
\n
\n
Mouse Drag & keyboard Navigations\n
\n
LightGallery allows users to navigate between slides via mouse drag and keyboard arrows.
\n
\n
\n
Pagers
\n
Auto slideshow
\n
Support various kind of image formats (jpg, png, gif, webp).
\n
Highly customizable
\n
And many more.
\n
\n
Watch ⭐ this repository. More features are coming
\n
Settings
\n
\n\n
\n
Name
\n
Default
\n
Description
\n
\n\n\n
\n
mode
\n
'lg-slide'
\n
Type of transition between images. lightGallery comes with lots of transition effects such as 'lg-slide', 'lg-fade', 'lg-zoom-in', 'lg-zoom-in-big', 'lg-zoom-out', 'lg-zoom-out-big', 'lg-zoom-out-in', 'lg-zoom-in-out', 'lg-soft-zoom', 'lg-scale-up', 'lg-slide-circular', 'lg-slide-circular-vertical', 'lg-slide-vertical', 'lg-slide-vertical-growth', 'lg-slide-skew-only', 'lg-slide-skew-only-rev', 'lg-slide-skew-only-y', 'lg-slide-skew-only-y-rev', 'lg-slide-skew', 'lg-slide-skew-rev', 'lg-slide-skew-cross', 'lg-slide-skew-cross-rev', 'lg-slide-skew-ver', 'lg-slide-skew-ver-rev', 'lg-slide-skew-ver-cross', 'lg-slide-skew-ver-cross-rev', 'lg-lollipop', 'lg-lollipop-rev', 'lg-rotate', 'lg-rotate-rev', 'lg-tube'
\n
\n
\n
cssEasing
\n
'ease'
\n
Type of easing to be used for animations
\n
\n
\n
speed
\n
600
\n
Transition duration (in ms).
\n
\n
\n
hideBarsDelay
\n
6000
\n
Delay for hiding gallery controls in ms
\n
\n
\n
useLeft
\n
false
\n
force lightgallery to use css left property instead of transform.
\n
\n
\n
closable
\n
true
\n
allows clicks on dimmer to close gallery.
\n
\n
\n
loop
\n
true
\n
If false, will disable the ability to loop back to the beginning of the gallery when on the last element.
\n
\n
\n
keyPress
\n
true
\n
Enable keyboard navigation
\n
\n
\n
controls
\n
true
\n
If false, prev/next buttons will not be displayed.
\n
\n
\n
slideEndAnimatoin
\n
true
\n
Enable slideEnd animation
\n
\n
\n
hideControlOnEnd
\n
false
\n
If true, prev/next button will be hidden on first/last image.
\n
\n
\n
mousewheel
\n
true
\n
Change slide on mousewheel
\n
\n
\n
preload
\n
1
\n
Number of preload slides. will exicute only after the current slide is fully loaded. ex:// you clicked on 4th image and if preload = 1 then 3rd slide and 5th slide will be loaded in the background after the 4th slide is fully loaded.. if preload is 2 then 2nd 3rd 5th 6th slides will be preloaded
\n
\n
\n
showAfterLoad
\n
true
\n
Show Content once it is fully loaded
\n
\n
\n
counter
\n
true
\n
Whether to show total number of images and index number of currently displayed image.
\n
\n
\n
swipeThreshold
\n
50
\n
By setting the swipeThreshold (in px) you can set how far the user must swipe for the next/prev image.
\n
\n
\n
enableDrag
\n
true
\n
Enables desktop mouse drag support
\n
\n
\n
thumbnail
\n
true
\n
Enable thumbnails for the gallery
\n
\n
\n
animateThumb
\n
true
\n
Enable thumbnail animation.
\n
\n
\n
currentPagerPosition
\n
'middle'
\n
Position of selected thumbnail. 'left' or 'middle' or 'right'
\n
\n
\n
thumbWidth
\n
100
\n
Width of each thumbnails.
\n
\n
\n
thumbContHeight
\n
100
\n
Height of the thumbnail container including padding and border
\n
\n
\n
thumbMargin
\n
5
\n
Spacing between each thumbnails
\n
\n
\n
toogleThumb
\n
true
\n
Whether to display thumbnail toggle button.
\n
\n
\n
enableThumbDrag
\n
true
\n
Enables desktop mouse drag support for thumbnails.
\n
\n
\n
swipeThreshold
\n
50
\n
By setting the swipeThreshold (in px) you can set how far the user must swipe for the next/prev slide.
\n
\n
\n
autoplay
\n
true
\n
Enable gallery autoplay
\n
\n
\n
pause
\n
5000
\n
The time (in ms) between each auto transition.
\n
\n
\n
progressBar
\n
true
\n
Enable autoplay progress bar
\n
\n
\n
fourceAutoplay
\n
false
\n
If false autoplay will be stopped after first user action
\n
\n
\n
autoplayControls
\n
true
\n
Show/hide autoplay controls.
\n
\n
\n
pager
\n
true
\n
Enable/Disable pager
\n
\n
\n
zoom
\n
true
\n
Enable/Disable zoom option
\n
\n
\n
scale
\n
1
\n
Value of zoom should be incremented/decremented
\n
\n\n
\n
Development
\n
Project's folders
\n
\n
app - code of your application goes here.
\n
config - place for you to declare environment specific stuff.
\n
build - in this folder lands built, runnable application.
\n
releases - ready for distribution installers will land here.
\n
resources - resources for particular operating system.
\n
tasks - build and development environment scripts.
\n
\n
Installation
\n
npm install\n
\n
It will also download Electron runtime, and install dependencies for second package.json file inside app folder.
\n
Starting the app
\n
npm start\n
\n
Making a release
\n
To make ready for distribution installer use command:
\n
npm run release\n
\n
It will start the packaging process for the operating system you are running this command on. The file which is ready for distribution will be outputted to releases directory.
\n
You can create Windows installer only when running on Windows, the same is true for Linux and OSX. So to generate all three installers you need all three operating systems.
Linked allows you to write down your thoughts and ideas to link them with days. The app was originally created as a weekend project for my colleagues at work.\nWe needed an app to offload our brain and write down things that we may need for our daily meetings or other scrum events, things that simply did not fit inside a ticket.
Linked allows you to write down your thoughts and ideas to link them with days. The app was originally created as a weekend project for my colleagues at work.\nWe needed an app to offload our brain and write down things that we may need for our daily meetings or other scrum events, things that simply did not fit inside a ticket.
Local Mock Server is a simple tool for creating mock server locally. With this you can create number of mock api's by configuring request method, request path, response status and JSON response body
\n
This app spins up a server locally and saves all the JSON data locally on your system(on Desktop)
\n
Uses
\n
\n
Before integrating with the real api, front-end developers can create a mock server to simulate each endpoint and its corresponding response body and also response status
\n
Helps in reducing the dependency of UI team with the server team
\n
\n
ScreenShots
\n
\n
\n
Creating new Mock API\n
\n
\n
\n
Editing Mock API\n
\n
\n
\n
JSON Viewer\n
\n
\n
\n
",
+ "readmeOriginal": "
Local Mock Server
\n
Local Mock Server is a simple tool for creating mock server locally. With this you can create number of mock api's by configuring request method, request path, response status and JSON response body
\n
This app spins up a server locally and saves all the JSON data locally on your system(on Desktop)
\n
Uses
\n
\n
Before integrating with the real api, front-end developers can create a mock server to simulate each endpoint and its corresponding response body and also response status
\n
Helps in reducing the dependency of UI team with the server team
Local Browser is a browser built on Electron.\nLocal Browser is peer to peer browser, which provide you facility to share you localhost with other local browser user's in just one click.
\n
New Features! 🌟
\n
\n
✅ Peer To Peer Browsing
\n
✅ Tab Management
\n
✅ Easy UI
\n
\n
What Local Browser Does ? 🌟
\n
Local Browser works on ptp protocol, ptp stands for Peer To Peer Protocol. With Local Browser you don't need to save you website or web application on server inorder to share it, you can keep your files on your machine and can share them with others. Your web app only shared with other users till local browser has opened on your machine.
\n
Libraries 🌟
\n
Local Browser uses a number of API's and libraries to work properly:
\n
\n
✅ [NodeJs] - evented I/O for the backend
\n
✅ [localtunnel] - library to tunnel localhost
\n
\n
Installation 🌟
\n
\n
Installers are available on website here.\nElectron requires Node.js to run.
\n
\n
$ cd local-browser\n$ npm install\n$ electron . or npm start
\n
License
\n
MIT
\n
",
+ "readmeOriginal": "
\n
Local Browser
\n
What is Local Browser ?
\n
Local Browser is a browser built on Electron.\nLocal Browser is peer to peer browser, which provide you facility to share you localhost with other local browser user's in just one click.
\n
New Features! 🌟
\n
\n
✅ Peer To Peer Browsing
\n
✅ Tab Management
\n
✅ Easy UI
\n
\n
What Local Browser Does ? 🌟
\n
Local Browser works on ptp protocol, ptp stands for Peer To Peer Protocol. With Local Browser you don't need to save you website or web application on server inorder to share it, you can keep your files on your machine and can share them with others. Your web app only shared with other users till local browser has opened on your machine.
\n
Libraries 🌟
\n
Local Browser uses a number of API's and libraries to work properly:
\n
\n
✅ [NodeJs] - evented I/O for the backend
\n
✅ [localtunnel] - library to tunnel localhost
\n
\n
Installation 🌟
\n
\n
Installers are available on website here.\nElectron requires Node.js to run.
\n
\n
$ cd local-browser\n$ npm install\n$ electron . or npm start
Welcome to the official component library for Local!
\n
What's included in this component library?
\n
We appreciate curious minds and that's a great question!\nTake a quick look at our living component documentation here.
\n
In additional to a quickly growing set of React components, we also have SVGs, SASS partials, and more to come!
\n
Installation
\n\n
Clone and pull down the latest from the repo
\n
Install dependencies using yarn
\n\n
Storybook
\n
The quickest way to work on local-components is to leverage Storybook. Storybook is a\nlocal development area that works well with React components and supports hot-module reloading.
\n
To start Storybook, run yarn storybook.
\n
Developing within Local
\n
If you wish to work on local-components and see the changes within Local, you will need to do the following:
\n\n
First run yarn build in local-components
\n
Next run yarn link (only needed one time or after unlinking)
\n
Switch to flywheel-local
\n
Then run nps components.link (only needed one time or after unlinking)
\n
Finally run nps build.dev
\n
Start Local
\n
Make any necessary changes in local-components. Note, Local does not support hot-module reloading in all locations\nso refreshing the UI in Local (Cmd + R) will likely be necessary.
\n\n
Running both Storybook and Watch at the same time
\n
If you wish to run both Storybook and the watcher for Local at the same time, you can run yarn start. Note, this particular\nscript spawns two instances of Webpack and is very resource intensive.
\n
Digging deeper
\n
The local-components library can be broken down into 3 main parts:
These are the visual elements that make up both Local and its Add-ons.\nThere are currently 40+ React components in the library.\nEach component consists of a .tsx, index.js, README.md and optional .sass file.
\n
Try it out for yourself!
\n\n
Make changes to the internals of a component through its .tsx and .sass files (they should live reload)
\n
Play around with the examples found in the README.md files
Note: the entry point for all components and styles is index.ts.
\n
\n
Containers Wrapper
\n
Several components leverage the Container.tsx component to wrap their own implementation.\nContainer is a highly specialized component that can be toggled on (wraps contents in extra div) or toggled off (no extra div).\nIn addition, the Container wrapper adds convenience props that allow for easy one-off adjustments like adding 3px of margin without conflicting with the inner content's classes and styles.
\n
\n
Note: setting any of container's props will automatically toggle it on (disabled: false) thus wrapping the contents in the container wrapper.
\n
\n
Organization
\n
Components are organized by type. These type groups can be seen when running Storybook.
\n
Styles
\n
Suit CSS
\n
Naming is hard. And there's no perfect system.\nThat said, we have chosen Suit CSS for naming conventions.
\n
\n
Note: instead of dashes, local-components uses underscores due to a limitation of a legacy package.
\n
\n
CSS Modules
\n
The component library leverages CSS Modules to manage and scope styles.\nThese are considered local styles (not to be confused with the Local app 😉)\nScoped local styles are a beautiful thing that allow Local to isolate components, run Add-ons with multiple versions of local-components and avoid collisions.
\n
As wonderful as local styles are, there are instances where CSS needs to transcend a single component.\nFor that, we make use of global styles.\nGlobal styles should be familiar to most as that's what the web largely used for 20+ years.\nGlobal styles are intended to be used sparingly as they introduce a lot of challenges when scaling an app with a library of Add-ons and Environments.
\n
The following is an instance where a scoped component may use a combination of local and global styles to achieve a specific result:
\n
:global(.WindowsToolbar .DragRegion)
\n
This is something we try to avoid and are actively working to whittle down to the bare essentials.
\n
If you'd like to learn more about scoped styles, please check out CSS Modules here.
\n
SASS Partials, Mixins, and Functions
\n
There is an extensive sass system in use that many -- if not most -- components leverage.
\n
Partials
\n
If you search for the _partials directory, you will find variables, mixins, functions, and other shared resources.
\n
Variables
\n
If Local uses a color, it's defined as a variable within the _variables.scss file.\nIn addition, there are fonts, font sizes, font weights, and margin/padding preset values here.
\n
\n
Note: font sies and margin/padding uses t-shirt sizes to indicate relative sizing while adhering to strict design standards/values.
\n
\n
Themes
\n
Local has both light and dark modes. Since this impacts every single components, the _theme.scss file contains\nmixins that simplifies the implementation of these variations in a repeatable and predictable way.
\n
While you could leverage if-theme-light and if-theme-dark directly, most light/dark combinations follow a specific pattern and therefore have dedicated mixin.\nFor example, the theme-color-black-else-white mixin applies the color style of black (if light) otherwise white (if dark).\nAnother example, the theme-background-green-else-graydark mixin applies the background style of green (if light) otherwise graydark (if dark).
\n
\n
Note: light/dark mode styles are applied by toggling a class added to the html element (e.g. Theme__Light).
Welcome to the official component library for Local!
\n
What's included in this component library?
\n
We appreciate curious minds and that's a great question!\nTake a quick look at our living component documentation here.
\n
In additional to a quickly growing set of React components, we also have SVGs, SASS partials, and more to come!
\n
Installation
\n\n
Clone and pull down the latest from the repo
\n
Install dependencies using yarn
\n\n
Storybook
\n
The quickest way to work on local-components is to leverage Storybook. Storybook is a\nlocal development area that works well with React components and supports hot-module reloading.
\n
To start Storybook, run yarn storybook.
\n
Developing within Local
\n
If you wish to work on local-components and see the changes within Local, you will need to do the following:
\n\n
First run yarn build in local-components
\n
Next run yarn link (only needed one time or after unlinking)
\n
Switch to flywheel-local
\n
Then run nps components.link (only needed one time or after unlinking)
\n
Finally run nps build.dev
\n
Start Local
\n
Make any necessary changes in local-components. Note, Local does not support hot-module reloading in all locations\nso refreshing the UI in Local (Cmd + R) will likely be necessary.
\n\n
Running both Storybook and Watch at the same time
\n
If you wish to run both Storybook and the watcher for Local at the same time, you can run yarn start. Note, this particular\nscript spawns two instances of Webpack and is very resource intensive.
\n
Digging deeper
\n
The local-components library can be broken down into 3 main parts:
These are the visual elements that make up both Local and its Add-ons.\nThere are currently 40+ React components in the library.\nEach component consists of a .tsx, index.js, README.md and optional .sass file.
\n
Try it out for yourself!
\n\n
Make changes to the internals of a component through its .tsx and .sass files (they should live reload)
\n
Play around with the examples found in the README.md files
Note: the entry point for all components and styles is index.ts.
\n
\n
Containers Wrapper
\n
Several components leverage the Container.tsx component to wrap their own implementation.\nContainer is a highly specialized component that can be toggled on (wraps contents in extra div) or toggled off (no extra div).\nIn addition, the Container wrapper adds convenience props that allow for easy one-off adjustments like adding 3px of margin without conflicting with the inner content's classes and styles.
\n
\n
Note: setting any of container's props will automatically toggle it on (disabled: false) thus wrapping the contents in the container wrapper.
\n
\n
Organization
\n
Components are organized by type. These type groups can be seen when running Storybook.
\n
Styles
\n
Suit CSS
\n
Naming is hard. And there's no perfect system.\nThat said, we have chosen Suit CSS for naming conventions.
\n
\n
Note: instead of dashes, local-components uses underscores due to a limitation of a legacy package.
\n
\n
CSS Modules
\n
The component library leverages CSS Modules to manage and scope styles.\nThese are considered local styles (not to be confused with the Local app 😉)\nScoped local styles are a beautiful thing that allow Local to isolate components, run Add-ons with multiple versions of local-components and avoid collisions.
\n
As wonderful as local styles are, there are instances where CSS needs to transcend a single component.\nFor that, we make use of global styles.\nGlobal styles should be familiar to most as that's what the web largely used for 20+ years.\nGlobal styles are intended to be used sparingly as they introduce a lot of challenges when scaling an app with a library of Add-ons and Environments.
\n
The following is an instance where a scoped component may use a combination of local and global styles to achieve a specific result:
\n
:global(.WindowsToolbar .DragRegion)
\n
This is something we try to avoid and are actively working to whittle down to the bare essentials.
\n
If you'd like to learn more about scoped styles, please check out CSS Modules here.
\n
SASS Partials, Mixins, and Functions
\n
There is an extensive sass system in use that many -- if not most -- components leverage.
\n
Partials
\n
If you search for the _partials directory, you will find variables, mixins, functions, and other shared resources.
\n
Variables
\n
If Local uses a color, it's defined as a variable within the _variables.scss file.\nIn addition, there are fonts, font sizes, font weights, and margin/padding preset values here.
\n
\n
Note: font sies and margin/padding uses t-shirt sizes to indicate relative sizing while adhering to strict design standards/values.
\n
\n
Themes
\n
Local has both light and dark modes. Since this impacts every single components, the _theme.scss file contains\nmixins that simplifies the implementation of these variations in a repeatable and predictable way.
\n
While you could leverage if-theme-light and if-theme-dark directly, most light/dark combinations follow a specific pattern and therefore have dedicated mixin.\nFor example, the theme-color-black-else-white mixin applies the color style of black (if light) otherwise white (if dark).\nAnother example, the theme-background-green-else-graydark mixin applies the background style of green (if light) otherwise graydark (if dark).
\n
\n
Note: light/dark mode styles are applied by toggling a class added to the html element (e.g. Theme__Light).
\n The swiss army knife of lossless video/audio editing\n\t \n \n \n\t \n\t \n Thanks to all my supporters\n\t \n\t \n
\n\t \n\t \n
\n
LosslessCut aims to be the ultimate cross platform FFmpeg GUI for extremely fast and lossless operations on video, audio, subtitle and other related media files.\nThe main feature is lossless trimming and cutting of video and audio files, which is great for saving space by rough-cutting your large video files taken from a video camera, GoPro, drone, etc. It lets you quickly extract the good parts from your videos and discard many gigabytes of data without doing a slow re-encode and thereby losing quality. Or you can add a music or subtitle track to your video without needing to encode. Everything is extremely fast because it does an almost direct data copy, fueled by the awesome FFmpeg which does all the grunt work.
\n
Features
\n
\n
Lossless cutting of most video and audio formats
\n
Losslessly cut out parts of video/audio (for cutting away commercials etc.)
\n
Losslessly rearrange the order of video/audio segments
\n
Lossless merge/concatenation of arbitrary files (with identical codecs parameters, e.g. from the same camera)
\n
Lossless stream editing: Combine arbitrary tracks from multiple files (ex. add music or subtitle track to a video file)
\n
Losslessly extract all tracks from a file (extract video, audio, subtitle and other tracks from one file into separate files)
\n
Remux into any compatible output format
\n
Take full-resolution snapshots from videos in JPEG/PNG format
\n
Manual input of cutpoint times
\n
Apply a per-file timecode offset (and auto load timecode from file)
\n
Change rotation/orientation metadata in videos
\n
View technical data about all streams
\n
Timeline zoom and frame/keyframe jumping for accurate cutting around keyframes
\n
Saves per project cut segments to project file
\n
View FFmpeg last command log so you can modify and re-run recent commands on the command line
\n
Undo/redo
\n
Give labels to cut segments
\n
View segment details, export/import cut segments as CSV
\n
Import segments from: MP4/MKV chapters, Text file, YouTube, CSV, CUE, XML (DaVinci, Final Cut Pro)
\n
Video thumbnails and audio waveform
\n
Edit file metadata and per-stream metadata
\n
Cut with chapter marks
\n
\n
Example lossless use cases
\n
\n
Cut out commercials from a recorded TV show (and re-format from TS to MP4)
\n
Remove audio tracks from a file
\n
Extract music track from a video and cut it to your needs
\n
Add music to a video (or replace existing audio track)
\n
Combine audio and video tracks from separate recordings
\n
Include an external subtitle into a video
\n
Quickly change a H264/H265 MKV video to MOV or MP4 for playback on iPhone
\n
Import a list of cut times from other tool as a EDL (edit decision list, CSV) and run these cuts with LosslessCut
\n
Export a list of cut times as a CSV EDL and process these in another tool
\n
Quickly cut a file by its MP4/MKV chapters
\n
Quickly cut a YouTube video by its chapters (or music times from a comment)
\n
Change the language of a file's audio/subtitle tracks
\n
Change author, title, GPS position, recording time of a video
\n
Fix rotation of a video that has the wrong orientation flag set\n
\n
Great for rotating phone videos that come out the wrong way without actually re-encoding the video.
\n
\n
\n
Loop a video / audio clip X times quickly without re-encoding\n
Export with Merge and \"Create chapters from merged segments\" enabled
\n
Open the exported file and select \"Import chapters\" in the dialog
\n
File -> Export project -> YouTube Chapters
\n\n
Re-encode only the audio track, leaving the video track
\n
First export each track as individual files. Then use Handbrake or similar to re-encode the audio file. Then use the Tools->Merge in LosslessCut to merge the original video stream with your Handbrake output (or drag it into your original LosslessCut video to include it as a new track.)
\n
Advanced multi-step workflows
\n
Tip: you can use LosslessCut in multiple passes in order to achieve separate trimming of individual tracks:
\n\n
Open a file an export all tracks as individual files
\n
Open the exported track files independently and cut them as desired
\n
Add the track back to the video and combine them to one output video
\n\n
Download
\n
If you want to support my continued work on LosslessCut, and you want the advantage of a secure and simple installation process with automatic updates, consider getting it from your favorite store:
\n
\n
If you prefer to download the executables manually, this will of course always be free:
If you find LosslessCut useful, I'm very thankful for donations.
\n
Difference between App Stores and Github download
\n
They have exactly the same in-app features, except a few platform limitations. Apple doesn't allow opening VOB files with App Store apps. Apple App Store apps need to prompt for output directory. LosslessCut version in the App Stores lags a few versions behind the GitHub version, because I want to be sure that the new versions work perfectly before releasing in the App Stores. GitHub version can contain new, untested features and may contain some bugs. I consider the newest GitHub versions to be a public \"beta\" test.
\n
Supported formats
\n
Since LosslessCut is based on Chromium and uses the HTML5 video player, not all FFmpeg supported formats will be supported smoothly.\nThe following formats/codecs should generally work: MP4, MOV, WebM, MKV, OGG, WAV, MP3, AAC, H264, Theora, VP8, VP9\nFor more information about supported formats / codecs, see https://www.chromium.org/audio-video.
\n
Unsupported files can still be converted to a supported format/codec from the File menu. (Try the fastest variant first.) A low quality version of the file (without audio) will then be created and opened in the player. The cut/export operation will still be performed on the original file, so it will be lossless. This allows for potentially opening any file that FFmpeg is able to decode.
\n
How to use
\n
Watch tutorial video - Your video here? If you would like to make a video showing off LosslessCut use cases, let me know and I can link it here!
\n
Typical workflow
\n
\n
Drag drop a video file into player or use ⌘/CTRL+O.
\n
Press SPACE to play/pause or ◀▶, ,. or mouse/trackpad wheel to seek back/forth.
\n
Select the cut segment's start and end time by moving the time marker and then pressing I to set start time, and O to set end time.\n
\n
Note that all segments you create will be preserved and exported as new files. You can change this behavior with the Yin Yang symbol ☯️, in which case it will instead remove all selected segments and export the parts between segments.
\n
Note also that start times will not be accurate, see Known issues
\n
\n
\n
(optional) If you want to add more than one segment, move to the desired start time and press +, then select the next segment start/end times with I/O.
\n
(optional) If you want to re-merge all the selected segments into one file after cutting, toggle the button Separate files to Merge cuts.
\n
(optional) If you want to export to a certain output folder, press the Working dir unset button (default: Input file folder)
\n
(optional) If you want to change orientation, press the rotation button
\n
(optional) By default, audio, video and subtitle tracks from the input file will be cut and exported. Press the Tracks button to customise and/or add new tracks from other files.
\n
(optional) select a new output format
\n
(optional) In the right-hand segments panel, right click a segment for options, or drag-drop to reorder. Segments will appear in this order in the merged output.
\n
When done, press the Export button (or E) to show an overview with export options.
\n
(optional) adjust any export options
\n
Then press Export again to confirm the export
\n
Press the Camera button (or C) if you want to take a JPEG/PNG snapshot from the current time
\n
If you want to move the original file to trash, press the trash button
\n
For best results you may need to trial and error with another output format (Matroska takes nearly everything), change keyframe cut mode or disable some tracks (see known issues below).
\n
Press H to view help and all keyboard shortcuts.
\n
Note: The original video file will not be modified. Instead, a file is created file in the same directory as the original file with from/to timestamps in the file name.
\n
\n
Known issues & limitations
\n
\n
Cutting times are not accurate! Start cut time will be \"rounded\" to the nearest previous keyframe.\n
\n
Lossless cutting is not an exact science. For some codecs, it just works. For others, you may need to trial and error depending on the codec, keyframes etc to get the best cut. See #330
\n
Your mileage may vary when it comes to Keyframe cut vs Normal cut. You may need to try both, depending on the video. ffmpeg also has documentation about these two seek/cut modes. Keyframe cut means -ssbefore-i and Normal cut means -ssafter-i.
\n
\n
\n
When exporting you may lose some proprietary data tracks (like tmcd, fdsc and gpmd added by GoPro). These can however be losslessly exported to separate files.
\n
EXIF/metadata can be preserved (see Export Options dialog), but it doesn't always output compliant files, so use it carefully.
\n
Some codecs are not supported natively. There is partial support with low quality playback and no audio. You can convert to a supported codec from the File menu, see #88, however it may take some time.
\n
\n
Troubleshooting / FAQ
\n
\n
If you get an error when cutting or opening any kind of file under Windows, try to disable your anti-virus. See #18
\n
If you get an error on Linux like FATAL:setuid_sandbox_host.cc(157)] The SUID sandbox helper binary was found, but is not configured correctly. Rather than run without sandboxing I'm aborting now., try to run it as ./lossless-cut --no-sandbox. See #258
\n
If any other problem, check Known issues, or please search for existing issues before you file an issue here on GitHub.
\n
If the app crashes immediately upon startup, check the permissions of your User and Temp folders, see 61.
\n
How to uninstall LosslessCut on Windows? There is no installer. Just delete the EXE file or containing folder. User files will be stored in your appData folder.
\n
\n
If you have an issue you can check the developer tools for any errors or clues. Menu: Tools -> Toggle Developer Tools
\n
CSV import/export
\n
\n
The CSV export/import function takes CSV files with one cut segment on each line. Each line contains three columns: segment start, segment end, label.
\n
segment start and segment end are expressed in seconds or left empty. Empty segment end means segment ends at the duration of the video.
\n
Use comma , to separate the fields (not semicolon ;)
\n
\n
example.csv
\n
,56.9568,First segment starting at 0\n70,842.33,\"Another quoted label\"\n1234,,Last segment\n
This project is maintained by me alone. The project will always remain free and open source, but if it's useful for you, consider supporting me. :) It will give me extra motivation to improve it. Or even better donate to ffmpeg because they are doing the world a big favor 🙏
\n The swiss army knife of lossless video/audio editing\n\t \n \n \n\t \n\t \n Thanks to all my supporters\n\t \n\t \n
\n\t \n\t \n
\n
LosslessCut aims to be the ultimate cross platform FFmpeg GUI for extremely fast and lossless operations on video, audio, subtitle and other related media files.\nThe main feature is lossless trimming and cutting of video and audio files, which is great for saving space by rough-cutting your large video files taken from a video camera, GoPro, drone, etc. It lets you quickly extract the good parts from your videos and discard many gigabytes of data without doing a slow re-encode and thereby losing quality. Or you can add a music or subtitle track to your video without needing to encode. Everything is extremely fast because it does an almost direct data copy, fueled by the awesome FFmpeg which does all the grunt work.
\n
Features
\n
\n
Lossless cutting of most video and audio formats
\n
Losslessly cut out parts of video/audio (for cutting away commercials etc.)
\n
Losslessly rearrange the order of video/audio segments
\n
Lossless merge/concatenation of arbitrary files (with identical codecs parameters, e.g. from the same camera)
\n
Lossless stream editing: Combine arbitrary tracks from multiple files (ex. add music or subtitle track to a video file)
\n
Losslessly extract all tracks from a file (extract video, audio, subtitle and other tracks from one file into separate files)
\n
Remux into any compatible output format
\n
Take full-resolution snapshots from videos in JPEG/PNG format
\n
Manual input of cutpoint times
\n
Apply a per-file timecode offset (and auto load timecode from file)
\n
Change rotation/orientation metadata in videos
\n
View technical data about all streams
\n
Timeline zoom and frame/keyframe jumping for accurate cutting around keyframes
\n
Saves per project cut segments to project file
\n
View FFmpeg last command log so you can modify and re-run recent commands on the command line
\n
Undo/redo
\n
Give labels to cut segments
\n
View segment details, export/import cut segments as CSV
\n
Import segments from: MP4/MKV chapters, Text file, YouTube, CSV, CUE, XML (DaVinci, Final Cut Pro)
\n
Video thumbnails and audio waveform
\n
Edit file metadata and per-stream metadata
\n
Cut with chapter marks
\n
\n
Example lossless use cases
\n
\n
Cut out commercials from a recorded TV show (and re-format from TS to MP4)
\n
Remove audio tracks from a file
\n
Extract music track from a video and cut it to your needs
\n
Add music to a video (or replace existing audio track)
\n
Combine audio and video tracks from separate recordings
\n
Include an external subtitle into a video
\n
Quickly change a H264/H265 MKV video to MOV or MP4 for playback on iPhone
\n
Import a list of cut times from other tool as a EDL (edit decision list, CSV) and run these cuts with LosslessCut
\n
Export a list of cut times as a CSV EDL and process these in another tool
\n
Quickly cut a file by its MP4/MKV chapters
\n
Quickly cut a YouTube video by its chapters (or music times from a comment)
\n
Change the language of a file's audio/subtitle tracks
\n
Change author, title, GPS position, recording time of a video
\n
Fix rotation of a video that has the wrong orientation flag set\n
\n
Great for rotating phone videos that come out the wrong way without actually re-encoding the video.
\n
\n
\n
Loop a video / audio clip X times quickly without re-encoding\n
Export with Merge and \"Create chapters from merged segments\" enabled
\n
Open the exported file and select \"Import chapters\" in the dialog
\n
File -> Export project -> YouTube Chapters
\n\n
Re-encode only the audio track, leaving the video track
\n
First export each track as individual files. Then use Handbrake or similar to re-encode the audio file. Then use the Tools->Merge in LosslessCut to merge the original video stream with your Handbrake output (or drag it into your original LosslessCut video to include it as a new track.)
\n
Advanced multi-step workflows
\n
Tip: you can use LosslessCut in multiple passes in order to achieve separate trimming of individual tracks:
\n\n
Open a file an export all tracks as individual files
\n
Open the exported track files independently and cut them as desired
\n
Add the track back to the video and combine them to one output video
\n\n
Download
\n
If you want to support my continued work on LosslessCut, and you want the advantage of a secure and simple installation process with automatic updates, consider getting it from your favorite store:
\n
\n
If you prefer to download the executables manually, this will of course always be free:
If you find LosslessCut useful, I'm very thankful for donations.
\n
Difference between App Stores and Github download
\n
They have exactly the same in-app features, except a few platform limitations. Apple doesn't allow opening VOB files with App Store apps. Apple App Store apps need to prompt for output directory. LosslessCut version in the App Stores lags a few versions behind the GitHub version, because I want to be sure that the new versions work perfectly before releasing in the App Stores. GitHub version can contain new, untested features and may contain some bugs. I consider the newest GitHub versions to be a public \"beta\" test.
\n
Supported formats
\n
Since LosslessCut is based on Chromium and uses the HTML5 video player, not all FFmpeg supported formats will be supported smoothly.\nThe following formats/codecs should generally work: MP4, MOV, WebM, MKV, OGG, WAV, MP3, AAC, H264, Theora, VP8, VP9\nFor more information about supported formats / codecs, see https://www.chromium.org/audio-video.
\n
Unsupported files can still be converted to a supported format/codec from the File menu. (Try the fastest variant first.) A low quality version of the file (without audio) will then be created and opened in the player. The cut/export operation will still be performed on the original file, so it will be lossless. This allows for potentially opening any file that FFmpeg is able to decode.
\n
How to use
\n
Watch tutorial video - Your video here? If you would like to make a video showing off LosslessCut use cases, let me know and I can link it here!
\n
Typical workflow
\n
\n
Drag drop a video file into player or use ⌘/CTRL+O.
\n
Press SPACE to play/pause or ◀▶, ,. or mouse/trackpad wheel to seek back/forth.
\n
Select the cut segment's start and end time by moving the time marker and then pressing I to set start time, and O to set end time.\n
\n
Note that all segments you create will be preserved and exported as new files. You can change this behavior with the Yin Yang symbol ☯️, in which case it will instead remove all selected segments and export the parts between segments.
\n
Note also that start times will not be accurate, see Known issues
\n
\n
\n
(optional) If you want to add more than one segment, move to the desired start time and press +, then select the next segment start/end times with I/O.
\n
(optional) If you want to re-merge all the selected segments into one file after cutting, toggle the button Separate files to Merge cuts.
\n
(optional) If you want to export to a certain output folder, press the Working dir unset button (default: Input file folder)
\n
(optional) If you want to change orientation, press the rotation button
\n
(optional) By default, audio, video and subtitle tracks from the input file will be cut and exported. Press the Tracks button to customise and/or add new tracks from other files.
\n
(optional) select a new output format
\n
(optional) In the right-hand segments panel, right click a segment for options, or drag-drop to reorder. Segments will appear in this order in the merged output.
\n
When done, press the Export button (or E) to show an overview with export options.
\n
(optional) adjust any export options
\n
Then press Export again to confirm the export
\n
Press the Camera button (or C) if you want to take a JPEG/PNG snapshot from the current time
\n
If you want to move the original file to trash, press the trash button
\n
For best results you may need to trial and error with another output format (Matroska takes nearly everything), change keyframe cut mode or disable some tracks (see known issues below).
\n
Press H to view help and all keyboard shortcuts.
\n
Note: The original video file will not be modified. Instead, a file is created file in the same directory as the original file with from/to timestamps in the file name.
\n
\n
Known issues & limitations
\n
\n
Cutting times are not accurate! Start cut time will be \"rounded\" to the nearest previous keyframe.\n
\n
Lossless cutting is not an exact science. For some codecs, it just works. For others, you may need to trial and error depending on the codec, keyframes etc to get the best cut. See #330
\n
Your mileage may vary when it comes to Keyframe cut vs Normal cut. You may need to try both, depending on the video. ffmpeg also has documentation about these two seek/cut modes. Keyframe cut means -ssbefore-i and Normal cut means -ssafter-i.
\n
\n
\n
When exporting you may lose some proprietary data tracks (like tmcd, fdsc and gpmd added by GoPro). These can however be losslessly exported to separate files.
\n
EXIF/metadata can be preserved (see Export Options dialog), but it doesn't always output compliant files, so use it carefully.
\n
Some codecs are not supported natively. There is partial support with low quality playback and no audio. You can convert to a supported codec from the File menu, see #88, however it may take some time.
\n
\n
Troubleshooting / FAQ
\n
\n
If you get an error when cutting or opening any kind of file under Windows, try to disable your anti-virus. See #18
\n
If you get an error on Linux like FATAL:setuid_sandbox_host.cc(157)] The SUID sandbox helper binary was found, but is not configured correctly. Rather than run without sandboxing I'm aborting now., try to run it as ./lossless-cut --no-sandbox. See #258
\n
If any other problem, check Known issues, or please search for existing issues before you file an issue here on GitHub.
\n
If the app crashes immediately upon startup, check the permissions of your User and Temp folders, see 61.
\n
How to uninstall LosslessCut on Windows? There is no installer. Just delete the EXE file or containing folder. User files will be stored in your appData folder.
\n
\n
If you have an issue you can check the developer tools for any errors or clues. Menu: Tools -> Toggle Developer Tools
\n
CSV import/export
\n
\n
The CSV export/import function takes CSV files with one cut segment on each line. Each line contains three columns: segment start, segment end, label.
\n
segment start and segment end are expressed in seconds or left empty. Empty segment end means segment ends at the duration of the video.
\n
Use comma , to separate the fields (not semicolon ;)
\n
\n
example.csv
\n
,56.9568,First segment starting at 0\n70,842.33,\"Another quoted label\"\n1234,,Last segment\n
This project is maintained by me alone. The project will always remain free and open source, but if it's useful for you, consider supporting me. :) It will give me extra motivation to improve it. Or even better donate to ffmpeg because they are doing the world a big favor 🙏
Basier Circle and Gilroy used in the production version are commercial fonts. This repository only contains open fonts and uses Open Sans as a replacement for the commercial ones.
\n
If you have licensed copies of Basier Circle and Gilroy, you can add them to fonts folder. If you don't have the fonts, you need to remove lines 25 - 81 of type.css. After that, the build and dev npm scripts run without any errors.
\n
Setup environemnt
\n
git clone https://github.com/LiskHQ/lisk-desktop.git\ncd lisk-desktop\nnpm install\nnpm run dev\n
For ease of development, you can set the following query string to see network options in login page:
\n
http://localhost:8080/#/?showNetwork=true\n
\n
If you are actively developing in a specific route, and want to be automatically signed in every time you reload the page, please add the following input pairs to your localStorage:
\n
loginKey: a valid passphrase
\n
Add the above pair using the storage tab in your dev tools or via JavaScript command:
\n
localStorage.setItem('loginKey', 'wagon stock borrow episode laundry kitten salute link globe zero feed marble') // desired account passphrase\n
\n
When developing with hardware wallet, this will sign you in using the first account on the first connected hardware wallet:
You can use the same approach to define a desired network to which Lisk Desktop connects:
\n
localStorage.setItem('liskCoreUrl', 'http://localhost:4000') // desired node to log in into\n
\n
Build
\n
Production build
\n
To build the project simply run
\n
npm run build\n
\n
Under the hood, this script runs
\n
npm run build-prod\n
\n
to build the React app under src/ and
\n
npm run build-electron\n
\n
to build the electron app under app/ using webpack. You can run the above scripts individually if you're looking to see the changes solely on one of the two said applications.
\n
Run Electron
\n
If you have already built the application as described above, you can launch Electron using
\n
npm run start\n
\n
Run with parameters
\n
To launch a version which supports hardware wallets, you can run
\n
npm run dev-hardware-wallet\n
\n
or to launch electron and receive live updates from already running webpack-dev-server on port 8080 and you can run
\n
LISK_HUB_URL=\"http://localhost:8080\" DEBUG=true npm run start\n
\n
This comes with Redux dev tools.
\n
Distribution
\n
Windows
\n
Build package for Windows (on Windows in Git BASH).
\n
npm run pack:win\n
\n
macOS
\n
Build package for macOS (on macOs)
\n
npm run pack \n
\n
Linux
\n
Build package for Linux (on Linux).
\n
npm run pack \n
\n
Testing
\n
Unit tests
\n
Single run
\n
npm run test\n
\n
Run each time a file changes
\n
npm run test-live\n
\n
E2E tests
\n
In order to run e2e tests you need to install lisk-core
├── __mocks__/ # Modules used to mock dependencies for testing purpose.\n├── .storybook/ # React storybooks reside here.\n├── app/ # Electron based application that launces the react app.\n├── build/ # Build specific materials.\n├── config/ # Automation scripts (Webpack configurations, i18n scanner, etc)\n├── coverage/ # Results of Jest test coverage.\n├── dist/ # Platform specific built outputs.\n├── docs/ # Project documentations such as contribution guides and development guidelines.\n├── i18n/ # Localization files inluding setup scripts and translation json files.\n├── libs/ # Modules which can be consumed individually in other projects.\n├── node_modules/ # 3rd-party libraries and utilities.\n├── src/ # Application source code.\n│ ├── actions/ # Store actions reside here and are broken into script files dedicated to each system entity.\n│ ├── app/ # The bootstrap React application\n│ ├── assets/ # Static files (images, fonts, etc)\n│ ├── components/ # React presentational components are located here.\n│ │ ├── screens/ # These are the component that represent screens with dedicated URL.\n│ │ ├── shared/ # These are the React components used at least in 2 other components (calendar, liskAmount, etc)\n│ │ └── toolbox/ # Basic elements with basic styles and functionality which are used in numerous places (button, input, etc)\n│ ├── constants/ # Names, addresses, static configurations and other values used throughout the application\n│ ├── context/ # React context configuration files\n│ ├── hooks/ # React custom hooks\n│ ├── store/ # Redux store resides here.\n│ │ ├── middlewares/ # All the Redux middlewares are places here and have their dedicated script files based on the system entities.\n│ │ ├── reducers/ # Redux reducers are located here. similar to actions and reducers, they are placed in script files named after the entity they represent.\n│ ├── utils/ # Utility functions\n└──test/ # E2E tests written with Cypress.io and Cucumber; also some helpers used by unit test that live in /src\n
This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
\n
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 General Public License for more details.
Basier Circle and Gilroy used in the production version are commercial fonts. This repository only contains open fonts and uses Open Sans as a replacement for the commercial ones.
\n
If you have licensed copies of Basier Circle and Gilroy, you can add them to fonts folder. If you don't have the fonts, you need to remove lines 25 - 81 of type.css. After that, the build and dev npm scripts run without any errors.
\n
Setup environemnt
\n
git clone https://github.com/LiskHQ/lisk-desktop.git\ncd lisk-desktop\nnpm install\nnpm run dev\n
For ease of development, you can set the following query string to see network options in login page:
\n
http://localhost:8080/#/?showNetwork=true\n
\n
If you are actively developing in a specific route, and want to be automatically signed in every time you reload the page, please add the following input pairs to your localStorage:
\n
loginKey: a valid passphrase
\n
Add the above pair using the storage tab in your dev tools or via JavaScript command:
\n
localStorage.setItem('loginKey', 'wagon stock borrow episode laundry kitten salute link globe zero feed marble') // desired account passphrase\n
\n
When developing with hardware wallet, this will sign you in using the first account on the first connected hardware wallet:
You can use the same approach to define a desired network to which Lisk Desktop connects:
\n
localStorage.setItem('liskCoreUrl', 'http://localhost:4000') // desired node to log in into\n
\n
Build
\n
Production build
\n
To build the project simply run
\n
npm run build\n
\n
Under the hood, this script runs
\n
npm run build-prod\n
\n
to build the React app under src/ and
\n
npm run build-electron\n
\n
to build the electron app under app/ using webpack. You can run the above scripts individually if you're looking to see the changes solely on one of the two said applications.
\n
Run Electron
\n
If you have already built the application as described above, you can launch Electron using
\n
npm run start\n
\n
Run with parameters
\n
To launch a version which supports hardware wallets, you can run
\n
npm run dev-hardware-wallet\n
\n
or to launch electron and receive live updates from already running webpack-dev-server on port 8080 and you can run
\n
LISK_HUB_URL=\"http://localhost:8080\" DEBUG=true npm run start\n
\n
This comes with Redux dev tools.
\n
Distribution
\n
Windows
\n
Build package for Windows (on Windows in Git BASH).
\n
npm run pack:win\n
\n
macOS
\n
Build package for macOS (on macOs)
\n
npm run pack \n
\n
Linux
\n
Build package for Linux (on Linux).
\n
npm run pack \n
\n
Testing
\n
Unit tests
\n
Single run
\n
npm run test\n
\n
Run each time a file changes
\n
npm run test-live\n
\n
E2E tests
\n
In order to run e2e tests you need to install lisk-core
├── __mocks__/ # Modules used to mock dependencies for testing purpose.\n├── .storybook/ # React storybooks reside here.\n├── app/ # Electron based application that launces the react app.\n├── build/ # Build specific materials.\n├── config/ # Automation scripts (Webpack configurations, i18n scanner, etc)\n├── coverage/ # Results of Jest test coverage.\n├── dist/ # Platform specific built outputs.\n├── docs/ # Project documentations such as contribution guides and development guidelines.\n├── i18n/ # Localization files inluding setup scripts and translation json files.\n├── libs/ # Modules which can be consumed individually in other projects.\n├── node_modules/ # 3rd-party libraries and utilities.\n├── src/ # Application source code.\n│ ├── actions/ # Store actions reside here and are broken into script files dedicated to each system entity.\n│ ├── app/ # The bootstrap React application\n│ ├── assets/ # Static files (images, fonts, etc)\n│ ├── components/ # React presentational components are located here.\n│ │ ├── screens/ # These are the component that represent screens with dedicated URL.\n│ │ ├── shared/ # These are the React components used at least in 2 other components (calendar, liskAmount, etc)\n│ │ └── toolbox/ # Basic elements with basic styles and functionality which are used in numerous places (button, input, etc)\n│ ├── constants/ # Names, addresses, static configurations and other values used throughout the application\n│ ├── context/ # React context configuration files\n│ ├── hooks/ # React custom hooks\n│ ├── store/ # Redux store resides here.\n│ │ ├── middlewares/ # All the Redux middlewares are places here and have their dedicated script files based on the system entities.\n│ │ ├── reducers/ # Redux reducers are located here. similar to actions and reducers, they are placed in script files named after the entity they represent.\n│ ├── utils/ # Utility functions\n└──test/ # E2E tests written with Cypress.io and Cucumber; also some helpers used by unit test that live in /src\n
This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
\n
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 General Public License for more details.
Luna was created with main purpose to provide a flexible and modern UI for npm dependencies management. You can install, update and uninstall packages using a user interface build on latest web technologies.
\n
Features
\n
\n
Manage global and local packages
\n
Search for new packages
\n
Install packages
\n
Update packages
\n
Uninstall packages
\n
Filter packages by name, group and outdated
\n
Preview package details (versions, statistics, dependencies and more)
\n
Get notifications for missing dependencies or extraneous packages
\n
\n
Screenshots
\n
\n
\n \n
\n
\n \n
\n
\n \n
\n
\n \n
\n
\n
How it works
\n
The Renderer Process architecture:
\n
\n
Action (Event) driven nature
\n
The IO Management, Business Logic Management and Predictable Application State Management processors (middlewares)\nare subscribers of the application action stream.
\n
The IO Management and Business Logic Management are consumers and producers of actions.
\n
The Predictable State Management is just a consumer of actions
\n
The views are listeners of the predictable state and they are re rendered whenever the predictable state changes\nand they produce actions upon the user interaction (clicks)
\n
\n
\n
\n \n
\n
\n
Usage
\n
Install application's dependencies:
\n
npm install
\n
Start the application
\n
npm start
\n
Start the development server and run the application in development mode:
\n
npm run dev
\n
Binaries
\n
All binaries of the latest version are uploaded to the releases
\n
Tech Stack
\n
\n
Electron - 🛠 - 🐙 - Build cross-platform desktop apps with JavaScript, HTML, and CSS
\n
React - 🛠 - 🐙 - React is a JavaScript library for building user interfaces
\n
Redux - 🛠 - 🐙 - Predictable state container for JavaScript apps
\n
Webpack - 🛠️ - 🐙 - A static module bundler for modern JavaScript applications.
\n
Babel - 🛠️ - 🐙 - A JavaScript compiler; use next generation JavaScript, today.
Luna was created with main purpose to provide a flexible and modern UI for npm dependencies management. You can install, update and uninstall packages using a user interface build on latest web technologies.
\n
Features
\n
\n
Manage global and local packages
\n
Search for new packages
\n
Install packages
\n
Update packages
\n
Uninstall packages
\n
Filter packages by name, group and outdated
\n
Preview package details (versions, statistics, dependencies and more)
\n
Get notifications for missing dependencies or extraneous packages
\n
\n
Screenshots
\n
\n
\n \n
\n
\n \n
\n
\n \n
\n
\n \n
\n
\n
How it works
\n
The Renderer Process architecture:
\n
\n
Action (Event) driven nature
\n
The IO Management, Business Logic Management and Predictable Application State Management processors (middlewares)\nare subscribers of the application action stream.
\n
The IO Management and Business Logic Management are consumers and producers of actions.
\n
The Predictable State Management is just a consumer of actions
\n
The views are listeners of the predictable state and they are re rendered whenever the predictable state changes\nand they produce actions upon the user interaction (clicks)
\n
\n
\n
\n \n
\n
\n
Usage
\n
Install application's dependencies:
\n
npm install
\n
Start the application
\n
npm start
\n
Start the development server and run the application in development mode:
\n
npm run dev
\n
Binaries
\n
All binaries of the latest version are uploaded to the releases
\n
Tech Stack
\n
\n
Electron - 🛠 - 🐙 - Build cross-platform desktop apps with JavaScript, HTML, and CSS
\n
React - 🛠 - 🐙 - React is a JavaScript library for building user interfaces
\n
Redux - 🛠 - 🐙 - Predictable state container for JavaScript apps
\n
Webpack - 🛠️ - 🐙 - A static module bundler for modern JavaScript applications.
\n
Babel - 🛠️ - 🐙 - A JavaScript compiler; use next generation JavaScript, today.
MagicBox is a tool to minify images, graphics, design source files. Organize a workspace by creating file sets, assign them to project, track file updates, export to project.
There is an issue with yarn and node_modules when the application is built by the packager. Please use npm as dependencies manager.
\n
To build for development
\n
in a terminal window
\n
npm run electron:local
\n
Included Commands
\n
\n\n
\n
Command
\n
Description
\n
\n\n\n
\n
npm run electron:local
\n
Builds your application and start electron
\n
\n
\n
npm run electron:build
\n
Builds your application and creates an app consumable based on your operating system
\n
\n
\n
npm run electron:mac
\n
MacOS Build
\n
\n
\n
npm run electron:windows
\n
Windows Build
\n
\n
\n
npm run electron:linux
\n
Linux Build
\n
\n\n
\n
Please run prettier on all of your PRs before submitting, this can be done with prettier --write in the project directory
\n
License
\n
This project is licensed under the CC BY-NC 4.0\nCreative Commons License - see the LICENSE.md file for\ndetails
\n
Authors
\n
\n
Alexander Katrukhin - Provided README Template -\nakatrukhin
\n
\n
",
+ "readmeOriginal": "
\n\n
MagicBox is a tool to minify images, graphics, design source files. Organize a workspace by creating file sets, assign them to project, track file updates, export to project.
MagicCap is a image/GIF capture suite for Mac and Linux. You can get a precompiled copy from the releases page of this GitHub page. It has the following features:
\n
\n
Very cross compatible. You should get the same experience on Mac and Linux.
\n
Very easy to add to. You don't need to faff around with modifying HTML; instead you write a small file that includes all of the config options and the upload script (most of this is handled by capture.js anyway).
\n
Very fast. Captures are optimised to be as fast as possible.
\n
Very flexible. You can choose to upload to whatever service you want to or just save the file.
\n
Very functional. Want to capture a GIF? No problem. Want to blur a screenshot? No problem. MagicCap is there to help you with whatever you want.
MagicCap supports the following uploaders (this list will expand over time):
\n
\n
Custom HTTP POST
\n
elixi.re
\n
Passive (S)FTP
\n
Pomf
\n
imgur
\n
Lunus
\n
i.magiccap
\n
reUpload
\n
Ultrashare
\n
S3 (Amazon and other S3-compatible providers)
\n
ShareX (upload only)
\n
\n
Credit
\n
The following people have done a ton to help in the creation of MagicCap. If you have done something to help and want your name here, feel free to make a pull request. This is in alphabetical order, not the order of the work people have done:
\n
\n
Devon (Da532) - Made all of the branding.
\n
Harrison (AO554) - Helped us test for Mac.
\n
Jacob (Kelwing) - Helped with some Go towards the project.
\n
Jake (JakeMakesStuff) - Made the majority of the GUI/capture code for MagicCap.
\n
Jake (techfan36) - Helped us test for Linux.
\n
Matt (IPv4) - Refactored file naming, added random emoji & upload from clipboard.
\n
Rhys (SunburntRock89) - Helped me with the structure and fixing bugs. Also fixed FTP.
\n
Sam (REC) - Made the FTP logo.
\n
\n
Building
\n
In order to download needed packages, run npm i. This will get all of the needed packages. You can then run one of the following commands:
\n
\n
npm run maccompile - Compiles for Mac.
\n
npm run linuxcompile - Compiles for Linux.
\n
\n
Mac Note
\n
If you are on Mac, you'll need to download XCode.
\n
More Information
\n
For more information on installation/configuration and compiling, please refer to the documentation.
MagicCap is a image/GIF capture suite for Mac and Linux. You can get a precompiled copy from the releases page of this GitHub page. It has the following features:
\n
\n
Very cross compatible. You should get the same experience on Mac and Linux.
\n
Very easy to add to. You don't need to faff around with modifying HTML; instead you write a small file that includes all of the config options and the upload script (most of this is handled by capture.js anyway).
\n
Very fast. Captures are optimised to be as fast as possible.
\n
Very flexible. You can choose to upload to whatever service you want to or just save the file.
\n
Very functional. Want to capture a GIF? No problem. Want to blur a screenshot? No problem. MagicCap is there to help you with whatever you want.
MagicCap supports the following uploaders (this list will expand over time):
\n
\n
Custom HTTP POST
\n
elixi.re
\n
Passive (S)FTP
\n
Pomf
\n
imgur
\n
Lunus
\n
i.magiccap
\n
reUpload
\n
Ultrashare
\n
S3 (Amazon and other S3-compatible providers)
\n
ShareX (upload only)
\n
\n
Credit
\n
The following people have done a ton to help in the creation of MagicCap. If you have done something to help and want your name here, feel free to make a pull request. This is in alphabetical order, not the order of the work people have done:
\n
\n
Devon (Da532) - Made all of the branding.
\n
Harrison (AO554) - Helped us test for Mac.
\n
Jacob (Kelwing) - Helped with some Go towards the project.
\n
Jake (JakeMakesStuff) - Made the majority of the GUI/capture code for MagicCap.
\n
Jake (techfan36) - Helped us test for Linux.
\n
Matt (IPv4) - Refactored file naming, added random emoji & upload from clipboard.
\n
Rhys (SunburntRock89) - Helped me with the structure and fixing bugs. Also fixed FTP.
\n
Sam (REC) - Made the FTP logo.
\n
\n
Building
\n
In order to download needed packages, run npm i. This will get all of the needed packages. You can then run one of the following commands:
\n
\n
npm run maccompile - Compiles for Mac.
\n
npm run linuxcompile - Compiles for Linux.
\n
\n
Mac Note
\n
If you are on Mac, you'll need to download XCode.
\n
More Information
\n
For more information on installation/configuration and compiling, please refer to the documentation.
Mailspring is a new version of Nylas Mail maintained by one of the original authors. It's faster, leaner, and shipping today! It replaces the JavaScript sync code in Nylas Mail with a new C++ sync engine based on Mailcore2. It uses roughly half the RAM and CPU of Nylas Mail and idles with almost zero \"CPU Wakes\", which translates to great battery life. It also has an entirely revamped composer and other great new features.
\n
Mailspring's UI is open source (GPLv3) and written in TypeScript with Electron and React - it's built on a plugin architecture and was designed to be easy to extend. Check out CONTRIBUTING.md to get started!
\n
Mailspring's sync engine is spawned by the Electron application and runs locally on your computer. It is open source (GPLv3) and written in C++ and C. For convenience, however, when you set up your development environment, Mailspring uses the latest version of the sync engine we've shipped for your platform so you don't need to pull sources or install its compile-time dependencies.
\n
\n
Features
\n
Mailspring comes packed with powerful features like Unified Inbox, Snooze, Send\nLater, Mail Rules, Templates and more. Mailspring Pro, which you can unlock\nwith a monthly subscription, adds even more features for people who send a ton\nof email: link tracking, read receipts, mailbox analytics, contact and company\nprofiles. All of these features run in the client - Mailspring does not send\nyour email credentials to the cloud. For a full list of features, check out\ngetmailspring.com.
\n
Download Mailspring
\n
You can download compiled versions of Mailspring for Windows, Mac OS X, and\nLinux (deb, rpm and snap) from\nhttps://getmailspring.com/download.
\n
Getting Help
\n
You can find community-based help and discussion with other Mailspring users on our\nDiscourse community.
\n
Contributing
\n
Mailspring is entirely open-source. Pull requests and contributions are\nwelcome! There are three ways to contribute: building a plugin, building a\ntheme, and submitting pull requests to the project itself. When you're getting\nstarted, you may want to join our\nDiscourse so you can ask questions and\nlearn from other people doing development.
\n
\n
Running Mailspring from Source
\n
To install all dependencies and run Mailspring from its source code,\nrun the following commands from the root directory of the Mailspring repository:
\n
npm install\nnpm start\n
\n
You can attach command line parameters by separating them using a double hyphen:
\n
npm start -- --help\n
\n
Building Mailspring
\n
To build Mailspring, you need to run the following command from the root directory\nof the Mailspring repository:
\n
npm run-script build\n
\n
Building A Plugin
\n
Plugins lie at the heart of Mailspring and give it its powerful features.\nBuilding your own plugins allows you to integrate the app with other tools,\nexperiment with new workflows, and more. Follow the Getting Started\nguide to write your first plugin in\nfive minutes.
A plugin \"store\" like the Chrome Web Store is coming soon, and will make it\neasy for other users to discover plugins you create. (Right now, users need to\n\"sideload\" the plugins into the app by downloading them and copying them into\nplace.)
\n
You can share and browse Mailspring Plugins, and discuss plugin development\nwith other developers, on our\nDiscourse.
\n
Building a Theme
\n
The Mailspring user interface is styled using CSS, which means it's easy to\nmodify and extend. Mailspring comes stock with a few beautiful themes, and\nthere are many more which have been built by community developers. To start\ncreating a theme, clone the theme starter!
You can share and browse Mailspring Themes, and discuss theme development with other developers, on our Discourse.
\n
Localizing / Translating
\n
Mailspring (1.5.0 and above) supports localization. If you're a fluent speaker of\nanother language, we'd love your help improving translations. Check out the\nLOCALIZATION\nguide for more information. You can discuss localization and translation with\nother developers on our Discourse.
\n
Contributing to Mailspring Core
\n
Pull requests are always welcome - check out\nCONTRIBUTING\nfor more information about setting up the development environment, running\ntests locally, and submitting pull requests.
\n
",
+ "readmeOriginal": "
💌 Mailspring
\n
\n
\n
Mailspring is a new version of Nylas Mail maintained by one of the original authors. It's faster, leaner, and shipping today! It replaces the JavaScript sync code in Nylas Mail with a new C++ sync engine based on Mailcore2. It uses roughly half the RAM and CPU of Nylas Mail and idles with almost zero \"CPU Wakes\", which translates to great battery life. It also has an entirely revamped composer and other great new features.
\n
Mailspring's UI is open source (GPLv3) and written in TypeScript with Electron and React - it's built on a plugin architecture and was designed to be easy to extend. Check out CONTRIBUTING.md to get started!
\n
Mailspring's sync engine is spawned by the Electron application and runs locally on your computer. It is open source (GPLv3) and written in C++ and C. For convenience, however, when you set up your development environment, Mailspring uses the latest version of the sync engine we've shipped for your platform so you don't need to pull sources or install its compile-time dependencies.
\n
\n
Features
\n
Mailspring comes packed with powerful features like Unified Inbox, Snooze, Send\nLater, Mail Rules, Templates and more. Mailspring Pro, which you can unlock\nwith a monthly subscription, adds even more features for people who send a ton\nof email: link tracking, read receipts, mailbox analytics, contact and company\nprofiles. All of these features run in the client - Mailspring does not send\nyour email credentials to the cloud. For a full list of features, check out\ngetmailspring.com.
\n
Download Mailspring
\n
You can download compiled versions of Mailspring for Windows, Mac OS X, and\nLinux (deb, rpm and snap) from\nhttps://getmailspring.com/download.
\n
Getting Help
\n
You can find community-based help and discussion with other Mailspring users on our\nDiscourse community.
\n
Contributing
\n
Mailspring is entirely open-source. Pull requests and contributions are\nwelcome! There are three ways to contribute: building a plugin, building a\ntheme, and submitting pull requests to the project itself. When you're getting\nstarted, you may want to join our\nDiscourse so you can ask questions and\nlearn from other people doing development.
\n
\n
Running Mailspring from Source
\n
To install all dependencies and run Mailspring from its source code,\nrun the following commands from the root directory of the Mailspring repository:
\n
npm install\nnpm start\n
\n
You can attach command line parameters by separating them using a double hyphen:
\n
npm start -- --help\n
\n
Building Mailspring
\n
To build Mailspring, you need to run the following command from the root directory\nof the Mailspring repository:
\n
npm run-script build\n
\n
Building A Plugin
\n
Plugins lie at the heart of Mailspring and give it its powerful features.\nBuilding your own plugins allows you to integrate the app with other tools,\nexperiment with new workflows, and more. Follow the Getting Started\nguide to write your first plugin in\nfive minutes.
A plugin \"store\" like the Chrome Web Store is coming soon, and will make it\neasy for other users to discover plugins you create. (Right now, users need to\n\"sideload\" the plugins into the app by downloading them and copying them into\nplace.)
\n
You can share and browse Mailspring Plugins, and discuss plugin development\nwith other developers, on our\nDiscourse.
\n
Building a Theme
\n
The Mailspring user interface is styled using CSS, which means it's easy to\nmodify and extend. Mailspring comes stock with a few beautiful themes, and\nthere are many more which have been built by community developers. To start\ncreating a theme, clone the theme starter!
You can share and browse Mailspring Themes, and discuss theme development with other developers, on our Discourse.
\n
Localizing / Translating
\n
Mailspring (1.5.0 and above) supports localization. If you're a fluent speaker of\nanother language, we'd love your help improving translations. Check out the\nLOCALIZATION\nguide for more information. You can discuss localization and translation with\nother developers on our Discourse.
\n
Contributing to Mailspring Core
\n
Pull requests are always welcome - check out\nCONTRIBUTING\nfor more information about setting up the development environment, running\ntests locally, and submitting pull requests.
LPS Studio is an interactive storytelling tool for visualising Logic Production System (LPS) programs using the lps.js interpreter on top of using Electron and Angular frameworks.
\n
Self-contained installers of LPS Studio for various platforms are available in the Releases page.
\n
\n
Development Setup
\n
To setup for development, ensure you have Node.js and npm installed on your system. After cloning this repository, install all dependencies using:
\n
npm install\n
\n
Once all dependencies are installed, you can run an instance of LPS Studio by running the command:
\n
npm run electron:local\n
\n
If incompatible Node.js or npm version warnings show up, follow the instructions given and update your Node.js / npm as required. Angular compilation requires at least Node.js v8.9 or newer.
\n
Packaging
\n
To package LPS Studio for distribution, you will need to run one of the following commands:
\n
\n
For Windows (msi and Setup): npm run electron:windows
\n
For macOS (DMG): npm run electron:mac
\n
For Linux (AppImage and Debian): npm run electron:linux
\n
For all three paltforms: npm run electron:all
\n
\n
License
\n
LPS Studio is open source and licensed under the BSD 3-Clause. The implementation depends on the LPS runtime lps.js and several other open source . lps.js was implemented as part of Sam Yong's MSc Computer Science Individual Project and thesis at Imperial College London in 2018.
\n
Images and illustrations in this repository, otherwise explicitly stated, are made by Sam Yong and are licensed under CC BY-NC-SA 3.0.
\n
",
+ "readmeOriginal": "
LPS Studio
\n
\n\n
\n
\n
LPS Studio is an interactive storytelling tool for visualising Logic Production System (LPS) programs using the lps.js interpreter on top of using Electron and Angular frameworks.
\n
Self-contained installers of LPS Studio for various platforms are available in the Releases page.
\n
\n
Development Setup
\n
To setup for development, ensure you have Node.js and npm installed on your system. After cloning this repository, install all dependencies using:
\n
npm install\n
\n
Once all dependencies are installed, you can run an instance of LPS Studio by running the command:
\n
npm run electron:local\n
\n
If incompatible Node.js or npm version warnings show up, follow the instructions given and update your Node.js / npm as required. Angular compilation requires at least Node.js v8.9 or newer.
\n
Packaging
\n
To package LPS Studio for distribution, you will need to run one of the following commands:
\n
\n
For Windows (msi and Setup): npm run electron:windows
\n
For macOS (DMG): npm run electron:mac
\n
For Linux (AppImage and Debian): npm run electron:linux
\n
For all three paltforms: npm run electron:all
\n
\n
License
\n
LPS Studio is open source and licensed under the BSD 3-Clause. The implementation depends on the LPS runtime lps.js and several other open source . lps.js was implemented as part of Sam Yong's MSc Computer Science Individual Project and thesis at Imperial College London in 2018.
\n
Images and illustrations in this repository, otherwise explicitly stated, are made by Sam Yong and are licensed under CC BY-NC-SA 3.0.
Easily explore, view and edit markdown documentation of a file tree.
\n
Common use case
\n
If your projects documentation is written in Markdown, with md files dispersed throughout your project tree, Markdown Explorer displays md files in a tree structure, and it allows filtering by file name or by file content.
\n
Quick start
\n
Just drop a folder on the window (or click on the folder icon on top left) to show the Markdown documentation of this folder. Then, explore the tree on the left, and toggle view/edit mode on md file with the button on the top right.
\n
Features
\n
\n
md file Tree\n
\n
Show only md file in a file tree
\n
Filter\n
\n
Filter file tree by file content
\n
Filter file tree by file name
\n
Filter file tree by file path
\n
Highlight occurrences
\n
\n
\n
Ignore some folder names
\n
Tree and file content cache to speed up search/tree display
\n
Remove number and underscore from file/folder names in tree view
\n
\n
\n
md files\n
\n
View md file
\n
Add generated table of content automatically at begin of render view
\n
Edit md file
\n
Automatic save
\n
Quick md syntax help
\n
\n
\n
Navigate:\n
\n
previous/next opened md with scroll position
\n
relative reference md links
\n
\n
\n
Remember last opened tree/file
\n
Pass configuration from command line: set tree/md path to show, and folders to ignore in tree
\n
\n
Screenshots
\n
Md tree and view mode :
\n
\n
Edit mode :
\n
\n
How To Use
\n
$ git clone https://github.com/jersou/markdown-explorer\n$ cd markdown-explorer\n$ npm install\n$ npm start\n
This app is my first Electron app (except very small tests), then it's probably not a good example ;-), it's a quick dev to learn Electron and it would be necessary to refactor the code in the (near) future (but it's functional :-) ).
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
\n
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
\n
THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
\n
",
+ "readmeOriginal": "
Markdown Explorer
\n
Easily explore, view and edit markdown documentation of a file tree.
\n
Common use case
\n
If your projects documentation is written in Markdown, with md files dispersed throughout your project tree, Markdown Explorer displays md files in a tree structure, and it allows filtering by file name or by file content.
\n
Quick start
\n
Just drop a folder on the window (or click on the folder icon on top left) to show the Markdown documentation of this folder. Then, explore the tree on the left, and toggle view/edit mode on md file with the button on the top right.
\n
Features
\n
\n
md file Tree\n
\n
Show only md file in a file tree
\n
Filter\n
\n
Filter file tree by file content
\n
Filter file tree by file name
\n
Filter file tree by file path
\n
Highlight occurrences
\n
\n
\n
Ignore some folder names
\n
Tree and file content cache to speed up search/tree display
\n
Remove number and underscore from file/folder names in tree view
\n
\n
\n
md files\n
\n
View md file
\n
Add generated table of content automatically at begin of render view
\n
Edit md file
\n
Automatic save
\n
Quick md syntax help
\n
\n
\n
Navigate:\n
\n
previous/next opened md with scroll position
\n
relative reference md links
\n
\n
\n
Remember last opened tree/file
\n
Pass configuration from command line: set tree/md path to show, and folders to ignore in tree
\n
\n
Screenshots
\n
Md tree and view mode :
\n
\n
Edit mode :
\n
\n
How To Use
\n
$ git clone https://github.com/jersou/markdown-explorer\n$ cd markdown-explorer\n$ npm install\n$ npm start\n
This app is my first Electron app (except very small tests), then it's probably not a good example ;-), it's a quick dev to learn Electron and it would be necessary to refactor the code in the (near) future (but it's functional :-) ).
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
\n
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
\n
THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
To clone and run this application, you'll need Git and Node.js (which comes with npm) installed on your computer. From your command line:
\n
# Clone this repository\n$ git clone https://github.com/amitmerchant1990/electron-markdownify\n\n# Go into the repository\n$ cd electron-markdownify\n\n# Install dependencies\n$ npm install\n\n# Run the app\n$ npm start
\n
Note: If you're using Linux Bash for Windows, see this guide or use node from the command prompt.
\n
Download
\n
You can download the latest installable version of Markdownify for Windows, macOS and Linux.
\n
Emailware
\n
Markdownify is an emailware. Meaning, if you liked using this app or it has helped you in any way, I'd like you send me an email at bullredeyes@gmail.com about anything you'd want to say about this software. I'd really appreciate it!
\n
Credits
\n
This software uses the following open source packages:
To clone and run this application, you'll need Git and Node.js (which comes with npm) installed on your computer. From your command line:
\n
# Clone this repository\n$ git clone https://github.com/amitmerchant1990/electron-markdownify\n\n# Go into the repository\n$ cd electron-markdownify\n\n# Install dependencies\n$ npm install\n\n# Run the app\n$ npm start
\n
Note: If you're using Linux Bash for Windows, see this guide or use node from the command prompt.
\n
Download
\n
You can download the latest installable version of Markdownify for Windows, macOS and Linux.
\n
Emailware
\n
Markdownify is an emailware. Meaning, if you liked using this app or it has helped you in any way, I'd like you send me an email at bullredeyes@gmail.com about anything you'd want to say about this software. I'd really appreciate it!
\n
Credits
\n
This software uses the following open source packages:
Do you speak multiple languages? We need your help!
\n
If you're interested in translating Manta, please see the detailed instruction here.\nThe following languages are currently being translated, if you would like to Manta to support another language, please submit your request here.
Note that on Linux, some users might experience a GPU bug where the select options rendered as a black box, see issue #128 of Manta and issue #4322 of Electron. This can be fixed by disabling hardware acceleration like so:
\n
manta --disable-hardware-acceleration
\n
\n
Remember that doing this might lead to some degradation of the app's performance. This is why \"the fix\" is not included by default.
The main reason I decided to build this is because I need a simple tool to create good looking invoices, estimates, and receipts but couldn't find one that suits my needs. I don't do invoicing for a living but I do need it occasionally so an ideal invoicing app just needs to be good at one thing and one thing only, which is making invoices. I really don't need a full-fledged bookkeeping or accounting software.
\n
I believe there are many people such as freelance designers, developers, photographers or writers... also have such need. However, most (if not all) products I found have these these problems:
\n
Complexity
\n
\n
Most invoicing products nowadays is web-based, which means you’ll need to maintain a new account (possible a monthly fee, too) just to create an invoice.
\n
Sure, there some open-source products that can be self-hosted, but that will introduce a new layer of complexity to your workflow. Who will setup the product? Who will maintain the server? Who will cover the cost? ...
\n
You will always need internet connection to be able to create your invoices. It can be slow sometimes.
\n
\n
Privacy
\n
\n
When you use a web service, most of the time, you’re giving away your data whether you want it or not. Financial data is sensitive and I believe that no one should know about your data except yourself.
\n
\n
Goals
\n
With that in mind, I know that Manta would need to satisfy these criteria:
\n
\n
\n
🚀 Fast!!!
\n
\n
\n
👍 Friendly UI & UX
\n
\n
\n
🎉 Has nice looking templates
\n
\n
\n
🔒 Does not touch user’s data
\n
\n
\n
💰 Free! :)
\n
If you think Manta delivers these, let me know by putting a star on this project 😉
\n
\n
\n
Development
\n
It's very easy to get started with these 3 steps:
\n
\n
Clone this project to your local machine.
\n
Open terminal and cd into the cloned folder, usually cd Manta.
\n
Run yarn install to install dependencies.
\n
Run yarn dev in one tab to start webpack-dev-server.
\n
Run yarn start in another tab to open the app.
\n
\n
This is still in beta and it's far from perfect so feedbacks, issues or PRs are greatly appreciated! :)
\n
Note that on Linux you will need additional dependencies to provide the icns2png and gm commands.\nUbuntu/Debian users can run: sudo apt install -y icnsutils graphicsmagick.
\n
FAQ
\n
\n
Is this app built with Electron?
\n
\n
Yes, it's built on top of Electron. Please see the Technologies section for more info.
\n
\n
What boilerplate did you use
\n
\n
None. This is my attempt to integrate Electron with React from scratch. The idea was to get a better understanding of how things work together, especially Webpack.\nBut I do take cue from other projects.
\n
\n
What CSS/UI Framework did you use?
\n
\n
I wrote all the CSS myself. I only use Bootstrap for prototyping at first. But I gradually encapsulate most of the style to the component with the help of styled-components. There is some places still use Bootstrap mostly for layout purpose but I'll get rid of it eventually.
Why did you name the project Manta? It has nothing to do with invoicing.
\n
\n
It's actually very common to associate an animal with your brand. There's a reason behind the Twitter bird, the famous MailChimp Freddy or the Docker whale ... It's called the Baby-Face bias. You can read more about it in the book Designing for Emotion by Aaron Walter.\nIn my case, I was inspired by the movie Racing Extinction and by naming this project Manta, I hope to raise people's awareness on some environmental issues mentioned in the movie. You can read more about it here
\n
\n
I like Manta's logo, did you design it?
\n
\n
Yes, I actually did all the illustrations as well as the templates that you see in the app.
\n
\n
Are you available for hire?
\n
\n
Yes, I'm exploring new opportunities at the moment. Please let me know what you have in mind.
\n
\n
How do I contact you?
\n
\n
If you find an issue, please report it here. For everything else, please drop me a line at hi@getmanta.app
\n
Acknowledgement
\n
Special thanks to Crowdin for providing an open-source license for Manta. Feel free to check out their website for more information about this amazing localization management platform.
Do you speak multiple languages? We need your help!
\n
If you're interested in translating Manta, please see the detailed instruction here.\nThe following languages are currently being translated, if you would like to Manta to support another language, please submit your request here.
Note that on Linux, some users might experience a GPU bug where the select options rendered as a black box, see issue #128 of Manta and issue #4322 of Electron. This can be fixed by disabling hardware acceleration like so:
\n
manta --disable-hardware-acceleration
\n
\n
Remember that doing this might lead to some degradation of the app's performance. This is why \"the fix\" is not included by default.
The main reason I decided to build this is because I need a simple tool to create good looking invoices, estimates, and receipts but couldn't find one that suits my needs. I don't do invoicing for a living but I do need it occasionally so an ideal invoicing app just needs to be good at one thing and one thing only, which is making invoices. I really don't need a full-fledged bookkeeping or accounting software.
\n
I believe there are many people such as freelance designers, developers, photographers or writers... also have such need. However, most (if not all) products I found have these these problems:
\n
Complexity
\n
\n
Most invoicing products nowadays is web-based, which means you’ll need to maintain a new account (possible a monthly fee, too) just to create an invoice.
\n
Sure, there some open-source products that can be self-hosted, but that will introduce a new layer of complexity to your workflow. Who will setup the product? Who will maintain the server? Who will cover the cost? ...
\n
You will always need internet connection to be able to create your invoices. It can be slow sometimes.
\n
\n
Privacy
\n
\n
When you use a web service, most of the time, you’re giving away your data whether you want it or not. Financial data is sensitive and I believe that no one should know about your data except yourself.
\n
\n
Goals
\n
With that in mind, I know that Manta would need to satisfy these criteria:
\n
\n
\n
🚀 Fast!!!
\n
\n
\n
👍 Friendly UI & UX
\n
\n
\n
🎉 Has nice looking templates
\n
\n
\n
🔒 Does not touch user’s data
\n
\n
\n
💰 Free! :)
\n
If you think Manta delivers these, let me know by putting a star on this project 😉
\n
\n
\n
Development
\n
It's very easy to get started with these 3 steps:
\n
\n
Clone this project to your local machine.
\n
Open terminal and cd into the cloned folder, usually cd Manta.
\n
Run yarn install to install dependencies.
\n
Run yarn dev in one tab to start webpack-dev-server.
\n
Run yarn start in another tab to open the app.
\n
\n
This is still in beta and it's far from perfect so feedbacks, issues or PRs are greatly appreciated! :)
\n
Note that on Linux you will need additional dependencies to provide the icns2png and gm commands.\nUbuntu/Debian users can run: sudo apt install -y icnsutils graphicsmagick.
\n
FAQ
\n
\n
Is this app built with Electron?
\n
\n
Yes, it's built on top of Electron. Please see the Technologies section for more info.
\n
\n
What boilerplate did you use
\n
\n
None. This is my attempt to integrate Electron with React from scratch. The idea was to get a better understanding of how things work together, especially Webpack.\nBut I do take cue from other projects.
\n
\n
What CSS/UI Framework did you use?
\n
\n
I wrote all the CSS myself. I only use Bootstrap for prototyping at first. But I gradually encapsulate most of the style to the component with the help of styled-components. There is some places still use Bootstrap mostly for layout purpose but I'll get rid of it eventually.
Why did you name the project Manta? It has nothing to do with invoicing.
\n
\n
It's actually very common to associate an animal with your brand. There's a reason behind the Twitter bird, the famous MailChimp Freddy or the Docker whale ... It's called the Baby-Face bias. You can read more about it in the book Designing for Emotion by Aaron Walter.\nIn my case, I was inspired by the movie Racing Extinction and by naming this project Manta, I hope to raise people's awareness on some environmental issues mentioned in the movie. You can read more about it here
\n
\n
I like Manta's logo, did you design it?
\n
\n
Yes, I actually did all the illustrations as well as the templates that you see in the app.
\n
\n
Are you available for hire?
\n
\n
Yes, I'm exploring new opportunities at the moment. Please let me know what you have in mind.
\n
\n
How do I contact you?
\n
\n
If you find an issue, please report it here. For everything else, please drop me a line at hi@getmanta.app
\n
Acknowledgement
\n
Special thanks to Crowdin for providing an open-source license for Manta. Feel free to check out their website for more information about this amazing localization management platform.
\n 🔆 Next generation markdown editor 🌙 \n A simple and elegant open-source markdown editor that focused on speed and usability. \n Available for Linux, macOS and Windows.\n
\n This Markdown editor that could. Built with ❤︎ by\n Jocs and\n \n contributors\n \n \n
\n \n
Supporting Mark Text
\n
Mark Text is an MIT licensed open source project, and the latest version will always be downloadable for free from the GitHub release page. Mark Text is still in development, and its development is inseparable from all sponsors. I hope you join them:
What's the difference between Patreon and Open Collective?
\n
Patreon: Funds will be directly sponsored to Luo Ran (@jocs) who created Mark Text and continues to maintain it.\nOpen Collective: All expenses are transparent. The funds will be used for the development and maintenance of Mark Text, funding online and offline activities, and acquiring other necessary resources.\nNames and company logos of all sponsors (from both Patreon and Open Collective) will appear on the official website for Mark Text and in its README.md file.
Markdown extensions such as math expressions (KaTeX), front matter and emojis.
\n
Support paragraphs and inline style shortcuts to improve your writing efficiency.
\n
Output HTML and PDF files.
\n
Various themes: Cadmium Light, Material Dark etc.
\n
Various editing modes: Source Code mode, Typewriter mode, Focus mode.
\n
Paste images directly from clipboard
\n
\n
🌙themes🔆
\n
\n\n
\n
Cadmium Light
\n
Dark
\n
\n\n\n
\n
\n
\n
\n
\n
Graphite Light
\n
Material Dark
\n
\n
\n
\n
\n
\n
\n
Ulysses Light
\n
One Dark
\n
\n
\n
\n
\n
\n\n
\n
😸Edit modes🐶
\n
\n\n
\n
Source Code
\n
Typewriter
\n
Focus
\n
\n\n\n
\n
\n
\n
\n
\n\n
\n
Why write another editor?
\n\n
I love writing. I have used a lot of markdown editors, yet there is still not an editor that can fully meet my needs. I don't like to be disturbed when I write by some unbearable bug. Mark Text uses virtual DOM to render pages which has the added benefits of being highly efficient and being open source. That way anyone who loves markdown and writing can use Mark Text.
\n
As mentioned above, Mark Text is completely free and open source and will be open source forever. We hope that all markdown lovers will contribute their own code and help develop Mark Text into a popular markdown editor.
\n
There are many markdown editors and all have their own merits, some have features which others don't. It's difficult to satisfy each markdown users' needs but we hope Mark Text will be able to satisfy each markdown user as much as possible. Although the latest Mark Text is still not perfect, we will try to make it as best as we possibly can.
\n\n
Download and Installation
\n
\n
\n\n
\n
\n
\n
\n
\n\n\n
\n
\n
\n
\n
\n\n
\n
Want to see new features of the latest version? Please refer to CHANGELOG.
\n
macOS
\n
You can either download the latest marktext-%version%.dmg from the release page or install Mark Text using homebrew cask. To use Homebrew-Cask you just need to have Homebrew installed.
\n
brew install --cask mark-text
\n
Windows
\n
Simply download and install Mark Text via setup wizard (marktext-setup-%version%.exe) and choose whether to install per-user or machine wide.
\n
Alternatively, install Mark Text using Chocolatey. To use Chocolatey you need to have Chocolatey installed.
All binaries for Linux, macOS and Windows can be downloaded from the release page. If a version is unavailable for your system, then please open an issue.
\n
Development
\n
If you wish to build Mark Text yourself, please check out our build instructions.
If you have any questions regarding Mark Text, you are welcome to write an issue. When doing so please use the default format found when opening an issue. Of course, if you submit a PR directly, it will be greatly appreciated.
\n
Integrations
\n
\n
Alfred Workflow: A Workflow for the macOS app Alfred: Use \"mt\" to open files/folder with Mark Text.
\n
\n
Contribution
\n
Mark Text is in full development, please make sure to read the Contributing Guide before making a pull request. Want to add some features to Mark Text? Refer to our roadmap and open issues.
\n
Contributors
\n
Thank you to all the people who have already contributed to Mark Text[contributors]
\n
Special thanks to @Yasujizr who designed the Mark Text logo.
\n 🔆 Next generation markdown editor 🌙 \n A simple and elegant open-source markdown editor that focused on speed and usability. \n Available for Linux, macOS and Windows.\n
\n This Markdown editor that could. Built with ❤︎ by\n Jocs and\n \n contributors\n \n \n
\n \n
Supporting Mark Text
\n
Mark Text is an MIT licensed open source project, and the latest version will always be downloadable for free from the GitHub release page. Mark Text is still in development, and its development is inseparable from all sponsors. I hope you join them:
What's the difference between Patreon and Open Collective?
\n
Patreon: Funds will be directly sponsored to Luo Ran (@jocs) who created Mark Text and continues to maintain it.\nOpen Collective: All expenses are transparent. The funds will be used for the development and maintenance of Mark Text, funding online and offline activities, and acquiring other necessary resources.\nNames and company logos of all sponsors (from both Patreon and Open Collective) will appear on the official website for Mark Text and in its README.md file.
Markdown extensions such as math expressions (KaTeX), front matter and emojis.
\n
Support paragraphs and inline style shortcuts to improve your writing efficiency.
\n
Output HTML and PDF files.
\n
Various themes: Cadmium Light, Material Dark etc.
\n
Various editing modes: Source Code mode, Typewriter mode, Focus mode.
\n
Paste images directly from clipboard
\n
\n
🌙themes🔆
\n
\n\n
\n
Cadmium Light
\n
Dark
\n
\n\n\n
\n
\n
\n
\n
\n
Graphite Light
\n
Material Dark
\n
\n
\n
\n
\n
\n
\n
Ulysses Light
\n
One Dark
\n
\n
\n
\n
\n
\n\n
\n
😸Edit modes🐶
\n
\n\n
\n
Source Code
\n
Typewriter
\n
Focus
\n
\n\n\n
\n
\n
\n
\n
\n\n
\n
Why write another editor?
\n\n
I love writing. I have used a lot of markdown editors, yet there is still not an editor that can fully meet my needs. I don't like to be disturbed when I write by some unbearable bug. Mark Text uses virtual DOM to render pages which has the added benefits of being highly efficient and being open source. That way anyone who loves markdown and writing can use Mark Text.
\n
As mentioned above, Mark Text is completely free and open source and will be open source forever. We hope that all markdown lovers will contribute their own code and help develop Mark Text into a popular markdown editor.
\n
There are many markdown editors and all have their own merits, some have features which others don't. It's difficult to satisfy each markdown users' needs but we hope Mark Text will be able to satisfy each markdown user as much as possible. Although the latest Mark Text is still not perfect, we will try to make it as best as we possibly can.
\n\n
Download and Installation
\n
\n
\n\n
\n
\n
\n
\n
\n\n\n
\n
\n
\n
\n
\n\n
\n
Want to see new features of the latest version? Please refer to CHANGELOG.
\n
macOS
\n
You can either download the latest marktext-%version%.dmg from the release page or install Mark Text using homebrew cask. To use Homebrew-Cask you just need to have Homebrew installed.
\n
brew install --cask mark-text
\n
Windows
\n
Simply download and install Mark Text via setup wizard (marktext-setup-%version%.exe) and choose whether to install per-user or machine wide.
\n
Alternatively, install Mark Text using Chocolatey. To use Chocolatey you need to have Chocolatey installed.
All binaries for Linux, macOS and Windows can be downloaded from the release page. If a version is unavailable for your system, then please open an issue.
\n
Development
\n
If you wish to build Mark Text yourself, please check out our build instructions.
If you have any questions regarding Mark Text, you are welcome to write an issue. When doing so please use the default format found when opening an issue. Of course, if you submit a PR directly, it will be greatly appreciated.
\n
Integrations
\n
\n
Alfred Workflow: A Workflow for the macOS app Alfred: Use \"mt\" to open files/folder with Mark Text.
\n
\n
Contribution
\n
Mark Text is in full development, please make sure to read the Contributing Guide before making a pull request. Want to add some features to Mark Text? Refer to our roadmap and open issues.
\n
Contributors
\n
Thank you to all the people who have already contributed to Mark Text[contributors]
\n
Special thanks to @Yasujizr who designed the Mark Text logo.
On the first launch, please input name and URL for your Mattermost server. For example, myserver : https://mattermost.example.com.
\n\n
Quit
\n
Ctrl or Command + Q to quit.
\n
Configuration
\n
You can show the dialog from menu bar.
\n
Configuration will be saved into Electron's userData directory:
\n
\n
%APPDATA%\\Mattermost on Windows
\n
~/Library/Application Support/Mattermost on OS X
\n
~/.config/Mattermost on Linux
\n
\n
A custom data directory location can be specified with:
\n
\n
Mattermost.exe --args --data-dir C:\\my-mattermost-data on Windows
\n
open /Applications/Mattermost.app/ --args --data-dir ~/my-mattermost-data/ on macOS
\n
./mattermost-desktop --args --data-dir ~/my-mattermost-data/ on Linux
\n
\n
When you upgrade from electron-mattermost, please copy config.json from electron-mattermost.\nOtherwise, you have to configure again.
\n
Proxy
\n
Normally, the application will follow your system settings to use a proxy, or you can set up a proxy by the following command line options.
\n
\n
--proxy-server=<SERVER>:<PORT>
\n
--proxy-pac-url=<URL>
\n
\n
On Windows, please make sure to add -- before options. For example, Mattermost.exe -- --proxy-server=....
\n
Custom App Deployments
\n
Our docs provide a guide on how to customize and distribute your own Mattermost Desktop App, including how to distribute the official Windows Desktop App silently to end users, pre-configured with the server URL and other app settings.
On the first launch, please input name and URL for your Mattermost server. For example, myserver : https://mattermost.example.com.
\n\n
Quit
\n
Ctrl or Command + Q to quit.
\n
Configuration
\n
You can show the dialog from menu bar.
\n
Configuration will be saved into Electron's userData directory:
\n
\n
%APPDATA%\\Mattermost on Windows
\n
~/Library/Application Support/Mattermost on OS X
\n
~/.config/Mattermost on Linux
\n
\n
A custom data directory location can be specified with:
\n
\n
Mattermost.exe --args --data-dir C:\\my-mattermost-data on Windows
\n
open /Applications/Mattermost.app/ --args --data-dir ~/my-mattermost-data/ on macOS
\n
./mattermost-desktop --args --data-dir ~/my-mattermost-data/ on Linux
\n
\n
When you upgrade from electron-mattermost, please copy config.json from electron-mattermost.\nOtherwise, you have to configure again.
\n
Proxy
\n
Normally, the application will follow your system settings to use a proxy, or you can set up a proxy by the following command line options.
\n
\n
--proxy-server=<SERVER>:<PORT>
\n
--proxy-pac-url=<URL>
\n
\n
On Windows, please make sure to add -- before options. For example, Mattermost.exe -- --proxy-server=....
\n
Custom App Deployments
\n
Our docs provide a guide on how to customize and distribute your own Mattermost Desktop App, including how to distribute the official Windows Desktop App silently to end users, pre-configured with the server URL and other app settings.
massCode is open source project and completely free to use.
\n
However, the amount of effort needed to maintain and develop new features for the project is not sustainable without proper financial backing. You can support massCode development via the following methods:
\n
\n
\n\n\n
\n
\n
Overview
\n
The goal of creating this application was mostly my own growth as a developer. Also, I wanted this project to absorb the best of such applications already on the market (both free and paid). At the same time, I wanted this project to be an open source project.
\n
massCode allows you to organize snippets using multi-level folders as well as tags. Each snippet has fragments - tabs, which gives even greater level of organization
\n
A snippets manager must not only provide organization of snippets but also have a good code editor. That's why under the hood of massCode there's Monaco editor. Monaco is a modern code editor from Microsoft which is used in one of the most popular editor VS Code. The editor provides IntelliSense, validation for TypeScript, JavaScript, CSS, LESS, SCSS, JSON, HTML. It's also added a super productive Emmet and Prettier to code formatter.
\n
Development
\n
# install dependencies\nyarn\n# serve with hot reload\nyarn dev
massCode is open source project and completely free to use.
\n
However, the amount of effort needed to maintain and develop new features for the project is not sustainable without proper financial backing. You can support massCode development via the following methods:
\n
\n
\n\n\n
\n
\n
Overview
\n
The goal of creating this application was mostly my own growth as a developer. Also, I wanted this project to absorb the best of such applications already on the market (both free and paid). At the same time, I wanted this project to be an open source project.
\n
massCode allows you to organize snippets using multi-level folders as well as tags. Each snippet has fragments - tabs, which gives even greater level of organization
\n
A snippets manager must not only provide organization of snippets but also have a good code editor. That's why under the hood of massCode there's Monaco editor. Monaco is a modern code editor from Microsoft which is used in one of the most popular editor VS Code. The editor provides IntelliSense, validation for TypeScript, JavaScript, CSS, LESS, SCSS, JSON, HTML. It's also added a super productive Emmet and Prettier to code formatter.
\n
Development
\n
# install dependencies\nyarn\n# serve with hot reload\nyarn dev
http://mdyna.dev/\nContributions, issues and feature requests are welcome! \nFeel free to check our community page issues page. \nYou can also open an issue via Github issues
http://mdyna.dev/\nContributions, issues and feature requests are welcome! \nFeel free to check our community page issues page. \nYou can also open an issue via Github issues
Media Mate is a media centre, along the lines of Plex, with the features of Sonarr, downloading and organising your media in a good looking way. Media Mate also allows you to automatically download the shows that you want to watch, thanks to ShowRSS.
\n
Whats it look like then?
\n
Homepage
\n
\n
Downloader
\n
\n
Viewer
\n
\n
Streamer
\n
\n
Tutorial
\n
\n
Disclaimer
\n
Media Mate (and its team) am not responsible for anything that is done with Media Mate. Media Mate recommends viewing the free media below.
Media Mate is a media centre, along the lines of Plex, with the features of Sonarr, downloading and organising your media in a good looking way. Media Mate also allows you to automatically download the shows that you want to watch, thanks to ShowRSS.
\n
Whats it look like then?
\n
Homepage
\n
\n
Downloader
\n
\n
Viewer
\n
\n
Streamer
\n
\n
Tutorial
\n
\n
Disclaimer
\n
Media Mate (and its team) am not responsible for anything that is done with Media Mate. Media Mate recommends viewing the free media below.
Mercury offer basic budget planner functionality, such as managing account, add / edit / delete operation... I always wanted a tool as MSMoney or HomeBank, but with improved and modern UI. HomeBank was the software I used to use, and many features come from there. \nThis application is built on top of Electron
\n
Developped with ♥ for you
\n
Supported languages : English,Français \nSend an e-mail if you want to help to translate in your language!
\n\n
Previews
\n
\n\n
\n
Dark UI (default)
\n
White UI
\n
\n\n\n
\n
\n
\n
\n
\n
\n
\n
\n\n
\n
Features
\n
\n
Create or delete any account
\n
Create / Edit / Delete any operation
\n
Create / Edit / Delete recurring operation
\n
Filter operation with easy-to-access basic filters
\n
Manage your outcome with reports over time / categories
\n
Manage beneficiaries and categories in the settings
Clone the GitHub repository. You need Node.js and npm installed on your system. Go to terminal:
\n
# Clone the repository\n$ git clone https://github.com/Delni/mercury.git\n\n# Go to directory\n$ cd mercury\n\n# Install dependencies\n$ yarn\n\n# Start the app\n$ yarn run dev\n
Linux coming soon (as soon as tested) \nNot available at the moment.
\n
Contribute
\n
If the application has any kind of bugs, feel free to open an issue. We will look into it & come up with a solution. Create a new pull request if you have fixed any kind of bugs.
\n
The request would be merged if it fixes the bug & does not disturb the whole application in any way.
\n
⚠️ Huge change ahead
\n
The current work is to migrate Mercury from a JQuery-based interface to Vue.js for better scalability, maintainability, testing, etc. If you have already worked or forked this repo, find v1 under the branch legacy/v1
MIT License\n\nCopyright (c) 2018 Nicolas Delauney\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n
\n
",
+ "readmeOriginal": "
\n
Mercury
\n
\n
Current version packed : v1.1.2 \nThe budget planner of the 21st century
\n
🚧 Please be aware that Mercury is in constant development, you may encounter unknown bug 🚧
Mercury offer basic budget planner functionality, such as managing account, add / edit / delete operation... I always wanted a tool as MSMoney or HomeBank, but with improved and modern UI. HomeBank was the software I used to use, and many features come from there. \nThis application is built on top of Electron
\n
Developped with ♥ for you
\n
Supported languages : English,Français \nSend an e-mail if you want to help to translate in your language!
\n\n
Previews
\n
\n\n
\n
Dark UI (default)
\n
White UI
\n
\n\n\n
\n
\n
\n
\n
\n
\n
\n
\n\n
\n
Features
\n
\n
Create or delete any account
\n
Create / Edit / Delete any operation
\n
Create / Edit / Delete recurring operation
\n
Filter operation with easy-to-access basic filters
\n
Manage your outcome with reports over time / categories
\n
Manage beneficiaries and categories in the settings
Clone the GitHub repository. You need Node.js and npm installed on your system. Go to terminal:
\n
# Clone the repository\n$ git clone https://github.com/Delni/mercury.git\n\n# Go to directory\n$ cd mercury\n\n# Install dependencies\n$ yarn\n\n# Start the app\n$ yarn run dev\n
Linux coming soon (as soon as tested) \nNot available at the moment.
\n
Contribute
\n
If the application has any kind of bugs, feel free to open an issue. We will look into it & come up with a solution. Create a new pull request if you have fixed any kind of bugs.
\n
The request would be merged if it fixes the bug & does not disturb the whole application in any way.
\n
⚠️ Huge change ahead
\n
The current work is to migrate Mercury from a JQuery-based interface to Vue.js for better scalability, maintainability, testing, etc. If you have already worked or forked this repo, find v1 under the branch legacy/v1
MIT License\n\nCopyright (c) 2018 Nicolas Delauney\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n
You will find other installers on the releases page.
\n
Please note that AppImage Snap and NSIS installer will automatically update to the latest available version.
\n
If you run Mélodie from a zip or using DMG/Windows portable version, you will have to download updates by yourself.
\n
Note for Windows users
\n
Windows installers are not signed.
\n
When you will run the .exe files, Windows will warn you that the source is insecure (it is not!).\n
\n
It is possible to bypass the warning by clicking on the \"More information\" link, then on the Install button\n
\n
If you install the app through the Windows App Store, you'll get no warning, since the store team reviewed and approved it.
\n
Note for MacOS users
\n
DMG image is not signed.
\n
After you will have downloaded the .dmg file, open it and drag the Mélodie icon to the Application Icon.\nThen, MacOS will prevent you from opening Mélodie as I haven't paid for an app deployment certificate.
\n
Once you will have closed the annoying warning, open you Security panel in settings, and go to General tab.\nThere, you should see the list of recently blocked application: Mélodie should be there.
Media service › triggerAlbumsEnrichment › retries album with no cover but at least one restriced provided\nIs a 1ms difference in expected processedEpoch
\n
\n
\n
AddToPlaylist component › given some playlists › saves new playlist with all tracks\nThe dropdown menu is still visible (probably because of the animation)
\n
\n
\n
snackbars store > showSnack > uses the specified duration when enqueuing slacks
The Media test do not pass on Windows: nock is not giving recorded bodies
\n
\n\n
Data
\n
Mélodie is using SQLite3 to store settings, playlists and tracks's metadatas.\nSQLite3 stores everything in a single file, named db.sqlite3 and located into the application userData folder.
\n
Mélodie also stores artists artwork according to the ARTWORK_DESTINATION environment variable, sets to user's pictures folder in melodie-media folder.
\n
Configuring logs
\n
Log are written to a file, which location is set by LOG_DESTINATION env variable.\nMélodie Desktop sets LOG_DESTINATION to logs.txt in the application logs path.
\n
Log levels are configured in a file defined by LOG_LEVEL_FILE env variable.\nMélodie Desktop sets it to .levels in the application userData folder.
\n
Its syntax is:
\n
# this is a comment\nlogger-name=level\nwildcard*=level
\n
logger names are:
\n
\n
\n
core
\n
\n
\n
renderer
\n
\n
\n
updater
\n
\n
\n
services/ where is tracks, playlists, media, settings
\n
\n
\n
providers/ where is local, audiodb, discogs
\n
\n
\n
models/ where is tracks, albums, artists, playlists, settings
\n
\n
\n
and levels are (in order): trace (most verbose), debug, info, warn, error, fatal, silent (no logs)
\n
Wildcards can be at the beginning *tracks or the end models/*.\nIn case a logger name is matching several directives, the first always wins.
\n
You can edit the file, and trigger logger level refresh by sending SIGUSR2 to the application: kill -USR2 {pid} (first log issued contains pid)
\n
Running locally
\n
npm i -g lerna\ngit clone git@github.com:feugy/melodie.git\ncd melodie\nlerna bootstrap
\n
Testing
\n
The test suite works fine Linux, MacOS and Windows.
\n
Please not that got requires node 14.9+ on Windows.
\n
Core services network mocks (nocks)
\n
Some services are hitting external APIs, such as AudioDB.\nAs we don't want to flood them with test requests, these are using network mocks.
\n
To use real services, run your tests with REAL_NETWORK environment variables (whatever its value).\nWhen using real services, update the mocks by defining UPDATE_NOCKS environment variables (whatever its value).\nNocks will stay unchanged on test failure.
\n
Some providers need access keys during tests. Just make a .env file in the root folder, with the appropriate values:
\n
DISCOGS_TOKEN=XYZ\nAUDIODB_KEY=1\n
\n
Trying snaps out
\n
Working with snaps locally isn't really easy.
\n\n
\n
install the real app from the store:
\n
snap install melodie
\n
\n
\n
then package your app in debug mode, to access the unpacked snap:
\n
DEBUG=electron-builder npm run release:artifacts --prefix apps/desktop -- -l
\n
\n
\n
copy missing files to the unpacked snap, and keep your latest changes:
npm run release:artifacts --prefix apps/desktop -- -l
\n
\n
\n
Lint your AppImage:
\n
appimagelint dist/Mélodie.AppImage
\n
\n
\n
Double click on ./dist/Mélodie.AppImage and integrate it to your system.\nPlease check that the app starts, it can access to local files, its name and icon are correct in the launcher
\n
\n\n
Releasing
\n
Release process is fairly automated: it will generate changelog, bump version, and build melodie for different platform, creating several artifacts which are either packages (snap, AppImage, Nsis, appx) or plain files (zip).
\n
Theses artifacts will be either published on their respective store (snapcraft, Windows App store...) or uploaded to github as a release.\nOnce a Github release is published, users who installed an auto-updatable package (snap, AppImage, Nsis, appx) will get the new version auto-magically.
\n
Windows App store release can not be automated: Github CI will build the appx package, but it must be manually submitted to the Windows App store.
\n\n
\n
When ready, bump the version on local machine:
\n
npm run release:bump --prefix apps/desktop
\n
\n
\n
Don't forget to update snapshots: the presentation site test depend on the version number.
\n
npm t --prefix apps/site -- --clearCache\nnpm t --prefix apps/site -- -u\ngit commit -a --amend --no-edit\nTAG=$(git describe --tags)\ngit tag -f $TAG
\n
You shoud see 2 snapshots updated
\n
\n
\n
Then push tags to github, as it'll trigger the artifact creation:
\n
git push --follow-tags
\n
\n
\n
Finally, go to github releases, and edit the newest one:
\n\n
\n
give it a code name
\n
\n
\n
copy the latest section of the changelog in the release body
\n
\n
\n
save it as draft
\n
\n
\n
Wait until the artifacts are published on your draft
Started with a search engine (FlexSearch) to store tracks, and serialized JS lists for albums & artists.\nAltough very performant (50s to index the whole music library), the memory footprint is heavy (700Mo) since\nFlexSearch is loading entire indices in memory
\n
\n
\n
Moved to sqlite3 denormalized tables (drawback: no streaming supported)
\n
\n
\n
Dropped the idea to query tracks of a given albums/artists/genre/playlist by using SQL queries.\nSqlite has a very poor json support, compared to Postgres. There is only one way to query json field: json_extract.\nIt is possible to create indexes on expressions, and this makes retrieving tracks of a given album very efficient:
\n
create index track_album on tracks (trim(lower(json_extract(tags, '$.album'))))\nselect id, tags from tracks where trim(lower(json_extract(tags, '$.album'))) = lower('Le grand bleu')\n
\n
However, it doesn't work on artists or genres, because they are modeled with arrays, and operator used do not leverage any index:
\n
select id, tags from tracks where instr(lower(json_extract(tags, '$.artists')), 'eric serra')\nselect id, tags from tracks where json_extract(tags, '$.artists') like '%eric serra%'\n
\n
\n
\n
chokidar is the best of breed watch tool, but has this annoying linux-only big when moving folders outside of the watched paths\nWatchman is a C program that'll be hard to bundle.\nnode-watch does not send file event when removing/renaming folders\nwatchr API seems overly complex\nwatch-pack is using chokidar and the next version isn't ready
\n
\n
\n
wiring jest, storybook, svelte and tailwind was really painfull. Too many configuration files now :(\nTo make storyshots working, I had to downgrade Jest because of an annoying bug (reference).
\n
\n
\n
I considered Sapper for its nice conventional router, but given all the unsued feature (service workers, SSR) I chose a simpler router.\nIt is based on hash handling, as electron urls are using file:// protocol which makes it difficult to use with history-based routers.
\n
\n
\n
Initially, albums & artists id where hash of their names. It was very convenient to keep a list of artist's albums just by storing album names in artist's linked array. UI would infer ids by applying the same hash.\nHowever, it is common to see albums with same name from different artists (like \"Greatest hits\").\nTo mitigate this issue, I had to make album's id out of album name and album artist (when defined). This ruined the hash convention, and I had to replace all \"links\" by proper references (id + name). Now UI does not infer ids anymore.
\n
\n
\n
For system notifications, document.hidden and visibilityChange are too weak because they only notice when the app is minimized/restored
\n
\n
\n
System notification was tricky: HTML5 Notification API doesn't support actions, except from service workers.\nUsing service workers was overkill, and didn't work in the end.\nElectron's native notificaiton does not support actions either.\nUsing node-notifier was a viable possibility, but doesn't support actions in a portable fashion (notify-send on linux doesn't support it).\nFinally back to HTML5 notification API, without actions :(
\n
\n
\n
The discovery of mediaSession's metadata and handler was completely random. It's only supported by Chrome (hopefully for me!), and can be seen on Deezer, Spotify or Youtube Music. However, it does not display artworks.
\n
\n
\n
IntersectionObserver does not call the intersection entry when the position inside viewport is changing but the intersection doesn't.\nAs a result, dropdown in the sheet will enter viewport during sheet animation, causing troubles positioning the menu
\n
\n
\n
AC/DC was displayed as 2 different artists ('AC' and 'DC'). This is an issue with ID3 tags: version 2.3 uses / as a separators for artists.\nOveritting mp3 tags with 2.4 solved the issue
\n
\n
\n
Snap packaging was hairy to figure out. It is clearly the best option on Linux, as it has great desktop integration (which AppImage lacks) and a renowed app store. However, getting the MediaMetadata to work with snap confinement took two days of try-and-fail research. The full journey is available in this PR on electron-builnder. Besides, the way snapd is creating different folders for each new version forced me to move artist albums outside of electron's data folders: snapd ensure that files are copied from old to new version, but can not update the media full paths store inside SQLite DB.
\n
\n
\n
MacOS builder was constantly failing with the same error: 7zip couldn't find any file to compress in the final archive. It turns out it is because the production name as an accent (Mélodie), and the mac flavor of 7zip can not handle it...
\n
\n
\n
Chokidar has a \"limitation\" and triggers for each renamed or moved file an 'unlink' and an 'add' event. The implication on Mélodie were high: moved/renamed files would disappear from playlists. Ty bypass the issue, Mélodie stores file inodes and buffer chokidar events: when a file is removed, Mélodie will wait 250ms more, and if another file is added with the same inode during that time, will consider it as a rename/move.
\n
\n
\n
The mono-repo endeavour. My goal was to split code in various reusable packages: a UI and core that would not depend on Electron, and could be used in both Web and Desktop context, and two apps: an Electron-based desktop application and the Github-page site. As developer I would expect the ability to hoist as many modules
\n
\n
runing jest with pnpm does not work at all.
\n
lerna is a pain when it comes to hoisting deps.
\n
svelte-jester and preprocess absolutely don't work with yarn@2
\n
yarn@1 works fine but brings very little commands (just a little more than npm@7)
\n
npm@7 must install peer deps in legacy mode and does not offer any sugar for multi-package commands. All deps must be manually added to package.json, because install command MUST be run at root level\nElectron-builder does not like monorepo either: author, description and other metadata must be copied from root package.json to apps/desktop/package.json. The Electron version must be fixed because node_modules are hoisted. The package.json name MUST be melodie :(\nCaveats: always run npm i --legacy-peer-deps AT ROOT level. Running npm or npx command inside packages would re-create node_modules\nEnsuring the same version in all packages and dependencies similarities must be done manually
\n
\n
\n
\n
svelte-spa-router, and its dependency on regexparam, has been bother me for a very long time. When ran with jest, svelte-spa-router files must be transpiled by Svelte compiler, but they import regexparam as esm, and this lib doesn't expose such binding. One must replace the import with require, and this must only be done during test, because rollup will handle it properly.\nWhen receiving errors from svelte-jester, don't forget to clean jest cache with --cleanCache CLI option.
\n
\n
\n
How watch & diff works
\n
\n
\n
on app load, trigger diff
\n\n
\n
get followed folders from store
\n
\n
\n
crawl followed folders, return array of paths + hashs + last changed
\n
\n
\n
get array of tracks with hash + last changed from DB
\n
\n
\n
compare to find new & changed hashes
\n\n
\n
enrich with tags & media
\n
\n
\n
save
\n
\n\n
\n
\n
compare to isolate deleted hashes
\n\n
remove corresponding tracks
\n\n
\n\n
\n
\n
while app is running
\n\n
\n
watch new & changed paths
\n\n
\n
compute hash, enrich with tags & media
\n
\n
\n
save
\n
\n\n
\n
\n
watch deleted paths
\n\n
\n
compute hash
\n
\n
\n
remove corresponding tracks
\n
\n\n
\n\n
\n
\n
when adding new followed folder
\n\n
\n
save in store
\n
\n
\n
crawl new folder, return array of paths
\n
\n
\n
compute hash, enrich with tags & media
\n
\n
\n
save
\n
\n\n
\n
\n
How missing artworks/covers retrieval works
\n
\n
\n
on UI demand trigger process
\n\n
\n
push all artists/albums without artwork/cover, and not process since N in a queue
You will find other installers on the releases page.
\n
Please note that AppImage Snap and NSIS installer will automatically update to the latest available version.
\n
If you run Mélodie from a zip or using DMG/Windows portable version, you will have to download updates by yourself.
\n
Note for Windows users
\n
Windows installers are not signed.
\n
When you will run the .exe files, Windows will warn you that the source is insecure (it is not!).\n
\n
It is possible to bypass the warning by clicking on the \"More information\" link, then on the Install button\n
\n
If you install the app through the Windows App Store, you'll get no warning, since the store team reviewed and approved it.
\n
Note for MacOS users
\n
DMG image is not signed.
\n
After you will have downloaded the .dmg file, open it and drag the Mélodie icon to the Application Icon.\nThen, MacOS will prevent you from opening Mélodie as I haven't paid for an app deployment certificate.
\n
Once you will have closed the annoying warning, open you Security panel in settings, and go to General tab.\nThere, you should see the list of recently blocked application: Mélodie should be there.
Media service › triggerAlbumsEnrichment › retries album with no cover but at least one restriced provided\nIs a 1ms difference in expected processedEpoch
\n
\n
\n
AddToPlaylist component › given some playlists › saves new playlist with all tracks\nThe dropdown menu is still visible (probably because of the animation)
\n
\n
\n
snackbars store > showSnack > uses the specified duration when enqueuing slacks
The Media test do not pass on Windows: nock is not giving recorded bodies
\n
\n\n
Data
\n
Mélodie is using SQLite3 to store settings, playlists and tracks's metadatas.\nSQLite3 stores everything in a single file, named db.sqlite3 and located into the application userData folder.
\n
Mélodie also stores artists artwork according to the ARTWORK_DESTINATION environment variable, sets to user's pictures folder in melodie-media folder.
\n
Configuring logs
\n
Log are written to a file, which location is set by LOG_DESTINATION env variable.\nMélodie Desktop sets LOG_DESTINATION to logs.txt in the application logs path.
\n
Log levels are configured in a file defined by LOG_LEVEL_FILE env variable.\nMélodie Desktop sets it to .levels in the application userData folder.
\n
Its syntax is:
\n
# this is a comment\nlogger-name=level\nwildcard*=level
\n
logger names are:
\n
\n
\n
core
\n
\n
\n
renderer
\n
\n
\n
updater
\n
\n
\n
services/ where is tracks, playlists, media, settings
\n
\n
\n
providers/ where is local, audiodb, discogs
\n
\n
\n
models/ where is tracks, albums, artists, playlists, settings
\n
\n
\n
and levels are (in order): trace (most verbose), debug, info, warn, error, fatal, silent (no logs)
\n
Wildcards can be at the beginning *tracks or the end models/*.\nIn case a logger name is matching several directives, the first always wins.
\n
You can edit the file, and trigger logger level refresh by sending SIGUSR2 to the application: kill -USR2 {pid} (first log issued contains pid)
\n
Running locally
\n
npm i -g lerna\ngit clone git@github.com:feugy/melodie.git\ncd melodie\nlerna bootstrap
\n
Testing
\n
The test suite works fine Linux, MacOS and Windows.
\n
Please not that got requires node 14.9+ on Windows.
\n
Core services network mocks (nocks)
\n
Some services are hitting external APIs, such as AudioDB.\nAs we don't want to flood them with test requests, these are using network mocks.
\n
To use real services, run your tests with REAL_NETWORK environment variables (whatever its value).\nWhen using real services, update the mocks by defining UPDATE_NOCKS environment variables (whatever its value).\nNocks will stay unchanged on test failure.
\n
Some providers need access keys during tests. Just make a .env file in the root folder, with the appropriate values:
\n
DISCOGS_TOKEN=XYZ\nAUDIODB_KEY=1\n
\n
Trying snaps out
\n
Working with snaps locally isn't really easy.
\n\n
\n
install the real app from the store:
\n
snap install melodie
\n
\n
\n
then package your app in debug mode, to access the unpacked snap:
\n
DEBUG=electron-builder npm run release:artifacts --prefix apps/desktop -- -l
\n
\n
\n
copy missing files to the unpacked snap, and keep your latest changes:
npm run release:artifacts --prefix apps/desktop -- -l
\n
\n
\n
Lint your AppImage:
\n
appimagelint dist/Mélodie.AppImage
\n
\n
\n
Double click on ./dist/Mélodie.AppImage and integrate it to your system.\nPlease check that the app starts, it can access to local files, its name and icon are correct in the launcher
\n
\n\n
Releasing
\n
Release process is fairly automated: it will generate changelog, bump version, and build melodie for different platform, creating several artifacts which are either packages (snap, AppImage, Nsis, appx) or plain files (zip).
\n
Theses artifacts will be either published on their respective store (snapcraft, Windows App store...) or uploaded to github as a release.\nOnce a Github release is published, users who installed an auto-updatable package (snap, AppImage, Nsis, appx) will get the new version auto-magically.
\n
Windows App store release can not be automated: Github CI will build the appx package, but it must be manually submitted to the Windows App store.
\n\n
\n
When ready, bump the version on local machine:
\n
npm run release:bump --prefix apps/desktop
\n
\n
\n
Don't forget to update snapshots: the presentation site test depend on the version number.
\n
npm t --prefix apps/site -- --clearCache\nnpm t --prefix apps/site -- -u\ngit commit -a --amend --no-edit\nTAG=$(git describe --tags)\ngit tag -f $TAG
\n
You shoud see 2 snapshots updated
\n
\n
\n
Then push tags to github, as it'll trigger the artifact creation:
\n
git push --follow-tags
\n
\n
\n
Finally, go to github releases, and edit the newest one:
\n\n
\n
give it a code name
\n
\n
\n
copy the latest section of the changelog in the release body
\n
\n
\n
save it as draft
\n
\n
\n
Wait until the artifacts are published on your draft
Started with a search engine (FlexSearch) to store tracks, and serialized JS lists for albums & artists.\nAltough very performant (50s to index the whole music library), the memory footprint is heavy (700Mo) since\nFlexSearch is loading entire indices in memory
\n
\n
\n
Moved to sqlite3 denormalized tables (drawback: no streaming supported)
\n
\n
\n
Dropped the idea to query tracks of a given albums/artists/genre/playlist by using SQL queries.\nSqlite has a very poor json support, compared to Postgres. There is only one way to query json field: json_extract.\nIt is possible to create indexes on expressions, and this makes retrieving tracks of a given album very efficient:
\n
create index track_album on tracks (trim(lower(json_extract(tags, '$.album'))))\nselect id, tags from tracks where trim(lower(json_extract(tags, '$.album'))) = lower('Le grand bleu')\n
\n
However, it doesn't work on artists or genres, because they are modeled with arrays, and operator used do not leverage any index:
\n
select id, tags from tracks where instr(lower(json_extract(tags, '$.artists')), 'eric serra')\nselect id, tags from tracks where json_extract(tags, '$.artists') like '%eric serra%'\n
\n
\n
\n
chokidar is the best of breed watch tool, but has this annoying linux-only big when moving folders outside of the watched paths\nWatchman is a C program that'll be hard to bundle.\nnode-watch does not send file event when removing/renaming folders\nwatchr API seems overly complex\nwatch-pack is using chokidar and the next version isn't ready
\n
\n
\n
wiring jest, storybook, svelte and tailwind was really painfull. Too many configuration files now :(\nTo make storyshots working, I had to downgrade Jest because of an annoying bug (reference).
\n
\n
\n
I considered Sapper for its nice conventional router, but given all the unsued feature (service workers, SSR) I chose a simpler router.\nIt is based on hash handling, as electron urls are using file:// protocol which makes it difficult to use with history-based routers.
\n
\n
\n
Initially, albums & artists id where hash of their names. It was very convenient to keep a list of artist's albums just by storing album names in artist's linked array. UI would infer ids by applying the same hash.\nHowever, it is common to see albums with same name from different artists (like \"Greatest hits\").\nTo mitigate this issue, I had to make album's id out of album name and album artist (when defined). This ruined the hash convention, and I had to replace all \"links\" by proper references (id + name). Now UI does not infer ids anymore.
\n
\n
\n
For system notifications, document.hidden and visibilityChange are too weak because they only notice when the app is minimized/restored
\n
\n
\n
System notification was tricky: HTML5 Notification API doesn't support actions, except from service workers.\nUsing service workers was overkill, and didn't work in the end.\nElectron's native notificaiton does not support actions either.\nUsing node-notifier was a viable possibility, but doesn't support actions in a portable fashion (notify-send on linux doesn't support it).\nFinally back to HTML5 notification API, without actions :(
\n
\n
\n
The discovery of mediaSession's metadata and handler was completely random. It's only supported by Chrome (hopefully for me!), and can be seen on Deezer, Spotify or Youtube Music. However, it does not display artworks.
\n
\n
\n
IntersectionObserver does not call the intersection entry when the position inside viewport is changing but the intersection doesn't.\nAs a result, dropdown in the sheet will enter viewport during sheet animation, causing troubles positioning the menu
\n
\n
\n
AC/DC was displayed as 2 different artists ('AC' and 'DC'). This is an issue with ID3 tags: version 2.3 uses / as a separators for artists.\nOveritting mp3 tags with 2.4 solved the issue
\n
\n
\n
Snap packaging was hairy to figure out. It is clearly the best option on Linux, as it has great desktop integration (which AppImage lacks) and a renowed app store. However, getting the MediaMetadata to work with snap confinement took two days of try-and-fail research. The full journey is available in this PR on electron-builnder. Besides, the way snapd is creating different folders for each new version forced me to move artist albums outside of electron's data folders: snapd ensure that files are copied from old to new version, but can not update the media full paths store inside SQLite DB.
\n
\n
\n
MacOS builder was constantly failing with the same error: 7zip couldn't find any file to compress in the final archive. It turns out it is because the production name as an accent (Mélodie), and the mac flavor of 7zip can not handle it...
\n
\n
\n
Chokidar has a \"limitation\" and triggers for each renamed or moved file an 'unlink' and an 'add' event. The implication on Mélodie were high: moved/renamed files would disappear from playlists. Ty bypass the issue, Mélodie stores file inodes and buffer chokidar events: when a file is removed, Mélodie will wait 250ms more, and if another file is added with the same inode during that time, will consider it as a rename/move.
\n
\n
\n
The mono-repo endeavour. My goal was to split code in various reusable packages: a UI and core that would not depend on Electron, and could be used in both Web and Desktop context, and two apps: an Electron-based desktop application and the Github-page site. As developer I would expect the ability to hoist as many modules
\n
\n
runing jest with pnpm does not work at all.
\n
lerna is a pain when it comes to hoisting deps.
\n
svelte-jester and preprocess absolutely don't work with yarn@2
\n
yarn@1 works fine but brings very little commands (just a little more than npm@7)
\n
npm@7 must install peer deps in legacy mode and does not offer any sugar for multi-package commands. All deps must be manually added to package.json, because install command MUST be run at root level\nElectron-builder does not like monorepo either: author, description and other metadata must be copied from root package.json to apps/desktop/package.json. The Electron version must be fixed because node_modules are hoisted. The package.json name MUST be melodie :(\nCaveats: always run npm i --legacy-peer-deps AT ROOT level. Running npm or npx command inside packages would re-create node_modules\nEnsuring the same version in all packages and dependencies similarities must be done manually
\n
\n
\n
\n
svelte-spa-router, and its dependency on regexparam, has been bother me for a very long time. When ran with jest, svelte-spa-router files must be transpiled by Svelte compiler, but they import regexparam as esm, and this lib doesn't expose such binding. One must replace the import with require, and this must only be done during test, because rollup will handle it properly.\nWhen receiving errors from svelte-jester, don't forget to clean jest cache with --cleanCache CLI option.
\n
\n
\n
How watch & diff works
\n
\n
\n
on app load, trigger diff
\n\n
\n
get followed folders from store
\n
\n
\n
crawl followed folders, return array of paths + hashs + last changed
\n
\n
\n
get array of tracks with hash + last changed from DB
\n
\n
\n
compare to find new & changed hashes
\n\n
\n
enrich with tags & media
\n
\n
\n
save
\n
\n\n
\n
\n
compare to isolate deleted hashes
\n\n
remove corresponding tracks
\n\n
\n\n
\n
\n
while app is running
\n\n
\n
watch new & changed paths
\n\n
\n
compute hash, enrich with tags & media
\n
\n
\n
save
\n
\n\n
\n
\n
watch deleted paths
\n\n
\n
compute hash
\n
\n
\n
remove corresponding tracks
\n
\n\n
\n\n
\n
\n
when adding new followed folder
\n\n
\n
save in store
\n
\n
\n
crawl new folder, return array of paths
\n
\n
\n
compute hash, enrich with tags & media
\n
\n
\n
save
\n
\n\n
\n
\n
How missing artworks/covers retrieval works
\n
\n
\n
on UI demand trigger process
\n\n
\n
push all artists/albums without artwork/cover, and not process since N in a queue
media-dupes checks on application launch if there is a newer media-dupes version available.\nUpdates must be installed manually as automatic updating of electron applications requires that the builds are code-signed, which i can't provide so far.
\n
media-dupes checks as well on application launch if there are updates available for the bundled youtube-dl tool.
\n
Be aware:
\n
Updating the bundled youtube-dl package is only possible if the user has write access to the media-dupes installation path (which does not work for all available packages/installation types).
Please see the verbose informations for more details.
\n
privacy
\n
\n
media-dupes is using sentry to collect error reports and do some anonymous usage stats. This helps heavily finding bugs which might occur only in some specific use-cases.
\n
reporting is enabled by default, but can be disabled in the application settings UI.
\n
media-dupes is not tracking it's users (i.e. using Google Analytics or similar)
\n
no ip addresses are stored
\n
\n
Please check here how media-dupes is using sentry and why.
\n
discussion
\n
If you have question regarding media-dupes click here to create an issue
\n
support / fund
\n
If you want to support the development of media-dupes you can fund me on:
media-dupes checks on application launch if there is a newer media-dupes version available.\nUpdates must be installed manually as automatic updating of electron applications requires that the builds are code-signed, which i can't provide so far.
\n
media-dupes checks as well on application launch if there are updates available for the bundled youtube-dl tool.
\n
Be aware:
\n
Updating the bundled youtube-dl package is only possible if the user has write access to the media-dupes installation path (which does not work for all available packages/installation types).
Please see the verbose informations for more details.
\n
privacy
\n
\n
media-dupes is using sentry to collect error reports and do some anonymous usage stats. This helps heavily finding bugs which might occur only in some specific use-cases.
\n
reporting is enabled by default, but can be disabled in the application settings UI.
\n
media-dupes is not tracking it's users (i.e. using Google Analytics or similar)
\n
no ip addresses are stored
\n
\n
Please check here how media-dupes is using sentry and why.
\n
discussion
\n
If you have question regarding media-dupes click here to create an issue
\n
support / fund
\n
If you want to support the development of media-dupes you can fund me on:
Metastream used to be an Electron desktop application until development was stopped due to roadblocks in acquiring a Widevine license. The latest version can be found on the GitHub releases page. Please note that the legacy app is insecure and not recommended.
Metastream used to be an Electron desktop application until development was stopped due to roadblocks in acquiring a Widevine license. The latest version can be found on the GitHub releases page. Please note that the legacy app is insecure and not recommended.
This app shows your GitLab merge requests grouped by projects and WIP status. It is accessible from the system tray.
\n
\n\n
\n
Light Mode
\n
Dark Mode
\n
\n\n\n
\n
\n
\n
\n\n
\n
Tray Icon
\n
In the system tray you wil see the number of all open merge requests.
\n
\n
Notification
\n
You will receive a desktop notification when a new merge request is created.\nIf you are not interested in \"work in progress\" merge request you can disable notifications for these. In addition you can disable notifications at all.
\n
\n
App Updates (macOS only)
\n
You will be always up to date with our integrated in app updates 🎉. Once there is a new update available you will be\nnotified with a prominent alert above the merge requests. On the details page you find the release notes from github.
\n
\n\n
\n
New Update Alert
\n
Release Notes
\n
\n\n\n
\n
\n
\n
\n\n
\n
Installation
\n
macOS
\n
Manual installation
\n
The macOS installer is uploaded at the releases page. Please download and install.
\n
With homebrew-cask
\n
If you're using homebrew-cask, this app can be installed via it. Please tap the repository URL and install this app via brew cask as follows.
\n
brew tap codecentric/merge-request-notifier https://github.com/codecentric/merge-request-notifier\nbrew install --cask merge-request-notifier\n
\n
It's the easiest way to install and manage this app on macOS.
\n
Windows
\n
The Windows installer is uploaded at the releases page. Please download and install.
\n
Linux
\n
Dependencies
\n
This app is using a library that uses libsecret to store the personal access token on your device.
\n
Depending on your distribution, you will need to run the following command:
This app shows your GitLab merge requests grouped by projects and WIP status. It is accessible from the system tray.
\n
\n\n
\n
Light Mode
\n
Dark Mode
\n
\n\n\n
\n
\n
\n
\n\n
\n
Tray Icon
\n
In the system tray you wil see the number of all open merge requests.
\n
\n
Notification
\n
You will receive a desktop notification when a new merge request is created.\nIf you are not interested in \"work in progress\" merge request you can disable notifications for these. In addition you can disable notifications at all.
\n
\n
App Updates (macOS only)
\n
You will be always up to date with our integrated in app updates 🎉. Once there is a new update available you will be\nnotified with a prominent alert above the merge requests. On the details page you find the release notes from github.
\n
\n\n
\n
New Update Alert
\n
Release Notes
\n
\n\n\n
\n
\n
\n
\n\n
\n
Installation
\n
macOS
\n
Manual installation
\n
The macOS installer is uploaded at the releases page. Please download and install.
\n
With homebrew-cask
\n
If you're using homebrew-cask, this app can be installed via it. Please tap the repository URL and install this app via brew cask as follows.
\n
brew tap codecentric/merge-request-notifier https://github.com/codecentric/merge-request-notifier\nbrew install --cask merge-request-notifier\n
\n
It's the easiest way to install and manage this app on macOS.
\n
Windows
\n
The Windows installer is uploaded at the releases page. Please download and install.
\n
Linux
\n
Dependencies
\n
This app is using a library that uses libsecret to store the personal access token on your device.
\n
Depending on your distribution, you will need to run the following command:
# install dependencies\n$ yarn install / yarn\n\n# serve with hot reload at localhost:9080\n$ yarn run dev\n\n# build electron application for production\n$ yarn run build\n\n# run unit & end-to-end tests\n$ yarn test
\n\n
\n \n\n \n \n
\n
",
+ "readmeOriginal": "
\n \n\n \n \n
\n
\nA DDP Client with GUI\n
\n
\n
\n\n\n
\n
\n
Starting 🚀
\n
Meteorman is The Postman of Meteor. It is a DDP Client with GUI
# install dependencies\n$ yarn install / yarn\n\n# serve with hot reload at localhost:9080\n$ yarn run dev\n\n# build electron application for production\n$ yarn run build\n\n# run unit & end-to-end tests\n$ yarn test
MetroGit is a native desktop git app with JIRA, AppVeyor and other tools integrated into one consistent UI. So no more switching windows and jumping between browser tabs 🤓. More integration and feature still yet to come...
\n
\n
Feature Highlight
\n
\n
Subway map style git visualization with commit details
To start using this app, go to Releases, download and run the latest setup.exe or dmg and off you go.
\n
Building
\n
This app is built on: NodeJS 8.10
\n
To build this from the scratch, global dependencies electron-builder and @angular/cli is needed.
\n
\n
You can install global dependencies via npm install -g electron-builder @angular/cli
\n
\n
After installing correct dependencies, do the following.
\n\n
Clone this repo
\n
cd into this repo, yarn install
\n
cd app/frontend
\n
yarn install
\n
cd ../.. back to project root directory
\n
.\\build.ps1 (for windows) or .\\build.sh (for Mac)
\n
The output is in dist folder
\n\n
Support this app
\n
Hi there, if you like this app, find it useful or just like this subway map, I'd loved to hear your feedback and experiences, you can share them with admin@rhodiumcode.com
\n
Also, please consider Buy me a tea, I live on black tea basically 😉
\n
Or, alternatively
\n
BTC: 3CAgw9vNPNXHR1YaWmJe98DDiTqdgKkv8Y
\n
ETH: 0xea96AA397a799E77f5991A2568099698329C3D39
\n
FAQ and Issues
\n
Checkout the Wiki FAQ Page for frequently asked questions. If you've found a bug, security issue or want to suggest a feature, feel free to post them to the Issues section (please search for existing issues and FAQ before posting new ones 🙂)
MetroGit is a native desktop git app with JIRA, AppVeyor and other tools integrated into one consistent UI. So no more switching windows and jumping between browser tabs 🤓. More integration and feature still yet to come...
\n
\n
Feature Highlight
\n
\n
Subway map style git visualization with commit details
To start using this app, go to Releases, download and run the latest setup.exe or dmg and off you go.
\n
Building
\n
This app is built on: NodeJS 8.10
\n
To build this from the scratch, global dependencies electron-builder and @angular/cli is needed.
\n
\n
You can install global dependencies via npm install -g electron-builder @angular/cli
\n
\n
After installing correct dependencies, do the following.
\n\n
Clone this repo
\n
cd into this repo, yarn install
\n
cd app/frontend
\n
yarn install
\n
cd ../.. back to project root directory
\n
.\\build.ps1 (for windows) or .\\build.sh (for Mac)
\n
The output is in dist folder
\n\n
Support this app
\n
Hi there, if you like this app, find it useful or just like this subway map, I'd loved to hear your feedback and experiences, you can share them with admin@rhodiumcode.com
\n
Also, please consider Buy me a tea, I live on black tea basically 😉
\n
Or, alternatively
\n
BTC: 3CAgw9vNPNXHR1YaWmJe98DDiTqdgKkv8Y
\n
ETH: 0xea96AA397a799E77f5991A2568099698329C3D39
\n
FAQ and Issues
\n
Checkout the Wiki FAQ Page for frequently asked questions. If you've found a bug, security issue or want to suggest a feature, feel free to post them to the Issues section (please search for existing issues and FAQ before posting new ones 🙂)
Start Min in development mode by running npm run start.
\n
After you make changes, you can press ctrl+r (or cmd+r on Mac) twice to restart the browser.
\n
\n
Building binaries
\n
In order to build Min from source, follow the installation instructions above, then use one of the following commands to create binaries:
\n
\n
npm run buildWindows
\n
npm run buildMacIntel
\n
npm run buildMacArm
\n
npm run buildDebian
\n
npm run buildRaspi (for Raspberry Pi, Raspberry Pi OS)
\n
npm run buildLinuxArm64
\n
npm run buildRedhat
\n
\n
Depending on the platform you are building for, you may need to install additional dependencies:
\n
\n
If you are using macOS and building a package for Linux, install Homebrew, then run brew install fakeroot dpkg first.
\n
If you are using macOS or Linux and building a package for Windows, you will need to install Mono and Wine.
\n
If you are building a macOS package, you'll need to install Xcode and the associated command-line tools. You may also need to set your default SDK to macOS 11.0 or higher, which you can do by running export SDKROOT=/Applications/Xcode.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX11.1.sdk. The exact command will depend on where Xcode is installed and which SDK version you're using.
\n
To build on Windows, you'll need to install Visual Studio. Once it's installed, you may also need to run npm config set msvs_version 2019 (or the appropriate version).
\n
\n
Contributing to Min
\n
Thanks for taking the time to contribute to Min!
\n
Getting Help
\n
If you're experiencing a bug or have a suggestion for how to improve Min, please open a new issue.
\n
If you have questions about using Min, need help getting started with development, or want to talk about what we're working on, join our Discord server.
\n
Contributing Code
\n
\n
Start by following the development instructions listed above.
Change the \"identifier\" field in the new file to the language code from step 1.
\n
Inside the file, replace each English string in the right-hand column with the equivalent translation.
\n
(Optional) See your translations live by following the development instructions above. Min will display in the same language as your operating system, so make sure your computer is set to the same language that you're translating.
\n
That's it! Make a pull request with your changes.
\n
\n
Updating an existing language
\n
\n
Find the language file for your language in the localization/languages directory.
\n
Look through the file for any items that have a value of \"null\", or that have a comment saying \"missing translation\".
\n
For each of these items, look for the item with the same name in the en-US.json file.
\n
Translate the value from the English file, replace \"null\" with your translation, and remove the \"missing translation\" comment.
\n
Make a pull request with the updated file.
\n
\n
",
+ "readmeOriginal": "
Min
\n
Min is a fast, minimal browser that protects your privacy. It includes an interface designed to minimize distractions, and features such as:
Start Min in development mode by running npm run start.
\n
After you make changes, you can press ctrl+r (or cmd+r on Mac) twice to restart the browser.
\n
\n
Building binaries
\n
In order to build Min from source, follow the installation instructions above, then use one of the following commands to create binaries:
\n
\n
npm run buildWindows
\n
npm run buildMacIntel
\n
npm run buildMacArm
\n
npm run buildDebian
\n
npm run buildRaspi (for Raspberry Pi, Raspberry Pi OS)
\n
npm run buildLinuxArm64
\n
npm run buildRedhat
\n
\n
Depending on the platform you are building for, you may need to install additional dependencies:
\n
\n
If you are using macOS and building a package for Linux, install Homebrew, then run brew install fakeroot dpkg first.
\n
If you are using macOS or Linux and building a package for Windows, you will need to install Mono and Wine.
\n
If you are building a macOS package, you'll need to install Xcode and the associated command-line tools. You may also need to set your default SDK to macOS 11.0 or higher, which you can do by running export SDKROOT=/Applications/Xcode.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX11.1.sdk. The exact command will depend on where Xcode is installed and which SDK version you're using.
\n
To build on Windows, you'll need to install Visual Studio. Once it's installed, you may also need to run npm config set msvs_version 2019 (or the appropriate version).
\n
\n
Contributing to Min
\n
Thanks for taking the time to contribute to Min!
\n
Getting Help
\n
If you're experiencing a bug or have a suggestion for how to improve Min, please open a new issue.
\n
If you have questions about using Min, need help getting started with development, or want to talk about what we're working on, join our Discord server.
\n
Contributing Code
\n
\n
Start by following the development instructions listed above.
Change the \"identifier\" field in the new file to the language code from step 1.
\n
Inside the file, replace each English string in the right-hand column with the equivalent translation.
\n
(Optional) See your translations live by following the development instructions above. Min will display in the same language as your operating system, so make sure your computer is set to the same language that you're translating.
\n
That's it! Make a pull request with your changes.
\n
\n
Updating an existing language
\n
\n
Find the language file for your language in the localization/languages directory.
\n
Look through the file for any items that have a value of \"null\", or that have a comment saying \"missing translation\".
\n
For each of these items, look for the item with the same name in the en-US.json file.
\n
Translate the value from the English file, replace \"null\" with your translation, and remove the \"missing translation\" comment.
To completely remove the application and start over, remove the settings file too.
\n
Production Build
\n
# Run build process\nnpm run dist\n\n# or\n\n# Run build process and publish to GitHub releases\nnpm run release
\n
macOs
\n
The app needs to be signed and notarized.\nTo do so, install the .p12 file in the local keychain (double click on it).
\n
The certificate is obtained from the Apple Developer website.\nThe Developer ID Application is required.\nThe Developer ID Installer may be required too.\nOnce obtained, the .cer files have to be converted to .p12 by providing the certificate passwords/private keys.
\n
In addition to that, the following environment variables have to be set to publish:
\n
# See below to complete these two:\nAPPLE_ID=\nAPPLE_ID_PASSWORD=\n# See `electron-build` docs on how to complete these two:\nCSC_LINK=\nCSC_KEY_PASSWORD=\n# Github personal access token to upload the files to repo releases.\nGH_TOKEN=
\n
Follow these steps to create an app specific password.\nThe APPLE_ID variable is the Apple ID used to create the password.\nAPPLE_ID_PASSWORD is the password Apple created for the app.
The signing certificate shall be in the root folder of the repository.\nThe certificate password will be required during the signing process.\nThe signing process may take several minutes because notarization requieres uploading the app to Apple.
\n
In order to verify that the application has been successfully signed and notarized, run:
\n
# Verifies the app has been signed\ncodesign --verify --verbose ./dist/mac/Metronome\\ Wallet.app\n\n# Verifies the app has been notarized\nspctl -a -t exec -vvv ./dist/mac/Metronome\\ Wallet.app
\n
Windows
\n
To sign the application, a certificate for the Microsoft Authenticode platform is required.\nThe certificate, a .p7b file, will then be required during the build process.
To completely remove the application and start over, remove the settings file too.
\n
Production Build
\n
# Run build process\nnpm run dist\n\n# or\n\n# Run build process and publish to GitHub releases\nnpm run release
\n
macOs
\n
The app needs to be signed and notarized.\nTo do so, install the .p12 file in the local keychain (double click on it).
\n
The certificate is obtained from the Apple Developer website.\nThe Developer ID Application is required.\nThe Developer ID Installer may be required too.\nOnce obtained, the .cer files have to be converted to .p12 by providing the certificate passwords/private keys.
\n
In addition to that, the following environment variables have to be set to publish:
\n
# See below to complete these two:\nAPPLE_ID=\nAPPLE_ID_PASSWORD=\n# See `electron-build` docs on how to complete these two:\nCSC_LINK=\nCSC_KEY_PASSWORD=\n# Github personal access token to upload the files to repo releases.\nGH_TOKEN=
\n
Follow these steps to create an app specific password.\nThe APPLE_ID variable is the Apple ID used to create the password.\nAPPLE_ID_PASSWORD is the password Apple created for the app.
The signing certificate shall be in the root folder of the repository.\nThe certificate password will be required during the signing process.\nThe signing process may take several minutes because notarization requieres uploading the app to Apple.
\n
In order to verify that the application has been successfully signed and notarized, run:
\n
# Verifies the app has been signed\ncodesign --verify --verbose ./dist/mac/Metronome\\ Wallet.app\n\n# Verifies the app has been notarized\nspctl -a -t exec -vvv ./dist/mac/Metronome\\ Wallet.app
\n
Windows
\n
To sign the application, a certificate for the Microsoft Authenticode platform is required.\nThe certificate, a .p7b file, will then be required during the build process.
Mini Diary is no longer maintained. Please use a different journal app instead.
\n
Website
\n
Features and FAQs can be found on the website: minidiary.app
\n
Development
\n
The application is built with Electron and React. To run or build the app yourself, you'll need to have Node.js and Yarn installed.
\n
Running the app
\n\n
Clone this repository: git clone REPO_URL
\n
Navigate into the project directory: cd mini-diary
\n
Install the dependencies: yarn
\n
Run the app: yarn start
\n\n
Building the app
\n
After cloning the repo and installing the dependencies, run yarn build. The packaged app can be found in the dist folder.
\n
Contributing
\n
Features and Bugs
\n
Suggestions and contributions are always welcome! Please first discuss changes via issue before submitting a pull request.
\n
Adding missing translations
\n
The list of all English strings can be found in en.ts. If there are translations missing for your language and you'd like to help with the translation, you can add the translated strings to your language's file in src/main/i18n/translations and submit a PR.
\n
Adding a new language
\n
If the app isn't translated into your language yet and you'd like to help out, you can easily add translations with the following steps:
Add your language shortcode to the electronLanguages array in package.json.
\n
Run the app in your language (see the steps above) and make sure that the translations fit into the app (e.g. that they aren't too long for input fields).
\n
Submit a PR. Thanks for your help!
\n\n
",
+ "readmeOriginal": "
\n \n
Mini Diary
\n Simple and secure journal app\n \n
\n
Mini Diary is no longer maintained. Please use a different journal app instead.
\n
Website
\n
Features and FAQs can be found on the website: minidiary.app
\n
Development
\n
The application is built with Electron and React. To run or build the app yourself, you'll need to have Node.js and Yarn installed.
\n
Running the app
\n\n
Clone this repository: git clone REPO_URL
\n
Navigate into the project directory: cd mini-diary
\n
Install the dependencies: yarn
\n
Run the app: yarn start
\n\n
Building the app
\n
After cloning the repo and installing the dependencies, run yarn build. The packaged app can be found in the dist folder.
\n
Contributing
\n
Features and Bugs
\n
Suggestions and contributions are always welcome! Please first discuss changes via issue before submitting a pull request.
\n
Adding missing translations
\n
The list of all English strings can be found in en.ts. If there are translations missing for your language and you'd like to help with the translation, you can add the translated strings to your language's file in src/main/i18n/translations and submit a PR.
\n
Adding a new language
\n
If the app isn't translated into your language yet and you'd like to help out, you can easily add translations with the following steps:
Add your language shortcode to the electronLanguages array in package.json.
\n
Run the app in your language (see the steps above) and make sure that the translations fit into the app (e.g. that they aren't too long for input fields).
MineTime is no longer maintained. For the latest features, improvements and security patches, please check out the next-generation calendar app Morgen at https://morgen.so
\n \n
\n
",
+ "readmeOriginal": "
\n \n
MineTime (Release repo)
\n
\n \n \n
\n
\n
\n
This is a legacy repository
\n
MineTime is evolving
\n
\n
MineTime is no longer maintained. For the latest features, improvements and security patches, please check out the next-generation calendar app Morgen at https://morgen.so
Mingo is latest and most catchy MongoDB GUI, because it’s been created by developers for developers. The goal is simple, to offer you the best MongoDB admin; built on our programming experience and on your feedback.
\n
We focus on security, speed and user experience, while keeping Mingo great for both newbies and experienced users. The best part is that our intuitive MongoDB browser is packed with features we felt were missing in other MongoDB GUIs.
Field actions (rename field, show distinct values)
\n
Node JS shell
\n
Views management
\n
Indexes management
\n
\n
What are we working on?
\n
\n
A interactive DUMP / RESTORE interface
\n
Improvements of our Compare & Sync tool
\n
Dark mode
\n
A beautiful Data Vizualizer
\n
Embedded Mongo shell
\n
... and much more
\n
\n
Please submit ISSUES or feature requests!
\n
",
+ "readmeOriginal": "
About Mingo
\n
Mingo is latest and most catchy MongoDB GUI, because it’s been created by developers for developers. The goal is simple, to offer you the best MongoDB admin; built on our programming experience and on your feedback.
\n
We focus on security, speed and user experience, while keeping Mingo great for both newbies and experienced users. The best part is that our intuitive MongoDB browser is packed with features we felt were missing in other MongoDB GUIs.
Or create a new issue and provide as much information as you can to recreate your problem.
\n\n
How to contribute
\n
Contributions via Pull Requests are welcome. You can see where to help looking for issues with the Enhancement or Bug labels. We can help guide you towards the solution.
\n
You can also help by responding to issues. Sign up on CodeTriage and it'll send you gentle notifications with a configurable frequency. It is a nice way to help while learning.
\n
Installation
\n
If you want to install the app from a pre-built version on the release page, you can simply run the executable after download.
\n
For updating, simply download the new version and copy it over the old one (keep a backup of the old one if you want to be sure).
\n
Linux .zip installs
\n
In order to install from .zip files, please install libgconf2-4 first:
\n
apt-get install libgconf2-4
\n
Config folder
\n
The data folder for Mist depends on your operating system:
\n
\n
Windows %APPDATA%\\Mist
\n
macOS ~/Library/Application\\ Support/Mist
\n
Linux ~/.config/Mist
\n
\n
Development
\n
For development, a Meteor server assists with live reload and CSS injection.
\n
Once a Mist version is released the Meteor frontend part is bundled using the meteor-build-client npm package to create pure static files.
\n
Dependencies
\n
To run mist in development you need:
\n
\n
Node.jsv7.x (use the preferred installation method for your OS)
For development we start the interface with a Meteor server for auto-reload etc.
\n
Start the interface in a separate terminal window:
\n
$ yarn dev:meteor
\n
In the original window you can then start Mist with:
\n
$ cd mist\n$ yarn dev:electron
\n
NOTE: Client binaries (e.g. geth) specified in clientBinaries.json will be checked during every startup and downloaded if out-of-date, binaries are stored in the config folder.
\n
NOTE: use --help to display available options, e.g. --loglevel debug (or trace) for verbose output
\n
Run the Wallet
\n
Start the wallet app for development, in a separate terminal window:
\n
$ yarn dev:meteor
\n
In another terminal:
\n
$ cd my/path/meteor-dapp-wallet/app && meteor --port 3050
\n
In the original window you can then start Mist using wallet mode:
\n
$ cd mist\n$ yarn dev:electron --mode wallet
\n
Connect your own node
\n
This is useful if you are already running your own node or would like to connect with a private or development network.
\n
$ yarn dev:electron --rpc path/to/geth.ipc
\n
Passing options to Geth
\n
You can pass command-line options directly to Geth by prefixing them with --node- in\nthe command-line invocation:
Cross-platform builds require additional dependencies needed by Electron Builder. Please follow their instructions for up to date dependency information.
\n
Generate packages
\n
To generate the binaries for Mist run:
\n
$ yarn build:mist
\n
To generate the Ethereum Wallet:
\n
$ yarn build:wallet
\n
The generated binaries will be under dist_mist/release or dist_wallet/release. Starting from 0.11.0, both Ethereum Wallet and Mist ships with a meteor-dapp-wallet instance (https://github.com/ethereum/meteor-dapp-wallet).
\n
Options
\n
platform
\n
To build binaries for specific platforms (default: all available) use the following flags:
Or create a new issue and provide as much information as you can to recreate your problem.
\n\n
How to contribute
\n
Contributions via Pull Requests are welcome. You can see where to help looking for issues with the Enhancement or Bug labels. We can help guide you towards the solution.
\n
You can also help by responding to issues. Sign up on CodeTriage and it'll send you gentle notifications with a configurable frequency. It is a nice way to help while learning.
\n
Installation
\n
If you want to install the app from a pre-built version on the release page, you can simply run the executable after download.
\n
For updating, simply download the new version and copy it over the old one (keep a backup of the old one if you want to be sure).
\n
Linux .zip installs
\n
In order to install from .zip files, please install libgconf2-4 first:
\n
apt-get install libgconf2-4
\n
Config folder
\n
The data folder for Mist depends on your operating system:
\n
\n
Windows %APPDATA%\\Mist
\n
macOS ~/Library/Application\\ Support/Mist
\n
Linux ~/.config/Mist
\n
\n
Development
\n
For development, a Meteor server assists with live reload and CSS injection.
\n
Once a Mist version is released the Meteor frontend part is bundled using the meteor-build-client npm package to create pure static files.
\n
Dependencies
\n
To run mist in development you need:
\n
\n
Node.jsv7.x (use the preferred installation method for your OS)
For development we start the interface with a Meteor server for auto-reload etc.
\n
Start the interface in a separate terminal window:
\n
$ yarn dev:meteor
\n
In the original window you can then start Mist with:
\n
$ cd mist\n$ yarn dev:electron
\n
NOTE: Client binaries (e.g. geth) specified in clientBinaries.json will be checked during every startup and downloaded if out-of-date, binaries are stored in the config folder.
\n
NOTE: use --help to display available options, e.g. --loglevel debug (or trace) for verbose output
\n
Run the Wallet
\n
Start the wallet app for development, in a separate terminal window:
\n
$ yarn dev:meteor
\n
In another terminal:
\n
$ cd my/path/meteor-dapp-wallet/app && meteor --port 3050
\n
In the original window you can then start Mist using wallet mode:
\n
$ cd mist\n$ yarn dev:electron --mode wallet
\n
Connect your own node
\n
This is useful if you are already running your own node or would like to connect with a private or development network.
\n
$ yarn dev:electron --rpc path/to/geth.ipc
\n
Passing options to Geth
\n
You can pass command-line options directly to Geth by prefixing them with --node- in\nthe command-line invocation:
Cross-platform builds require additional dependencies needed by Electron Builder. Please follow their instructions for up to date dependency information.
\n
Generate packages
\n
To generate the binaries for Mist run:
\n
$ yarn build:mist
\n
To generate the Ethereum Wallet:
\n
$ yarn build:wallet
\n
The generated binaries will be under dist_mist/release or dist_wallet/release. Starting from 0.11.0, both Ethereum Wallet and Mist ships with a meteor-dapp-wallet instance (https://github.com/ethereum/meteor-dapp-wallet).
\n
Options
\n
platform
\n
To build binaries for specific platforms (default: all available) use the following flags:
HTTP/HTTPS mock tool, supports browsers and local server requests, can be used to mock response data returns and facilitate development and testing. \nBased on Node.js and Electron.
\n
Preview
\n
\n
Features
\n
\n
Intercepting and simulating response based on proxy server mechanism.
\n
Normally no need to manually set proxy.
\n
You can mock data without modifying the request link in your code, do not pollute the source code.
\n
Mock data support requests from browsers and local servers.
\n
Support HTTP and HTTPS requests, automatically generate local SSL certificates.
If you want to lauch the application in debug mode, use:
\n
$ npm run dev
\n
Enjoy it!😄
\n
How to package
\n
You can use electron-packager to package the program to distribute the app.
\n
install electron-packager
\n
$ npm install -g electron-packager
\n
package app
\n
After complete Quick Start, go into the directory which app you want to package, execute:
\n
$ npm run package
\n
Note
\n
In the packing process, electron-packager will automatically download the required files and store it in user/yourname/.electron, automatic downloading may be slow, it is recommended that use download tool to download the files in Electron Release then put in the above directory.
\n
FAQ
\n
\n
\n
How to mock https response? \nClick Mocker menu bar SSL - Download certificate..., save the SSL certificate to any location, then click SSL - Open certmgr, choose Trusted root certification authority - certificate, right click and choose all tasks - import, select the certificate you just downloaded, and the other options default, complete the import.
\n
\n
\n
How to mock data sent by local servers (such as Node.js server)? \nMocker is based on proxy servers, so you only need to set agent as http://127.0.0.1:28369 or https://127.0.0.1:28369. Take Node.js server as an example, use set HTTP_PROXY=http://127.0.0.1:28369&&node ./bin/www.
\n
\n
\n
I can't get to the Internet after close Mocker. \nIn normal circumstances, Mocker will automatically reset the system agent to empty before exiting the program, but in some special cases (such as manually killing process, direct shutdown, program exception, etc.), the system agent may not automatically reset, you need to manually set it, square: open the IE - Internet option - Connection - LAN settings, uncheck the proxy server.
\n
\n
\n
I can't use it correctly, or did I have an unusual error. \nTry to run app as administrator, if still not working, please submit Issue.
\n
\n
\n
License
\n
The MIT License (MIT)
\n
Copyright (c) 2018 Sky
\n
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
\n
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
\n
THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
HTTP/HTTPS mock tool, supports browsers and local server requests, can be used to mock response data returns and facilitate development and testing. \nBased on Node.js and Electron.
\n
Preview
\n
\n
Features
\n
\n
Intercepting and simulating response based on proxy server mechanism.
\n
Normally no need to manually set proxy.
\n
You can mock data without modifying the request link in your code, do not pollute the source code.
\n
Mock data support requests from browsers and local servers.
\n
Support HTTP and HTTPS requests, automatically generate local SSL certificates.
If you want to lauch the application in debug mode, use:
\n
$ npm run dev
\n
Enjoy it!😄
\n
How to package
\n
You can use electron-packager to package the program to distribute the app.
\n
install electron-packager
\n
$ npm install -g electron-packager
\n
package app
\n
After complete Quick Start, go into the directory which app you want to package, execute:
\n
$ npm run package
\n
Note
\n
In the packing process, electron-packager will automatically download the required files and store it in user/yourname/.electron, automatic downloading may be slow, it is recommended that use download tool to download the files in Electron Release then put in the above directory.
\n
FAQ
\n
\n
\n
How to mock https response? \nClick Mocker menu bar SSL - Download certificate..., save the SSL certificate to any location, then click SSL - Open certmgr, choose Trusted root certification authority - certificate, right click and choose all tasks - import, select the certificate you just downloaded, and the other options default, complete the import.
\n
\n
\n
How to mock data sent by local servers (such as Node.js server)? \nMocker is based on proxy servers, so you only need to set agent as http://127.0.0.1:28369 or https://127.0.0.1:28369. Take Node.js server as an example, use set HTTP_PROXY=http://127.0.0.1:28369&&node ./bin/www.
\n
\n
\n
I can't get to the Internet after close Mocker. \nIn normal circumstances, Mocker will automatically reset the system agent to empty before exiting the program, but in some special cases (such as manually killing process, direct shutdown, program exception, etc.), the system agent may not automatically reset, you need to manually set it, square: open the IE - Internet option - Connection - LAN settings, uncheck the proxy server.
\n
\n
\n
I can't use it correctly, or did I have an unusual error. \nTry to run app as administrator, if still not working, please submit Issue.
\n
\n
\n
License
\n
The MIT License (MIT)
\n
Copyright (c) 2018 Sky
\n
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
\n
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
\n
THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
⚠On Windows, you will need to download git if you haven't yet already. You can either download just git itself, or download GitHub's Windows client, which also includes git and other tools, even if you don't use the GUI portion.
\n
macOS
\n
For macOS, you can install the necessary packages using Homebrew.
\n
brew install git node
\n
ℹXcode Command Line Tools also include git. If you already have it, you can remove \"git\" from the command.
ModernDeck also includes build.bat for Windows.\nIt requires Windows 10 or Windows Server 2019, with WSL installed (including wsl.exe), with the proper tools (node, npm) installed on both WSL and Windows.
\n
This makes it very quick to build for every platform, including extension, except macOS, particularly because it doesn't require the electron build server.
⚠Building for macOS requires running under macOS. Under macOS, you can build for Windows, macOS, and Linux. Under both Linux and Windows, you can build for both Linux and Windows. (Windows requires WSL, see above)
\n
Building the browser extension
\n
First, you need to run rollup.
\n
npm run rollup
\n
This will transpile ModernDeck source and dependencies into a single moderndeck.js file. This needs to be run if you make JS changes under the ModernDeck/src directory
\n
ℹ Building ModernDeck's source with Rollup increments the Build number as well
\n
To test the extension, you'll want to load the unpacked extension. This, of course, varies by browser.
\n
Chrome
\n
Open the Chrome menu, go to More tools > Extensions
\n
Turn on Developer Mode in the top right corner if you haven't already.
\n
Click the Load unpacked button
\n
Navigate to ModernDeck/common and click Select Folder
\n
Firefox
\n
Go to about:debugging
\n
Click This Firefox
\n
Click Load Temporary Add-on...
\n
Navigate to ModernDeck/common/manifest.json
\n
Microsoft Edge
\n
Open the ... menu
\n
Click Extensions
\n
Turn on Developer Mode in the bottom left corner if you haven't already
\n
Click the Load unpacked button
\n
Navigate to ModernDeck/common and click Select Folder
\n
Microsoft Edge Legacy (The EdgeHTML-based browser) is no longer supported in ModernDeck 8.0 and later. It might still work, but no problems with it will be corrected.
\n
Opera
\n
Click the Extensions button in the bar on the left side (the icon looks like a box)
\n
Turn on Developer Mode in the top right if you haven't already
\n
Click Load unpacked
\n
Select ModernDeck/common and click Select Folder
\n
Building Extension for Release
\n
Run npm install && node build/build.js from the root ModernDeck directory. The corresponding ZIPs will appear in the dist folder
⚠On Windows, you will need to download git if you haven't yet already. You can either download just git itself, or download GitHub's Windows client, which also includes git and other tools, even if you don't use the GUI portion.
\n
macOS
\n
For macOS, you can install the necessary packages using Homebrew.
\n
brew install git node
\n
ℹXcode Command Line Tools also include git. If you already have it, you can remove \"git\" from the command.
ModernDeck also includes build.bat for Windows.\nIt requires Windows 10 or Windows Server 2019, with WSL installed (including wsl.exe), with the proper tools (node, npm) installed on both WSL and Windows.
\n
This makes it very quick to build for every platform, including extension, except macOS, particularly because it doesn't require the electron build server.
⚠Building for macOS requires running under macOS. Under macOS, you can build for Windows, macOS, and Linux. Under both Linux and Windows, you can build for both Linux and Windows. (Windows requires WSL, see above)
\n
Building the browser extension
\n
First, you need to run rollup.
\n
npm run rollup
\n
This will transpile ModernDeck source and dependencies into a single moderndeck.js file. This needs to be run if you make JS changes under the ModernDeck/src directory
\n
ℹ Building ModernDeck's source with Rollup increments the Build number as well
\n
To test the extension, you'll want to load the unpacked extension. This, of course, varies by browser.
\n
Chrome
\n
Open the Chrome menu, go to More tools > Extensions
\n
Turn on Developer Mode in the top right corner if you haven't already.
\n
Click the Load unpacked button
\n
Navigate to ModernDeck/common and click Select Folder
\n
Firefox
\n
Go to about:debugging
\n
Click This Firefox
\n
Click Load Temporary Add-on...
\n
Navigate to ModernDeck/common/manifest.json
\n
Microsoft Edge
\n
Open the ... menu
\n
Click Extensions
\n
Turn on Developer Mode in the bottom left corner if you haven't already
\n
Click the Load unpacked button
\n
Navigate to ModernDeck/common and click Select Folder
\n
Microsoft Edge Legacy (The EdgeHTML-based browser) is no longer supported in ModernDeck 8.0 and later. It might still work, but no problems with it will be corrected.
\n
Opera
\n
Click the Extensions button in the bar on the left side (the icon looks like a box)
\n
Turn on Developer Mode in the top right if you haven't already
\n
Click Load unpacked
\n
Select ModernDeck/common and click Select Folder
\n
Building Extension for Release
\n
Run npm install && node build/build.js from the root ModernDeck directory. The corresponding ZIPs will appear in the dist folder
The Accelerated Mobile Pages Project (AMP) is an online publishing format, originally created by Google as an alternative to Facebook’s Instant Articles. It’s a way to optimize web pages for mobile browsing using a special code–AMP-HTML.
\n
\n
AMP sites are loading smoothly and fast. Users like pages they don't have to wait, so you keep your visitors.
\n
Goggle Search adds to AMP articles an AMP iсon, and when you use a mobile device, these pages are shown first.
\n
AMP is a great solution for internet magazines, blogs and news sites.
\n
\n
\n
Mobirise 5.3
\n
Interface
\n
Design
\n
\n
New loader look
\n
Scrollbar styling added
\n
\n
\n
\n
Added dark inline editor panel in the dark mode
\n
\n
\n
Sites management
\n
\n
Now you can create sites based on a template from another theme
\n
Sites panel - search by name & domain added
\n
Create New Site panel - newest themes shown on top of the list
\n
Search through all templates when adding a new page: go to Pages and click Create New Page to see the list of available templates
\n
\n
\n
Drag Block to Page panel
\n
\n
Search through all Mobirise blocks
\n
\n
\n
\n
Added Show More buttons at the end of each blocks' group
\n
\n
\n
\n
Updated block groups (added new block groups, renamed and sorted the old ones) for free Mobirise themes
\n
Added shadows to the show more blocks button on hover
\n
Added new blocks categories to default themes, fixed the search for similar blocks
\n
\n
Domain connection
\n
\n
Updated DNS records: new DNS record types available
\n
Connecting domain via CNAME record added
\n
\n
Extensions panel
\n
\n
Added Add All button
\n
\n
\n
Code Editor
\n
\n
Highlight matching tags in HTML
\n
\n
\n
Icons
\n
\n
SVG icons instead of iconfont files in pages to improve loading speed
\n
\n
Other updates
\n
\n
Improved loading speed of user sites by optimized connection of Google Fonts
\n
If there is something wrong with the project code, you'll see a note about an issue
\n
\n
Themes
\n
Mobirise 5
\n
\n
Added compatibility with the Form Builder extension
\n
Fixes for alignment on mobile devices
\n
Fixes for logo images in the navbar
\n
Fixed the scroll-to-top arrow on mobile view
\n
Added paddings to the logo in the menu
\n
Socicon plugin font now supports \"font-display: swap\" for better optimization
\n
Fixed menu brand name underline
\n
New block categories
\n
\n
AudioM4
\n
\n
Features 3, 4, 6: Changed background images to usual img, to have an opportunity to insert link on image
\n
Features 4, 6: Added the ability to disable swinging and glare animation
\n
Added square cards option (square music album covers are the industry standard)
\n
Added range parameter to change size of cover
\n
Added buttons option (if all animation is enabled, there may be problems with following the link in the image, despite the accepted changes)
\n
\n
LuxuryM4
\n
\n
Fixed incompatibility issues with Mobirise 5
\n
Fixed broken logos in the menu
\n
Aligning pictures in team2
\n
Moving the send button in form1 and form3, an extra once global attributes in form 2
\n
\n
BusinessM4
\n
\n
Fixed images in Clients1
\n
Renamed all images in clients-white folder, to avoid intersections with images from clients folder after publication or preview
\n
\n
TherapyM4
\n
\n
Fixed team2 uneditable card content
\n
Added pointer-events rules, to be able to edit the text and link that appear on image hover
\n
\n
KidsM4
\n
\n
Fixes for options for menu background & text color option on mobile
\n
\n
ConnectM4
\n
\n
Reduced resolution to upscale the font-size from 1200 to 1199px and 992 to 991px
\n
\n
KidsM4 & AgencyM4
\n
\n
Fixed incompatibility issues with Mobirise 5, fixed the codestyle and menu, added theme classes
\n
\n
LightAMP
\n
\n
Fixed bugs in menus
\n
\n
Fixes
\n
\n
Github publishing method fixed
\n
Fixed and updated DNS records: new DNS record types available
\n
Extensions panel - fixed the search
\n
Fixed the position for the custom HTML block
\n
Fixes for the theme installation when choosing an unavailable theme
\n
App Settings - fixed saving Remove Mobirise from HTML setting
\n
Link-editor: fixed shop links in AMP themes
\n
Fixes for the fonts connection issue
\n
\n
Mobirise 5.2
\n
Core
\n
\n
Bootstrap version updated in the app to 4.5.2
\n
Electron version updated in the app to v10
\n
\n
Interface
\n
\n
New Blocks Menu panel. Browse through blocks more conveniently due to the enlarged page view
\n
\n
\n
\n
Spellchecker: check and correct mistakes directly in the app
\n
Add Blocks List: all compatible blocks are available w/o theme reloading and user blocks. Select a compatible theme to see a blocks list
\n
\n
\n
\n
Pages List: Search available
\n
\n
\n
\n
You can download all the extensions available for you. Open the Extensions list and press Ctrl+Shift+A
\n
Don't show again option for remove block, create site and open site dialogs.
\n
Updated Remove Unused Images
\n
Faster Sites panel
\n
\n
Mobirise 5 theme
\n
\n
Ghost Button Border option in Site Styles
\n
5 new blocks - headers and footers
\n
Logo Size option for footers
\n
Fixes in some block designs
\n
Fix with tab anchor renaming
\n
Duplicated code and CSS removed
\n
Some fixes in block designs
\n
\n
Fixes
\n
\n
Fix in Code Editor \"click twice to save\"
\n
Fix for \"Social Sharing Image\"
\n
Fix for sorting blocks
\n
Google maps fix
\n
Code syntax verification fix in Code Editor
\n
Fix for custom HTML in M3
\n
\n
Mobirise 5.0
\n
Core
\n
\n
Brand-new engine. The app is upto 2 time faster, especially on large projects.
\n
Bootstrap version updated in the app to 4.5.0
\n
jQuery version updated in the app to v3.5.1
\n
Themes can be added faster (the app is not reloading if the theme is not current)
\n
\n
Interface
\n
\n
Light/Dark mode. The Light mode is enabled by default in the app now. But if it's more comfortable for your to use the dark mode, open app settings (Menu -> Account -> App Settings -> Editor -> Dark Mode)
\n
The Remove Unused Images button added in Site Library.
\n
Sites published on Mobirise servers are shown in the Sites list now. If you remove them, they will not be available online anymore
\n
New Sites panel available in the app. Now it's in a full-screen mode
\n
Image Editor: New function in Image Editor: Rotate
\n
Favicon and page name are shown in navbar
\n
Canvas with borders. You can disable this feature in your app settings (Menu -> Account -> App Settings -> Editor -> Fullscreen Canvas).
\n
You can connect your site domain with the site published via the Mobirise Publish option. Find this feature in your Site Settings after publishing your site.
\n
\n
\nNew Sites List view available in Mobirise 5\n
\nYou can enable Dark Mode in App Settings\n
\nYou can disable your project borders by enabling the Fullscreen Canvas option\n
\nClear your site library by removing images you don't use in a project\n
\nThe site domain settings will appear in your Site Settings after publishing your site via the Mobirise Publish option\n
Fixes
\n
\n
Saving user blocks is fixed
\n
AMP Cache issue fixed. Earlier some of our users faced some issues with AMP blocks: galleries, sliders, accordions were not usable because of saved cached files. There was no simple way to clear the cache folder. This issue is fixed now.
\n
Sliders and Galleries optimized in the app. This fix may not affect already created galleries, but new galleries and sliders should work faster
\n
Mobirise 4 Theme: youtu.be links are supported, forms are cleared after submitting, gallery and form fixes
\n
MobiriseAMP Theme: update menu, fixed 'scroll to top button'
\n
Issue with $ symbols cleared is fixed
\n
Parallax fixes
\n
Link Editor: WhatsApp link fixed
\n
Form Builder fixes
\n
Google Maps fixed
\n
\n
Extensions
\n
\n
Code Editor: Global HTML Insert available in Site Settings. You can add the HTML lang tag in it and add code snippets to the various parts of your pages. Since this feature is global, your code will be added to all pages in your project.
\n
New default theme available in the app: Mobirise 5. Start a new project and select the Mobirise 5 theme to check it.
\n
\n
\nInstall the Code Editor extension to find the Global HTML Insert tab in Site Settings\n
Mobirise v4.12.4
\n
\n
LazyLoad Extension fixes
\n
Social Icons are updated
\n
Form Builder Small fixes
\n
youtu.be links are supported now
\n
Fixed saving the Resize Images site setting
\n
Minor fixes
\n
\n
Mobirise v4.12
\n
\n
Important: After the 4.12 is installed, update your extensions in \"Menu->Extensions->Update All\" and then restart the Mobirise
\n
Compatibility with MacOs Catalina
\n
FTP profile is filled from a project file
\n
User Blocks search added
\n
Issues with project import/export with different fonts fixed
\n
Fixed saving the Resize Images site setting
\n
Blockpack for M4
\n
Minor fixes
\n
\n
DinerM4
\n
\n
DinerM4 - Great Bootstrap cafe theme. It's the perfect choice for owners of pizzerie, tea-houses, cafeterias and other restaurants.
\n
\n
\n
AudioM4
\n
\n
AudioM4 - Need a stunning website for your songs? Feel free to use this exceptional music theme with great looking designs!
\n
\n
\n
BlockPack for M4
\n
\n
BlockPack for M4 - 350+ best and most unique blocks from premium Mobirise themes. Compatible with all M4 themes.
\n
\n
\n
InnovationAMP
\n
\n
InnovationAMP - Multipurpose theme for corporate and science websites. Let your future website look innovative and ultra-modern!
\n
\n
\n
BranchM4
\n
\n
BranchM4 - Well-designed corporate theme for small and medium businesses. Use this theme to create a website for your company or agency with a unique and professional look.
\n
\n
\n
KidsM4 Theme
\n
\n
KidsM4 Theme - A cute website template perfect for preschools and babysitting. It also suits online stores selling children clothes and toys. Create a kids related site with ease!
\n
\n
\n
PetsM4 Theme
\n
\n
PetsM4 Theme - Contemporary pets website template. It's the ideal choice for animal care organizations, veterinarians and animal clinics.
\n
\n
\n
Mobirise v4.11.5
\n
\n
Issue with images in AMP themes fixed
\n
M4 themes are updates with fixes for gallery and shop block filters
\n
\n
Mobirise v4.11.4
\n
\n
Cookies Alert update: added the 'Explicit Consent' option which creates a cookie modal
\n
Mobirise4 Theme: fix color change for 'table1' block
\n
Editing galleries fixed
\n
The LazyLoad extension is available
\n
\n
\n
CourseAMP Theme
\n
\n
CourseAMP Theme - Sleek courses website theme spiced up with nice-looking designs and exciting animations. It's the best fit for online schools and web courses\nLive Demos: University, Consulting.
\n
\n
\n
Mobirise v4.11.2
\n
\n
Update of Code Editor extension. New features: Edit Block Anchor, Edit Site Styles.
\n
Edit user block name
\n
Choose a Social sharing image
\n
New Site Settings interface
\n
Fixed saving Site Styles
\n
Fixed publish Popup Builder on several pages in amp themes
\n
Fixed captcha
\n
Mobirise4 theme: fixed gallery styles, fixed line height
\n
\n
LuxuryM4 Theme
\n
\n
LuxuryM4 Theme - Wish to impress clients with your online luxury store? Easily create one in no longer than a few hours with this exclusive theme.
\n
\n
\n
TrainingAMP Theme
\n
\n
TrainingAMP Theme - Creating a great website for sport gyms, workout clubs and individual sportsmen with this website theme is just like 123. Start your own sport website with ease!
\n
\n
\n
InsightAMP Theme
\n
\n
InsightAMP Theme - Impressive corporate template for creating clean and minimalist websites for any kind of business. Increase yur brand exposure with this creative template.
\n
\n
\n
Mobirise v4.10.10
\n
\n
FormBuilder updated: The reCAPTCHA label support
\n
PWA Builder updated: iOS Support
\n
M4 optimization
\n
Facebook authorization fixed for Social Feed (partly)
\n
\n
PhotoM4 Theme
\n
\n
PhotoM4 Theme - Ideal theme for professional and hobby photographers. Build a stylish and clean website to impress anyone with beautiful galleries and portfolios.
\n
\n
\n
WoodM4 Theme
\n
\n
WoodM4 Theme - Have a carpentry shop, forestry manufacture or timber company? This theme helps you present your woodworks excellently.
\n
\n
\n
Mobirise v4.10.8
\n
\n
Form Builder updated. reCAPTCHA support and form submissions w/o the Mobirise label. More info
\n
Countdown blocks updated: floating point numbers supported now
\n
The issue with adding global components fixed
\n
\n
\n
Mobirise v4.10.7
\n
\n
Mobirise AMP: new slider block with bullets, new manager for galleries and sliders, you can select the link type now: to full screen image or to your link
\n
Page Settings: preview of your page in Google Search
\n
Remove unused CSS for AMP: fixes
\n
Batch adding images to gallery: fixes
\n
Mobirise Publish: now you can publish sites made in M themes
\n
Fixes for shop blocks
\n
\n
\n
PersonaM4 Theme
\n
\n
PersonaM4 Theme - A modern and lovely Bootstrap theme for creatives, freelancers, professionals, and creative studios.
\n
\n
\n
CorporateAMP Theme
\n
\n
CorporateAMP Theme - A minimalistic and laconic AMP theme for brands and digital agencies.
\n
\n
\n
ShopAMP Theme
\n
\n
ShopAMP Theme - An easy-to-use multipurpose AMP theme for creating websites to promote and offer every kind of services online.
\n
\n
\n
DepotAMP Theme
\n
\n
DepotAMP Theme - This elegant theme is perfect for stores to showcase goods, inform about discounts, present prices, and highlight special offers.
\n
\n
\n
Mobirise v4.10.6
\n
\n
Templates for sites are available in the app now
\n
Placeholder on empty pages
\n
The Search field in the Extensions list added
\n
The Crop Image functionality fixed
\n
Global blocks can be added on all pages and removed from all pages
\n
Code Editor is available offline for a longer time
\n
Popup Builder improvements: created popup blocks are available on all pages, minor fixes
\n
\n
\n
\n
Mobirise v4.10.5
\n
\n
Link Editor updated: messenger link types are added
\n
New thumbnails for extensions, the Create New Site dialog is updated
\n
Image crop feature updated, fixed for jpg images
\n
Fixed disappearing parameter buttons in top right corner of block
\n
Minor fixes for Mobirise4
\n
Fix update style of global component\nExtensions:
\n
PayPal Shopping Cart is updated: new look
\n
TechM4: new blocks, update for an accordion block
\n
PoliticsM4: reverse block feature for a team block
\n
Bug fixes in SimpleAMP, BusinessM4, AgencyM4
\n
\n
\n
\n
Mobirise v4.10.4
\n
\n
Editing extension blocks in M themes fixed (for example, popup builder)
\n
The menu fix in the MobiriseAMP theme
\n
The dropdown menu fix in M4 themes
\n
The gallery now keeps images in User Blocks
\n
The Extensions list is updated
\n
\n
Popup Builder
\n
\n
Create a modal/popup/lightbox with text, image, video, form. Live demo
PoliticsM4 Theme - If you represent a party, candidate, political organization or social movement, this theme will be your best match. It's perfect for government sites, campaign pages and other political websites.
\n
\n
\n
IndustryM4 Theme
\n
\n
IndustryM4 Theme - An eye-catching industrial website theme. Promote your company services and advertise your industrial business with a professionally built website.
\n
\n
\n
Mobirise v4.10.1
\n
\n
Site Library is optimized (it should work much faster now)
\n
Form fixes: the app doesn't hang if the long email addresses are used, forms work correctly in IE, minor fixes
\n
Issue with duplicating IDs on cloned pages fixed
\n
Mobirise 4 theme fixes: background video, features blocks
\n
Batch images adding: small fixes
\n
Smooth scroll fixed for M and M4 themes
\n
\n
Mobirise v4.10
\n
\n
Code Editor improvements
\n
Reverse mode for timeline blocks
\n
Remove unused CSS from AMP pages. This option is available in Site Settings. It noticeably reduces the number of CSS rules on a page and makes the size of inline CSS smaller. CSS you use on your page should not be larger than 50,000 bytes. Otherwise, pages are not AMP-valid. Use the option if you have many blocks on your pages. Please check carefully if your page elements are displayed correctly with this option enabled.
\n
\n
\n
\n
Bug fixes: menu block fixes; the active undo button in new projects disabled; italic/bold text color is preserved now; '$1' is shown after publication; lightbox incorrect size fixed; the reveal effect in Mobirise 4 footers is disabled for IE; images renaming fixed when use batch adding and 'Resize Images' turned off; other minor fixed.
\n
\n
TechM4 Theme
\n
\n
TechM4 Theme - This theme helps you build a powerful online presence for your tech business. Save time and effort when creating a top-notch website for your tech company.
\n
\n
\n
CompanyAMP Theme
\n
\n
CompanyAMP Theme - Stylish and universal theme for any type of companies. When building your company landing page, consider this captivating theme that sparks everyone's interest.
\n
\n
\n
SimpleAMP Theme
\n
\n
SimpleAMP Theme - Сreate neat and trim websites for service agencies, shops, and creatives. This mutipurpose template contains more than 50 various blocks.
\n
\n
\n
TasteM4 Theme
\n
\n
TasteM4 Theme is a fantastic and flexible clothing website theme. Benefit from the ready-made layouts. Build a website to your taste and present your brand in the best possible way.
\n
\n
\n
Mobirise v4.9.7
\n
\n
Extensions Social Feed, SoundCloud, Facebook Comments supported in AMP themes
\n
Online Image Library now saves the last active tab
\n
All themes are updated: small fixes and new FormBuilder extension support
\n
\n
FormBuilder Extension
\n
Use the drag-n-drop builder to draw up the form you want. Learn more
\n
\n
Create forms with complex layout, set the width of form fields
\n
Add your own labels, placeholders, default values, and input patterns
\n
Use the built-in Mobirise solution to receive submissions or use your own Action URL
\n
\n
\n
Mobirise v4.9.5
\n
\n
New \"Add Block\" panel: now with block categories
\n
\n
\n
\n
Online Image Library: enlarged preview on hover
\n
\n
\n
\n
Updated Mobirise4 and MobiriseAMP themes: fixes, new blocks
\n
Code Editor: fixed inserting scripts to custom HTML block
\n
Fix for menus (scroll-line on mobile view)
\n
Fixed tags in image galleries
\n
\n
Mobirise v4.9.3
\n
\n
'Update All' button for extensions with a progress bar
\n
\n
\n
\n
Adding images by drag and drop in Image Media
\n
\n
\n
\n
Adding multiple images at once to sliders and galleries (non-AMP themes)
\n
Updated M4 themes to latest Bootstrap v4.2.1
\n
Updated free MobiriseAMP theme - 20 new blocks: gallery, slider, accordion, contact forms, testimonials, google maps.
\n
Code Editor loading speed improved
\n
Bug fixes for Google Maps
\n
Fixes for editing menu colors
\n
Fixes with page cloning
\n
\n
LifestyleAMP Theme
\n
\n
LifestyleAMP Theme - Easily create a personal, fashion, relationshop and lifestyle website that will be a real eye candy and inspiration for everyone.
\n
\n
\n
WorkshopAMP Theme
\n
\n
WorkshopAMP Theme - If you offer repair services and have a workshop, this is the right theme for you.
\n
\n
\n
GamingAMP Theme
\n
\n
GamingAMP Theme is a dark and neat design will excite and entertain every video game fan that visits your website.
\n
\n
\n
Mobirise v4.9.1
\n
\n
Code Editor update:
\n
Mobirise mentions removal - clear the HTML code from \"made with Mobirise\" etc..
\n
New color schemes - light and contrast
\n
Undo-Redo buttons
\n
\n
\n
\n
PayPal Shopping Cart update:
\n
Support for AMP themes
\n
Subscribe and Donate options
\n
Info on \"How to add shipping, VAT, and tax.\"
\n
\n
\n
\n
Mobirise 4 default theme update: 15 new blocks, fixes
\n
AMP Canonical URL for AMP sites. Menu -> Sites -> Site Settings.
\n
Bug Fixes
\n
\n
StrategyAMP Theme
\n
\n
StrategyAMP is a solid, informative, laconic and smart template for strategies of any business spheres: design, content, social media, sales, and business development. It is also suitable for consulting agencies to present services and make them plain and attractive for clients.
\n
\n
\n
ChurchAMP Theme
\n
\n
ChurchAMP is a modern theme designed for churches and religious movements around the world. It is also suitable for creating a charity or charitable foundation website.
\n
\n
\n
Mobirise v4.8.6
\n
\n
Mobirise Icons are available for AMP themes now
\n
Mobirise 2 Icons added
\n
\n
\n
Mobirise v4.8.4
\n
\n
Publishing issues fixed
\n
Scroll-to-top button issues fixed
\n
Minor bug fixes
\n
\n
AppAMP Theme
\n
\n
AppAMP is a neat AMP theme best suited for landing pages showcasing your mobile and desktop apps.
\n
\n
\n
ConsultingAMP Theme
\n
\n
ConsultingAMP - an exclusive AMP theme to create a site for consulting and other professional services.
New Publish option allows you to put the site online with a single click, to be viewed by the public with your subdomain at mobirisesite.com\nWhat's included:
Lightning-fast global CDN (Content Delivery Network)
\n
Unlimited pages
\n
Unlimited space and bandwidth\nIMPORTANT! Currently this option is in beta status - please use it for testing only. The subdomains can be removed without a notice.
\n
\n
\n
SchoolAMP Theme
\n
\n
SchoolAMP - A trendy and neat looking theme for online schools. Use this theme to create a website for your school, courses, online lessons, and other educational services.
\n
\n
\n
EducationM4 Theme
\n
\n
EducationM4 - A flexible and modern educational theme. It is suitable for schools, colleges, online courses, and other educational institutions.
\n
\n
\n
RealtyM4 Theme
\n
\n
RealtyM4 Theme - An ultimate and modern real estate theme. It fulfills needs of realtors, agencies, real estate holdings when it comes to creating responsive and versatile websites to sell properties online.
\n
\n
\n
OrganicAMP Theme
\n
\n
OrganicAMP Theme - Mouth-watering and trendy AMP theme for building online food stores. It's ideal for launching vegetarian food shops, cooking websites and healthy nutrition pages.
\n
\n
\n
Mobirise v4.7.8
\n
\n
Bug Fixes for AMP Themes: video autoplay, map layout, video lightbox.
\n
\n
ResumeAMP Theme
\n
\n
ResumeAMP Theme - Lovely and creative AMP theme for creating online resumes. It is great for starting online profiles and portfolios.
\n
\n
\n
WeddingAMP Theme
\n
\n
WeddingAMP Theme - The lovely AMP theme for weddings, celebrations, and event planners.
ArchitectAMP - The AMP theme for architectural building, exterior design, and construction business owners.
\n
\n
\n
Mobirise v4.7.7
\n
\n
Improved app loading
\n
Fixed inserting icons in menu in m3 themes
\n
Fixed and updated translations
\n
Fixed disappearance of text placeholders
\n
Select all text on first click
\n
Fixed font dropdown panel height
\n
\n
Mobirise v4.7.6
\n
\n
Improved block reordering and dragging
\n
Bug fixes for projects loading
\n
AMP themes support improved
\n
Image optimization improved
\n
Updated translations: Spanish, Greek, Hungarian, Polish, Italian
\n
Updated login/signup dialog
\n
Minor bug fixes
\n
Mobirise for Android (works on Android 4.4+)
\n
\n
\n
HandymanAMP Theme
\n
\n
HandymanAMP Theme - Perfect theme for plumber or electrician, painter or similar craftsman, construction, handyman, carpenter, craftsman workshop or repair business website. AMP themes are compatible, and you can use blocks from HandymanAMP in other AMP themes provided by Mobirise. Ready site demos: Cleaning Services, Dream House, Repair Services.
\n
\n
\n
BeautyAMP Theme
\n
\n
BeautyAMP Theme - AMP theme for beauty studios, barber shops, tattoo salons, massage parlors, and gyms.
\n
\n
\n
SoundAMP Theme
\n
\n
SoundAMP Theme - The AMP theme for music industry sites. A great choice to present music producers, DJs, singers, record studions, music labels, bands and grounps, sound pros.
\n
\n
\n
Mobirise v4.7.2
\n
\n
Cookie Alert Extension updated - now it is \"Cookie Alert and GDPR Compliance\" - After activating GDPR compliance, all web forms on your website will have checkbox for agreeing to your Terms and Privacy Policy.
\n
Code Editor Extension updated - some fixes
\n
Different fixes in translation engine
\n
New AMP themes - StartupAMP and SpaceAMP
\n
\n
StartupAMP Theme
\n
\n
StartupAMP Theme - AMP theme for startup websites with rounded corners and deep gradient colors. View demo templates: Best Mobile App, Co-working Template, Business School Template.\nCheck available blocks: headers, features, tabs and accordions, content blocks, sliders and videos, social blocks and maps, footers.
\n
\n
\n
SpaceAMP Theme
\n
\n
SpaceAMP Theme - Clean and spacious AMP theme with 60+ slick blocks. View demo templates: Apartments for Sale, Beauty Salon, Health Food Store.\nCheck available blocks: headers, subscribe and form blocks, social blocks, map blocks, footer blocks, content blocks, text and titles blocks, news and team blocks, progress bars, accordions, counters and pricing tables, images, sliders, and video blocks.
\n
\n
\n
Mobirise v4.7.1
\n
\n
Scroll to top Button Issue fixed
\n
Images publication issue fixed
\n
\n
LightAMP Theme
\n
\n
LightAMP Theme - Large set of beautiful AMP blocks including sliders, timelines, lightboxes, tables, and media blocks. Based on AMP and compatible with other AMP themes in Mobirise. View demo templates: Interior Design, Dance School, Riding School.\nCheck available blocks: headers, menus, images & videos, features, articles, forms & maps, pricing tables, toggles & accordions, and footers.
\n
\n
\n
EventAMP Theme
\n
\n
EventAMP Theme - AMP-based remake of popular Mobirise3 theme. Good to promote your special events, meetings, presentations. View demo templates: Horizon Festival, Business Meet Up, Culinary Master Class.\nView blocks demos.
BusinessM4 Theme - Clean, light, responsive theme with gradients and shadows. Build websites to present your business and many more. BusinessM4 is compatible with Mobirise 4 Themes. View demo templates: Creative agency, Travel Agency. Check available blocks: headers, menus, images & videos, features, articles, call to action blocks, team blocks, forms & maps, pricing tables, clients & partners blocks, tabs & accordions, and footers.
\n
\n
\n
Mobirise v4.6.5
\n
\n
Bug fixes: Issue with missing projects fixed; Issue with missing user blocks fixed; Mobirise 3: sliders; Alignment in AgencyM4 and LawyerM4; Text style for forms in StoreM4
\n
Languages: Polish
\n
\n
CommerceM4 Theme
\n
\n
CommerceM4 Theme - A nice Bootstrap theme for commercial websites with some blocks to sell products. Present yourself, your products, your services, and your team. CommerceM4 is compatible with Mobirise 4 Themes. View demo templates: Cafe Demo, Shoes Demo, Headphones Demo. Check available blocks: headers, menus,images & videos, sliders & galleries, shops, features, content blocks, info blocks, team blocks and testimonials, forms & maps, pricing tables and tables, social blocks, countdowns & accordions, footers.
\n
\n
\n
HotelM4 Theme
\n
\n
HotelM4 Theme - Bootstrap theme for hotel and resort websites. HotelM4 is an M4 compatible theme. View live demos: menus, headers, features, images and videos, sliders and galleries, content blocks, forms, pricing tables, testimonials and team blocks, toggles and accordions, maps, info blocks, footers.
\n
\n
\n
Mobirise v4.6.0
\n
\n
Hotkey: if your Sites list is empty, you can load the list of previously used projects: open your Sites list and press Ctrl+Shift+L when it opened.
\n
Mobirise Translator extension: you can translate Mobirise interface to your language and share your translations with other users.
\n
\n
Mobirise AMP
\n
Mobirise AMP Theme - accelerate your site with Google AMP. Check AMP theme components demos: headers, images & videos, testimonials & info, features, articles, maps & social, footers.
\n
\n
Mobirise v4.5.0
\n
\n
Translation: German
\n
Bug fixes for saving User blocks
\n
Bug fixes for themes: Blockpack for Mobirise 3, AgencyM4, PortfolioM4, LawyerM4, DirectM, SpaceM\nTo change the interface language, open the main menu in the app, select the Account tab, and open App Settings.
\n
\n
\n
Mobirise v4.4.0
\n
\n
Now you can crop images right in Mobirise application
\n
Fixed compatibility with Internet Explorer in Mobirise 4 theme
\n
\n
\n
\n
Mobirise v4.3.5
\n
\n
StoreM4 Bootstrap Theme
\n
App Settings: \"Show All Block Buttons\" option added
\n
Bug Fixes:
\n
Mobirise4 Theme: Fix for counters
\n
Gallery Video - fixed youtube thumbnails in Mobirise 3 and Mobirise 4 compatible themes
\n
Links - fixed long domain in web address
\n
\n
StoreM4 Bootstrap Theme - spacious, clean and attractive ecommerce theme designed mainly for stores. 80+ blocks for your new online shop. This theme includes several menu blocks, headers, sliders and galleries, shops, content and info sections, pricing tables, testimonials, team blocks and more. StoreM4 is compatible with Mobirise 4 themes - you can interchange user blocks between your projects.
\n
\n
Mobirise v4.3.4
\n
\n
Facebook and Google Authorization: Now you can sign up using your Google and Facebook accounts.
\n
Clone Sites - clone not only pages, but also entire sites.
\n
App settings - open your Menu->Account->App settings to adjust your app settings: show the redo button, the tablet view mode, keep the Site Styles button shown.
\n
FTP publishing fixes
\n
Mobirise Help Center - visit our Help Center if you have some issues, and if you can't find a solution, you can visit our forums or contact our Support Team.
\n
\n
\n
\n
\n
\n
PortfolioM4 Bootstrap Theme - Modern and bright theme to present your projects - for designers, illustrators, artists, and developers. Comes with moving background intro, \"typed\" effect, step-by-step process, our clients, portfoilio gallery, counters, about me blocks. PortfolioM4 is compatible with Mobirise 4 themes - you can interchange user blocks between your projects.
\n
\n
\n
Mobirise v4.3.1
\n
\n
Built-in \"Mobirise Icons Bold\" icon font
\n
\"Icons\" extension updated. Now 8700+ icons total
\n
New fonts: Icon54 v.3, Icon54 v.4, Simple Line Icons, \"Font Awesome\" updated
\n
Site Library:\nFixed bug with removing images that are used on site\nFixed hanging\nFixed bug with duplication of images
\n
Mobirise4: fixed bug with buttons in 'pricing tables'
\n
Fixed vimeo thumbnails in gallery
\n
\"Link to\" dialog: \"open in new window\" is added to the \"file\" tab
\n
\n
Mobirise v4.3.0
\n
\n
New \"Link to\" dialog with: Option to add files to site and link them (pdf, doc, xls, etc..); Email; Phone; Web Address
\n
Updated PayPal Shopping Cart
\n
Fixed duplicated images on publishing
\n
Minor fixes
\n
LawyerM4 Bootstrap Theme - Dark, minimal and tidy theme for lawyers, legal firms, attorneys and related legal professionals. LawyerM4 is compatible with Mobirise 4 themes - you can interchange user blocks between your projects.
New AgencyM4 Theme. Theme for companies and agencies with 70+ blocks. New gradient overlays, working hours sections, and an extended set of dropdown menus and intro sections. AgencyM4 is compatible with Mobirise 4 Theme: you can move Mobirise4 and AgencyM4 user blocks between your projects.
\n
WOW Slider extension fixed
\n
Extensions updated – Social Feed, Social Comments, SoundCloud
\n
Compatibility issue with some 3rd-party themes fixed (Clarus, Sleek, Unicore..)
\n
Site thumbnail creation fixed
\n
Fix: WOWSlider extension
\n
Update: Home pages in Italian (please contact at support@mobirise.com if you find mistakes in texts)
Bootstrap updated to latest v4.0.0-beta (for Mobirise4 theme only)
\n
Fix: Fonts crush on start
\n
Fix: Bug in images publishing
\n
Fix: Parameters in extension blocks
\n
Fix: WOWSlider extension
\n
Update: Home pages in Chinese, Slovak, Polish, French, Albanian, Finnish, Swedish, Japanese, Portugal (please contact at support@mobirise.com if you find mistakes in texts)
\n
\n
Mobirise v4.1.6
\n
Search by font name in Google font library
\n
\n
Fix: \"Browse computer for image\" doesn't save last dir
\n
Fix: Hot key COPY/PASTE on Mac
\n
Fix: \"Clone page\" doesn't work with some blocks
\n
Fix: Rubik Google font bug on Windows
\n
Update: Home pages in German, Spanish, Danish, Norwegian, Dutch, Russian (please contact at support@mobirise.com if you find mistakes in texts)
\n
\n
Mobirise v4.1
\n
\n
Brand-new core engine - the app works much faster and smoother now
Bootstrap website builder makes it very easy to prototype, test, and build a custom responsive website quickly, without having to understand the Bootstrap framework system. They, although different in capabilities, all offer a form of drag-and-drop functionality that fully utilizes the enormous library of Bootstrap’s components.\n\n\n
Adding a css image gallery to your website does not need to be difficult or time-consuming. There are a wide range of options to choose from, whether you opt to go with the standard html5 image gallery, to customize it using one of a wide-range of plugins and tutorials or if you opt for Mobirise’s drag-and-drop builder. Good luck with your website!\n\n\n
The bootstrap image slider component that comes with the bootstrap framework is a lightweight carousel which uses JavaScript. It’s a standards-compliant piece of functionality, with a clean design that will fit easily into any website. It’s also easy to modify and extend with additional functionality such as CSS3 animations and more.\n\n\n
Today you are able to use different techniques and tools, from using an open-source CMS such as WordPress along with a free theme, to using website building software.\nMobirise is one such website builder. Website software has a few advantages over a CMS...\n\n\n
\n
Drag and drop website builder
\n
Make your own mobile website in minutes! Mobirise helps you cut down development time by providing you with a flexible website editor with a drag and drop interface.
\n
Live preview
\n
See the result instantly without a need to save or export!
\n
Modern styles
\n
Mobirise has provided for website developers a growing library of modern blocks which can be used either partially or in full for every website developed through the builder.
\n
Bootstrap 3
\n
Bootstrap 3 has been noted as one of the most reliable and proven frameworks and Mobirise has been equipped to develop websites using this framework.
\n
Create a beautiful website.
\n
Whether you want to create a blog, eCommerce store, portfolio, or all of the above, you can express your idea with a website powered by our elegant yet intuitive platform.
Bootstrap website builder makes it very easy to prototype, test, and build a custom responsive website quickly, without having to understand the Bootstrap framework system. They, although different in capabilities, all offer a form of drag-and-drop functionality that fully utilizes the enormous library of Bootstrap’s components.\n\n\n
Adding a css image gallery to your website does not need to be difficult or time-consuming. There are a wide range of options to choose from, whether you opt to go with the standard html5 image gallery, to customize it using one of a wide-range of plugins and tutorials or if you opt for Mobirise’s drag-and-drop builder. Good luck with your website!\n\n\n
The bootstrap image slider component that comes with the bootstrap framework is a lightweight carousel which uses JavaScript. It’s a standards-compliant piece of functionality, with a clean design that will fit easily into any website. It’s also easy to modify and extend with additional functionality such as CSS3 animations and more.\n\n\n
Today you are able to use different techniques and tools, from using an open-source CMS such as WordPress along with a free theme, to using website building software.\nMobirise is one such website builder. Website software has a few advantages over a CMS...\n\n\n
\n
Drag and drop website builder
\n
Make your own mobile website in minutes! Mobirise helps you cut down development time by providing you with a flexible website editor with a drag and drop interface.
\n
Live preview
\n
See the result instantly without a need to save or export!
\n
Modern styles
\n
Mobirise has provided for website developers a growing library of modern blocks which can be used either partially or in full for every website developed through the builder.
\n
Bootstrap 3
\n
Bootstrap 3 has been noted as one of the most reliable and proven frameworks and Mobirise has been equipped to develop websites using this framework.
\n
Create a beautiful website.
\n
Whether you want to create a blog, eCommerce store, portfolio, or all of the above, you can express your idea with a website powered by our elegant yet intuitive platform.
\n
",
+ "readmeOriginal": "
Mobirise Bootstrap Builder
\n
Mobirise AMP Website Builder
\n
The Accelerated Mobile Pages Project (AMP) is an online publishing format, originally created by Google as an alternative to Facebook’s Instant Articles. It’s a way to optimize web pages for mobile browsing using a special code–AMP-HTML.
\n
\n
AMP sites are loading smoothly and fast. Users like pages they don't have to wait, so you keep your visitors.
\n
Goggle Search adds to AMP articles an AMP iсon, and when you use a mobile device, these pages are shown first.
\n
AMP is a great solution for internet magazines, blogs and news sites.
\n
\n
\n
Mobirise 5.3
\n
Interface
\n
Design
\n
\n
New loader look
\n
Scrollbar styling added
\n
\n
\n
\n
Added dark inline editor panel in the dark mode
\n
\n
\n
Sites management
\n
\n
Now you can create sites based on a template from another theme
\n
Sites panel - search by name & domain added
\n
Create New Site panel - newest themes shown on top of the list
\n
Search through all templates when adding a new page: go to Pages and click Create New Page to see the list of available templates
\n
\n
\n
Drag Block to Page panel
\n
\n
Search through all Mobirise blocks
\n
\n
\n
\n
Added Show More buttons at the end of each blocks' group
\n
\n
\n
\n
Updated block groups (added new block groups, renamed and sorted the old ones) for free Mobirise themes
\n
Added shadows to the show more blocks button on hover
\n
Added new blocks categories to default themes, fixed the search for similar blocks
\n
\n
Domain connection
\n
\n
Updated DNS records: new DNS record types available
\n
Connecting domain via CNAME record added
\n
\n
Extensions panel
\n
\n
Added Add All button
\n
\n
\n
Code Editor
\n
\n
Highlight matching tags in HTML
\n
\n
\n
Icons
\n
\n
SVG icons instead of iconfont files in pages to improve loading speed
\n
\n
Other updates
\n
\n
Improved loading speed of user sites by optimized connection of Google Fonts
\n
If there is something wrong with the project code, you'll see a note about an issue
\n
\n
Themes
\n
Mobirise 5
\n
\n
Added compatibility with the Form Builder extension
\n
Fixes for alignment on mobile devices
\n
Fixes for logo images in the navbar
\n
Fixed the scroll-to-top arrow on mobile view
\n
Added paddings to the logo in the menu
\n
Socicon plugin font now supports \"font-display: swap\" for better optimization
\n
Fixed menu brand name underline
\n
New block categories
\n
\n
AudioM4
\n
\n
Features 3, 4, 6: Changed background images to usual img, to have an opportunity to insert link on image
\n
Features 4, 6: Added the ability to disable swinging and glare animation
\n
Added square cards option (square music album covers are the industry standard)
\n
Added range parameter to change size of cover
\n
Added buttons option (if all animation is enabled, there may be problems with following the link in the image, despite the accepted changes)
\n
\n
LuxuryM4
\n
\n
Fixed incompatibility issues with Mobirise 5
\n
Fixed broken logos in the menu
\n
Aligning pictures in team2
\n
Moving the send button in form1 and form3, an extra once global attributes in form 2
\n
\n
BusinessM4
\n
\n
Fixed images in Clients1
\n
Renamed all images in clients-white folder, to avoid intersections with images from clients folder after publication or preview
\n
\n
TherapyM4
\n
\n
Fixed team2 uneditable card content
\n
Added pointer-events rules, to be able to edit the text and link that appear on image hover
\n
\n
KidsM4
\n
\n
Fixes for options for menu background & text color option on mobile
\n
\n
ConnectM4
\n
\n
Reduced resolution to upscale the font-size from 1200 to 1199px and 992 to 991px
\n
\n
KidsM4 & AgencyM4
\n
\n
Fixed incompatibility issues with Mobirise 5, fixed the codestyle and menu, added theme classes
\n
\n
LightAMP
\n
\n
Fixed bugs in menus
\n
\n
Fixes
\n
\n
Github publishing method fixed
\n
Fixed and updated DNS records: new DNS record types available
\n
Extensions panel - fixed the search
\n
Fixed the position for the custom HTML block
\n
Fixes for the theme installation when choosing an unavailable theme
\n
App Settings - fixed saving Remove Mobirise from HTML setting
\n
Link-editor: fixed shop links in AMP themes
\n
Fixes for the fonts connection issue
\n
\n
Mobirise 5.2
\n
Core
\n
\n
Bootstrap version updated in the app to 4.5.2
\n
Electron version updated in the app to v10
\n
\n
Interface
\n
\n
New Blocks Menu panel. Browse through blocks more conveniently due to the enlarged page view
\n
\n
\n
\n
Spellchecker: check and correct mistakes directly in the app
\n
Add Blocks List: all compatible blocks are available w/o theme reloading and user blocks. Select a compatible theme to see a blocks list
\n
\n
\n
\n
Pages List: Search available
\n
\n
\n
\n
You can download all the extensions available for you. Open the Extensions list and press Ctrl+Shift+A
\n
Don't show again option for remove block, create site and open site dialogs.
\n
Updated Remove Unused Images
\n
Faster Sites panel
\n
\n
Mobirise 5 theme
\n
\n
Ghost Button Border option in Site Styles
\n
5 new blocks - headers and footers
\n
Logo Size option for footers
\n
Fixes in some block designs
\n
Fix with tab anchor renaming
\n
Duplicated code and CSS removed
\n
Some fixes in block designs
\n
\n
Fixes
\n
\n
Fix in Code Editor \"click twice to save\"
\n
Fix for \"Social Sharing Image\"
\n
Fix for sorting blocks
\n
Google maps fix
\n
Code syntax verification fix in Code Editor
\n
Fix for custom HTML in M3
\n
\n
Mobirise 5.0
\n
Core
\n
\n
Brand-new engine. The app is upto 2 time faster, especially on large projects.
\n
Bootstrap version updated in the app to 4.5.0
\n
jQuery version updated in the app to v3.5.1
\n
Themes can be added faster (the app is not reloading if the theme is not current)
\n
\n
Interface
\n
\n
Light/Dark mode. The Light mode is enabled by default in the app now. But if it's more comfortable for your to use the dark mode, open app settings (Menu -> Account -> App Settings -> Editor -> Dark Mode)
\n
The Remove Unused Images button added in Site Library.
\n
Sites published on Mobirise servers are shown in the Sites list now. If you remove them, they will not be available online anymore
\n
New Sites panel available in the app. Now it's in a full-screen mode
\n
Image Editor: New function in Image Editor: Rotate
\n
Favicon and page name are shown in navbar
\n
Canvas with borders. You can disable this feature in your app settings (Menu -> Account -> App Settings -> Editor -> Fullscreen Canvas).
\n
You can connect your site domain with the site published via the Mobirise Publish option. Find this feature in your Site Settings after publishing your site.
\n
\n
\nNew Sites List view available in Mobirise 5\n
\nYou can enable Dark Mode in App Settings\n
\nYou can disable your project borders by enabling the Fullscreen Canvas option\n
\nClear your site library by removing images you don't use in a project\n
\nThe site domain settings will appear in your Site Settings after publishing your site via the Mobirise Publish option\n
Fixes
\n
\n
Saving user blocks is fixed
\n
AMP Cache issue fixed. Earlier some of our users faced some issues with AMP blocks: galleries, sliders, accordions were not usable because of saved cached files. There was no simple way to clear the cache folder. This issue is fixed now.
\n
Sliders and Galleries optimized in the app. This fix may not affect already created galleries, but new galleries and sliders should work faster
\n
Mobirise 4 Theme: youtu.be links are supported, forms are cleared after submitting, gallery and form fixes
\n
MobiriseAMP Theme: update menu, fixed 'scroll to top button'
\n
Issue with $ symbols cleared is fixed
\n
Parallax fixes
\n
Link Editor: WhatsApp link fixed
\n
Form Builder fixes
\n
Google Maps fixed
\n
\n
Extensions
\n
\n
Code Editor: Global HTML Insert available in Site Settings. You can add the HTML lang tag in it and add code snippets to the various parts of your pages. Since this feature is global, your code will be added to all pages in your project.
\n
New default theme available in the app: Mobirise 5. Start a new project and select the Mobirise 5 theme to check it.
\n
\n
\nInstall the Code Editor extension to find the Global HTML Insert tab in Site Settings\n
Mobirise v4.12.4
\n
\n
LazyLoad Extension fixes
\n
Social Icons are updated
\n
Form Builder Small fixes
\n
youtu.be links are supported now
\n
Fixed saving the Resize Images site setting
\n
Minor fixes
\n
\n
Mobirise v4.12
\n
\n
Important: After the 4.12 is installed, update your extensions in \"Menu->Extensions->Update All\" and then restart the Mobirise
\n
Compatibility with MacOs Catalina
\n
FTP profile is filled from a project file
\n
User Blocks search added
\n
Issues with project import/export with different fonts fixed
\n
Fixed saving the Resize Images site setting
\n
Blockpack for M4
\n
Minor fixes
\n
\n
DinerM4
\n
\n
DinerM4 - Great Bootstrap cafe theme. It's the perfect choice for owners of pizzerie, tea-houses, cafeterias and other restaurants.
\n
\n
\n
AudioM4
\n
\n
AudioM4 - Need a stunning website for your songs? Feel free to use this exceptional music theme with great looking designs!
\n
\n
\n
BlockPack for M4
\n
\n
BlockPack for M4 - 350+ best and most unique blocks from premium Mobirise themes. Compatible with all M4 themes.
\n
\n
\n
InnovationAMP
\n
\n
InnovationAMP - Multipurpose theme for corporate and science websites. Let your future website look innovative and ultra-modern!
\n
\n
\n
BranchM4
\n
\n
BranchM4 - Well-designed corporate theme for small and medium businesses. Use this theme to create a website for your company or agency with a unique and professional look.
\n
\n
\n
KidsM4 Theme
\n
\n
KidsM4 Theme - A cute website template perfect for preschools and babysitting. It also suits online stores selling children clothes and toys. Create a kids related site with ease!
\n
\n
\n
PetsM4 Theme
\n
\n
PetsM4 Theme - Contemporary pets website template. It's the ideal choice for animal care organizations, veterinarians and animal clinics.
\n
\n
\n
Mobirise v4.11.5
\n
\n
Issue with images in AMP themes fixed
\n
M4 themes are updates with fixes for gallery and shop block filters
\n
\n
Mobirise v4.11.4
\n
\n
Cookies Alert update: added the 'Explicit Consent' option which creates a cookie modal
\n
Mobirise4 Theme: fix color change for 'table1' block
\n
Editing galleries fixed
\n
The LazyLoad extension is available
\n
\n
\n
CourseAMP Theme
\n
\n
CourseAMP Theme - Sleek courses website theme spiced up with nice-looking designs and exciting animations. It's the best fit for online schools and web courses\nLive Demos: University, Consulting.
\n
\n
\n
Mobirise v4.11.2
\n
\n
Update of Code Editor extension. New features: Edit Block Anchor, Edit Site Styles.
\n
Edit user block name
\n
Choose a Social sharing image
\n
New Site Settings interface
\n
Fixed saving Site Styles
\n
Fixed publish Popup Builder on several pages in amp themes
\n
Fixed captcha
\n
Mobirise4 theme: fixed gallery styles, fixed line height
\n
\n
LuxuryM4 Theme
\n
\n
LuxuryM4 Theme - Wish to impress clients with your online luxury store? Easily create one in no longer than a few hours with this exclusive theme.
\n
\n
\n
TrainingAMP Theme
\n
\n
TrainingAMP Theme - Creating a great website for sport gyms, workout clubs and individual sportsmen with this website theme is just like 123. Start your own sport website with ease!
\n
\n
\n
InsightAMP Theme
\n
\n
InsightAMP Theme - Impressive corporate template for creating clean and minimalist websites for any kind of business. Increase yur brand exposure with this creative template.
\n
\n
\n
Mobirise v4.10.10
\n
\n
FormBuilder updated: The reCAPTCHA label support
\n
PWA Builder updated: iOS Support
\n
M4 optimization
\n
Facebook authorization fixed for Social Feed (partly)
\n
\n
PhotoM4 Theme
\n
\n
PhotoM4 Theme - Ideal theme for professional and hobby photographers. Build a stylish and clean website to impress anyone with beautiful galleries and portfolios.
\n
\n
\n
WoodM4 Theme
\n
\n
WoodM4 Theme - Have a carpentry shop, forestry manufacture or timber company? This theme helps you present your woodworks excellently.
\n
\n
\n
Mobirise v4.10.8
\n
\n
Form Builder updated. reCAPTCHA support and form submissions w/o the Mobirise label. More info
\n
Countdown blocks updated: floating point numbers supported now
\n
The issue with adding global components fixed
\n
\n
\n
Mobirise v4.10.7
\n
\n
Mobirise AMP: new slider block with bullets, new manager for galleries and sliders, you can select the link type now: to full screen image or to your link
\n
Page Settings: preview of your page in Google Search
\n
Remove unused CSS for AMP: fixes
\n
Batch adding images to gallery: fixes
\n
Mobirise Publish: now you can publish sites made in M themes
\n
Fixes for shop blocks
\n
\n
\n
PersonaM4 Theme
\n
\n
PersonaM4 Theme - A modern and lovely Bootstrap theme for creatives, freelancers, professionals, and creative studios.
\n
\n
\n
CorporateAMP Theme
\n
\n
CorporateAMP Theme - A minimalistic and laconic AMP theme for brands and digital agencies.
\n
\n
\n
ShopAMP Theme
\n
\n
ShopAMP Theme - An easy-to-use multipurpose AMP theme for creating websites to promote and offer every kind of services online.
\n
\n
\n
DepotAMP Theme
\n
\n
DepotAMP Theme - This elegant theme is perfect for stores to showcase goods, inform about discounts, present prices, and highlight special offers.
\n
\n
\n
Mobirise v4.10.6
\n
\n
Templates for sites are available in the app now
\n
Placeholder on empty pages
\n
The Search field in the Extensions list added
\n
The Crop Image functionality fixed
\n
Global blocks can be added on all pages and removed from all pages
\n
Code Editor is available offline for a longer time
\n
Popup Builder improvements: created popup blocks are available on all pages, minor fixes
\n
\n
\n
\n
Mobirise v4.10.5
\n
\n
Link Editor updated: messenger link types are added
\n
New thumbnails for extensions, the Create New Site dialog is updated
\n
Image crop feature updated, fixed for jpg images
\n
Fixed disappearing parameter buttons in top right corner of block
\n
Minor fixes for Mobirise4
\n
Fix update style of global component\nExtensions:
\n
PayPal Shopping Cart is updated: new look
\n
TechM4: new blocks, update for an accordion block
\n
PoliticsM4: reverse block feature for a team block
\n
Bug fixes in SimpleAMP, BusinessM4, AgencyM4
\n
\n
\n
\n
Mobirise v4.10.4
\n
\n
Editing extension blocks in M themes fixed (for example, popup builder)
\n
The menu fix in the MobiriseAMP theme
\n
The dropdown menu fix in M4 themes
\n
The gallery now keeps images in User Blocks
\n
The Extensions list is updated
\n
\n
Popup Builder
\n
\n
Create a modal/popup/lightbox with text, image, video, form. Live demo
PoliticsM4 Theme - If you represent a party, candidate, political organization or social movement, this theme will be your best match. It's perfect for government sites, campaign pages and other political websites.
\n
\n
\n
IndustryM4 Theme
\n
\n
IndustryM4 Theme - An eye-catching industrial website theme. Promote your company services and advertise your industrial business with a professionally built website.
\n
\n
\n
Mobirise v4.10.1
\n
\n
Site Library is optimized (it should work much faster now)
\n
Form fixes: the app doesn't hang if the long email addresses are used, forms work correctly in IE, minor fixes
\n
Issue with duplicating IDs on cloned pages fixed
\n
Mobirise 4 theme fixes: background video, features blocks
\n
Batch images adding: small fixes
\n
Smooth scroll fixed for M and M4 themes
\n
\n
Mobirise v4.10
\n
\n
Code Editor improvements
\n
Reverse mode for timeline blocks
\n
Remove unused CSS from AMP pages. This option is available in Site Settings. It noticeably reduces the number of CSS rules on a page and makes the size of inline CSS smaller. CSS you use on your page should not be larger than 50,000 bytes. Otherwise, pages are not AMP-valid. Use the option if you have many blocks on your pages. Please check carefully if your page elements are displayed correctly with this option enabled.
\n
\n
\n
\n
Bug fixes: menu block fixes; the active undo button in new projects disabled; italic/bold text color is preserved now; '$1' is shown after publication; lightbox incorrect size fixed; the reveal effect in Mobirise 4 footers is disabled for IE; images renaming fixed when use batch adding and 'Resize Images' turned off; other minor fixed.
\n
\n
TechM4 Theme
\n
\n
TechM4 Theme - This theme helps you build a powerful online presence for your tech business. Save time and effort when creating a top-notch website for your tech company.
\n
\n
\n
CompanyAMP Theme
\n
\n
CompanyAMP Theme - Stylish and universal theme for any type of companies. When building your company landing page, consider this captivating theme that sparks everyone's interest.
\n
\n
\n
SimpleAMP Theme
\n
\n
SimpleAMP Theme - Сreate neat and trim websites for service agencies, shops, and creatives. This mutipurpose template contains more than 50 various blocks.
\n
\n
\n
TasteM4 Theme
\n
\n
TasteM4 Theme is a fantastic and flexible clothing website theme. Benefit from the ready-made layouts. Build a website to your taste and present your brand in the best possible way.
\n
\n
\n
Mobirise v4.9.7
\n
\n
Extensions Social Feed, SoundCloud, Facebook Comments supported in AMP themes
\n
Online Image Library now saves the last active tab
\n
All themes are updated: small fixes and new FormBuilder extension support
\n
\n
FormBuilder Extension
\n
Use the drag-n-drop builder to draw up the form you want. Learn more
\n
\n
Create forms with complex layout, set the width of form fields
\n
Add your own labels, placeholders, default values, and input patterns
\n
Use the built-in Mobirise solution to receive submissions or use your own Action URL
\n
\n
\n
Mobirise v4.9.5
\n
\n
New \"Add Block\" panel: now with block categories
\n
\n
\n
\n
Online Image Library: enlarged preview on hover
\n
\n
\n
\n
Updated Mobirise4 and MobiriseAMP themes: fixes, new blocks
\n
Code Editor: fixed inserting scripts to custom HTML block
\n
Fix for menus (scroll-line on mobile view)
\n
Fixed tags in image galleries
\n
\n
Mobirise v4.9.3
\n
\n
'Update All' button for extensions with a progress bar
\n
\n
\n
\n
Adding images by drag and drop in Image Media
\n
\n
\n
\n
Adding multiple images at once to sliders and galleries (non-AMP themes)
\n
Updated M4 themes to latest Bootstrap v4.2.1
\n
Updated free MobiriseAMP theme - 20 new blocks: gallery, slider, accordion, contact forms, testimonials, google maps.
\n
Code Editor loading speed improved
\n
Bug fixes for Google Maps
\n
Fixes for editing menu colors
\n
Fixes with page cloning
\n
\n
LifestyleAMP Theme
\n
\n
LifestyleAMP Theme - Easily create a personal, fashion, relationshop and lifestyle website that will be a real eye candy and inspiration for everyone.
\n
\n
\n
WorkshopAMP Theme
\n
\n
WorkshopAMP Theme - If you offer repair services and have a workshop, this is the right theme for you.
\n
\n
\n
GamingAMP Theme
\n
\n
GamingAMP Theme is a dark and neat design will excite and entertain every video game fan that visits your website.
\n
\n
\n
Mobirise v4.9.1
\n
\n
Code Editor update:
\n
Mobirise mentions removal - clear the HTML code from \"made with Mobirise\" etc..
\n
New color schemes - light and contrast
\n
Undo-Redo buttons
\n
\n
\n
\n
PayPal Shopping Cart update:
\n
Support for AMP themes
\n
Subscribe and Donate options
\n
Info on \"How to add shipping, VAT, and tax.\"
\n
\n
\n
\n
Mobirise 4 default theme update: 15 new blocks, fixes
\n
AMP Canonical URL for AMP sites. Menu -> Sites -> Site Settings.
\n
Bug Fixes
\n
\n
StrategyAMP Theme
\n
\n
StrategyAMP is a solid, informative, laconic and smart template for strategies of any business spheres: design, content, social media, sales, and business development. It is also suitable for consulting agencies to present services and make them plain and attractive for clients.
\n
\n
\n
ChurchAMP Theme
\n
\n
ChurchAMP is a modern theme designed for churches and religious movements around the world. It is also suitable for creating a charity or charitable foundation website.
\n
\n
\n
Mobirise v4.8.6
\n
\n
Mobirise Icons are available for AMP themes now
\n
Mobirise 2 Icons added
\n
\n
\n
Mobirise v4.8.4
\n
\n
Publishing issues fixed
\n
Scroll-to-top button issues fixed
\n
Minor bug fixes
\n
\n
AppAMP Theme
\n
\n
AppAMP is a neat AMP theme best suited for landing pages showcasing your mobile and desktop apps.
\n
\n
\n
ConsultingAMP Theme
\n
\n
ConsultingAMP - an exclusive AMP theme to create a site for consulting and other professional services.
New Publish option allows you to put the site online with a single click, to be viewed by the public with your subdomain at mobirisesite.com\nWhat's included:
Lightning-fast global CDN (Content Delivery Network)
\n
Unlimited pages
\n
Unlimited space and bandwidth\nIMPORTANT! Currently this option is in beta status - please use it for testing only. The subdomains can be removed without a notice.
\n
\n
\n
SchoolAMP Theme
\n
\n
SchoolAMP - A trendy and neat looking theme for online schools. Use this theme to create a website for your school, courses, online lessons, and other educational services.
\n
\n
\n
EducationM4 Theme
\n
\n
EducationM4 - A flexible and modern educational theme. It is suitable for schools, colleges, online courses, and other educational institutions.
\n
\n
\n
RealtyM4 Theme
\n
\n
RealtyM4 Theme - An ultimate and modern real estate theme. It fulfills needs of realtors, agencies, real estate holdings when it comes to creating responsive and versatile websites to sell properties online.
\n
\n
\n
OrganicAMP Theme
\n
\n
OrganicAMP Theme - Mouth-watering and trendy AMP theme for building online food stores. It's ideal for launching vegetarian food shops, cooking websites and healthy nutrition pages.
\n
\n
\n
Mobirise v4.7.8
\n
\n
Bug Fixes for AMP Themes: video autoplay, map layout, video lightbox.
\n
\n
ResumeAMP Theme
\n
\n
ResumeAMP Theme - Lovely and creative AMP theme for creating online resumes. It is great for starting online profiles and portfolios.
\n
\n
\n
WeddingAMP Theme
\n
\n
WeddingAMP Theme - The lovely AMP theme for weddings, celebrations, and event planners.
ArchitectAMP - The AMP theme for architectural building, exterior design, and construction business owners.
\n
\n
\n
Mobirise v4.7.7
\n
\n
Improved app loading
\n
Fixed inserting icons in menu in m3 themes
\n
Fixed and updated translations
\n
Fixed disappearance of text placeholders
\n
Select all text on first click
\n
Fixed font dropdown panel height
\n
\n
Mobirise v4.7.6
\n
\n
Improved block reordering and dragging
\n
Bug fixes for projects loading
\n
AMP themes support improved
\n
Image optimization improved
\n
Updated translations: Spanish, Greek, Hungarian, Polish, Italian
\n
Updated login/signup dialog
\n
Minor bug fixes
\n
Mobirise for Android (works on Android 4.4+)
\n
\n
\n
HandymanAMP Theme
\n
\n
HandymanAMP Theme - Perfect theme for plumber or electrician, painter or similar craftsman, construction, handyman, carpenter, craftsman workshop or repair business website. AMP themes are compatible, and you can use blocks from HandymanAMP in other AMP themes provided by Mobirise. Ready site demos: Cleaning Services, Dream House, Repair Services.
\n
\n
\n
BeautyAMP Theme
\n
\n
BeautyAMP Theme - AMP theme for beauty studios, barber shops, tattoo salons, massage parlors, and gyms.
\n
\n
\n
SoundAMP Theme
\n
\n
SoundAMP Theme - The AMP theme for music industry sites. A great choice to present music producers, DJs, singers, record studions, music labels, bands and grounps, sound pros.
\n
\n
\n
Mobirise v4.7.2
\n
\n
Cookie Alert Extension updated - now it is \"Cookie Alert and GDPR Compliance\" - After activating GDPR compliance, all web forms on your website will have checkbox for agreeing to your Terms and Privacy Policy.
\n
Code Editor Extension updated - some fixes
\n
Different fixes in translation engine
\n
New AMP themes - StartupAMP and SpaceAMP
\n
\n
StartupAMP Theme
\n
\n
StartupAMP Theme - AMP theme for startup websites with rounded corners and deep gradient colors. View demo templates: Best Mobile App, Co-working Template, Business School Template.\nCheck available blocks: headers, features, tabs and accordions, content blocks, sliders and videos, social blocks and maps, footers.
\n
\n
\n
SpaceAMP Theme
\n
\n
SpaceAMP Theme - Clean and spacious AMP theme with 60+ slick blocks. View demo templates: Apartments for Sale, Beauty Salon, Health Food Store.\nCheck available blocks: headers, subscribe and form blocks, social blocks, map blocks, footer blocks, content blocks, text and titles blocks, news and team blocks, progress bars, accordions, counters and pricing tables, images, sliders, and video blocks.
\n
\n
\n
Mobirise v4.7.1
\n
\n
Scroll to top Button Issue fixed
\n
Images publication issue fixed
\n
\n
LightAMP Theme
\n
\n
LightAMP Theme - Large set of beautiful AMP blocks including sliders, timelines, lightboxes, tables, and media blocks. Based on AMP and compatible with other AMP themes in Mobirise. View demo templates: Interior Design, Dance School, Riding School.\nCheck available blocks: headers, menus, images & videos, features, articles, forms & maps, pricing tables, toggles & accordions, and footers.
\n
\n
\n
EventAMP Theme
\n
\n
EventAMP Theme - AMP-based remake of popular Mobirise3 theme. Good to promote your special events, meetings, presentations. View demo templates: Horizon Festival, Business Meet Up, Culinary Master Class.\nView blocks demos.
BusinessM4 Theme - Clean, light, responsive theme with gradients and shadows. Build websites to present your business and many more. BusinessM4 is compatible with Mobirise 4 Themes. View demo templates: Creative agency, Travel Agency. Check available blocks: headers, menus, images & videos, features, articles, call to action blocks, team blocks, forms & maps, pricing tables, clients & partners blocks, tabs & accordions, and footers.
\n
\n
\n
Mobirise v4.6.5
\n
\n
Bug fixes: Issue with missing projects fixed; Issue with missing user blocks fixed; Mobirise 3: sliders; Alignment in AgencyM4 and LawyerM4; Text style for forms in StoreM4
\n
Languages: Polish
\n
\n
CommerceM4 Theme
\n
\n
CommerceM4 Theme - A nice Bootstrap theme for commercial websites with some blocks to sell products. Present yourself, your products, your services, and your team. CommerceM4 is compatible with Mobirise 4 Themes. View demo templates: Cafe Demo, Shoes Demo, Headphones Demo. Check available blocks: headers, menus,images & videos, sliders & galleries, shops, features, content blocks, info blocks, team blocks and testimonials, forms & maps, pricing tables and tables, social blocks, countdowns & accordions, footers.
\n
\n
\n
HotelM4 Theme
\n
\n
HotelM4 Theme - Bootstrap theme for hotel and resort websites. HotelM4 is an M4 compatible theme. View live demos: menus, headers, features, images and videos, sliders and galleries, content blocks, forms, pricing tables, testimonials and team blocks, toggles and accordions, maps, info blocks, footers.
\n
\n
\n
Mobirise v4.6.0
\n
\n
Hotkey: if your Sites list is empty, you can load the list of previously used projects: open your Sites list and press Ctrl+Shift+L when it opened.
\n
Mobirise Translator extension: you can translate Mobirise interface to your language and share your translations with other users.
\n
\n
Mobirise AMP
\n
Mobirise AMP Theme - accelerate your site with Google AMP. Check AMP theme components demos: headers, images & videos, testimonials & info, features, articles, maps & social, footers.
\n
\n
Mobirise v4.5.0
\n
\n
Translation: German
\n
Bug fixes for saving User blocks
\n
Bug fixes for themes: Blockpack for Mobirise 3, AgencyM4, PortfolioM4, LawyerM4, DirectM, SpaceM\nTo change the interface language, open the main menu in the app, select the Account tab, and open App Settings.
\n
\n
\n
Mobirise v4.4.0
\n
\n
Now you can crop images right in Mobirise application
\n
Fixed compatibility with Internet Explorer in Mobirise 4 theme
\n
\n
\n
\n
Mobirise v4.3.5
\n
\n
StoreM4 Bootstrap Theme
\n
App Settings: \"Show All Block Buttons\" option added
\n
Bug Fixes:
\n
Mobirise4 Theme: Fix for counters
\n
Gallery Video - fixed youtube thumbnails in Mobirise 3 and Mobirise 4 compatible themes
\n
Links - fixed long domain in web address
\n
\n
StoreM4 Bootstrap Theme - spacious, clean and attractive ecommerce theme designed mainly for stores. 80+ blocks for your new online shop. This theme includes several menu blocks, headers, sliders and galleries, shops, content and info sections, pricing tables, testimonials, team blocks and more. StoreM4 is compatible with Mobirise 4 themes - you can interchange user blocks between your projects.
\n
\n
Mobirise v4.3.4
\n
\n
Facebook and Google Authorization: Now you can sign up using your Google and Facebook accounts.
\n
Clone Sites - clone not only pages, but also entire sites.
\n
App settings - open your Menu->Account->App settings to adjust your app settings: show the redo button, the tablet view mode, keep the Site Styles button shown.
\n
FTP publishing fixes
\n
Mobirise Help Center - visit our Help Center if you have some issues, and if you can't find a solution, you can visit our forums or contact our Support Team.
\n
\n
\n
\n
\n
\n
PortfolioM4 Bootstrap Theme - Modern and bright theme to present your projects - for designers, illustrators, artists, and developers. Comes with moving background intro, \"typed\" effect, step-by-step process, our clients, portfoilio gallery, counters, about me blocks. PortfolioM4 is compatible with Mobirise 4 themes - you can interchange user blocks between your projects.
\n
\n
\n
Mobirise v4.3.1
\n
\n
Built-in \"Mobirise Icons Bold\" icon font
\n
\"Icons\" extension updated. Now 8700+ icons total
\n
New fonts: Icon54 v.3, Icon54 v.4, Simple Line Icons, \"Font Awesome\" updated
\n
Site Library:\nFixed bug with removing images that are used on site\nFixed hanging\nFixed bug with duplication of images
\n
Mobirise4: fixed bug with buttons in 'pricing tables'
\n
Fixed vimeo thumbnails in gallery
\n
\"Link to\" dialog: \"open in new window\" is added to the \"file\" tab
\n
\n
Mobirise v4.3.0
\n
\n
New \"Link to\" dialog with: Option to add files to site and link them (pdf, doc, xls, etc..); Email; Phone; Web Address
\n
Updated PayPal Shopping Cart
\n
Fixed duplicated images on publishing
\n
Minor fixes
\n
LawyerM4 Bootstrap Theme - Dark, minimal and tidy theme for lawyers, legal firms, attorneys and related legal professionals. LawyerM4 is compatible with Mobirise 4 themes - you can interchange user blocks between your projects.
New AgencyM4 Theme. Theme for companies and agencies with 70+ blocks. New gradient overlays, working hours sections, and an extended set of dropdown menus and intro sections. AgencyM4 is compatible with Mobirise 4 Theme: you can move Mobirise4 and AgencyM4 user blocks between your projects.
\n
WOW Slider extension fixed
\n
Extensions updated – Social Feed, Social Comments, SoundCloud
\n
Compatibility issue with some 3rd-party themes fixed (Clarus, Sleek, Unicore..)
\n
Site thumbnail creation fixed
\n
Fix: WOWSlider extension
\n
Update: Home pages in Italian (please contact at support@mobirise.com if you find mistakes in texts)
Bootstrap updated to latest v4.0.0-beta (for Mobirise4 theme only)
\n
Fix: Fonts crush on start
\n
Fix: Bug in images publishing
\n
Fix: Parameters in extension blocks
\n
Fix: WOWSlider extension
\n
Update: Home pages in Chinese, Slovak, Polish, French, Albanian, Finnish, Swedish, Japanese, Portugal (please contact at support@mobirise.com if you find mistakes in texts)
\n
\n
Mobirise v4.1.6
\n
Search by font name in Google font library
\n
\n
Fix: \"Browse computer for image\" doesn't save last dir
\n
Fix: Hot key COPY/PASTE on Mac
\n
Fix: \"Clone page\" doesn't work with some blocks
\n
Fix: Rubik Google font bug on Windows
\n
Update: Home pages in German, Spanish, Danish, Norwegian, Dutch, Russian (please contact at support@mobirise.com if you find mistakes in texts)
\n
\n
Mobirise v4.1
\n
\n
Brand-new core engine - the app works much faster and smoother now
Bootstrap website builder makes it very easy to prototype, test, and build a custom responsive website quickly, without having to understand the Bootstrap framework system. They, although different in capabilities, all offer a form of drag-and-drop functionality that fully utilizes the enormous library of Bootstrap’s components.\n\n\n
Adding a css image gallery to your website does not need to be difficult or time-consuming. There are a wide range of options to choose from, whether you opt to go with the standard html5 image gallery, to customize it using one of a wide-range of plugins and tutorials or if you opt for Mobirise’s drag-and-drop builder. Good luck with your website!\n\n\n
The bootstrap image slider component that comes with the bootstrap framework is a lightweight carousel which uses JavaScript. It’s a standards-compliant piece of functionality, with a clean design that will fit easily into any website. It’s also easy to modify and extend with additional functionality such as CSS3 animations and more.\n\n\n
Today you are able to use different techniques and tools, from using an open-source CMS such as WordPress along with a free theme, to using website building software.\nMobirise is one such website builder. Website software has a few advantages over a CMS...\n\n\n
\n
Drag and drop website builder
\n
Make your own mobile website in minutes! Mobirise helps you cut down development time by providing you with a flexible website editor with a drag and drop interface.
\n
Live preview
\n
See the result instantly without a need to save or export!
\n
Modern styles
\n
Mobirise has provided for website developers a growing library of modern blocks which can be used either partially or in full for every website developed through the builder.
\n
Bootstrap 3
\n
Bootstrap 3 has been noted as one of the most reliable and proven frameworks and Mobirise has been equipped to develop websites using this framework.
\n
Create a beautiful website.
\n
Whether you want to create a blog, eCommerce store, portfolio, or all of the above, you can express your idea with a website powered by our elegant yet intuitive platform.
Bootstrap website builder makes it very easy to prototype, test, and build a custom responsive website quickly, without having to understand the Bootstrap framework system. They, although different in capabilities, all offer a form of drag-and-drop functionality that fully utilizes the enormous library of Bootstrap’s components.\n\n\n
Adding a css image gallery to your website does not need to be difficult or time-consuming. There are a wide range of options to choose from, whether you opt to go with the standard html5 image gallery, to customize it using one of a wide-range of plugins and tutorials or if you opt for Mobirise’s drag-and-drop builder. Good luck with your website!\n\n\n
The bootstrap image slider component that comes with the bootstrap framework is a lightweight carousel which uses JavaScript. It’s a standards-compliant piece of functionality, with a clean design that will fit easily into any website. It’s also easy to modify and extend with additional functionality such as CSS3 animations and more.\n\n\n
Today you are able to use different techniques and tools, from using an open-source CMS such as WordPress along with a free theme, to using website building software.\nMobirise is one such website builder. Website software has a few advantages over a CMS...\n\n\n
\n
Drag and drop website builder
\n
Make your own mobile website in minutes! Mobirise helps you cut down development time by providing you with a flexible website editor with a drag and drop interface.
\n
Live preview
\n
See the result instantly without a need to save or export!
\n
Modern styles
\n
Mobirise has provided for website developers a growing library of modern blocks which can be used either partially or in full for every website developed through the builder.
\n
Bootstrap 3
\n
Bootstrap 3 has been noted as one of the most reliable and proven frameworks and Mobirise has been equipped to develop websites using this framework.
\n
Create a beautiful website.
\n
Whether you want to create a blog, eCommerce store, portfolio, or all of the above, you can express your idea with a website powered by our elegant yet intuitive platform.
Mockman is a powerful and convenient tool that helps you to manage and start mock servers locally.
\n
With the app, you can easily configure the routes, request format and response of a mock server
\n
\n
Screenshot
\n
\n
\n
Usage
\n
\n\n
Create your mock server - click the add button
\n
Configure the name, port and prefix of your move server, make sure the port is not in use, or Mockman will give you a error notification.
\n
Add some apis for your mock server.
\n
Configure the method, route, response code, latency, required request options and reponse data of each api.
\n
Start the server - click the start button.
\n
After all, you can test your api locally.
\n\n
\n
Where will your api data be stored?
\n
\n
Your data will be stored as a sqlite file absolutely on your local, the path will be different on different operation system.
\n
\n
\n
\n
%APPDATA% for Windows
\n
$XDG_CONFIG_HOME or ~/.config for Linux
\n
~/Library/Application Support for macOS
\n
\n
\n
Be attention before you start https server
\n
\n
\n
Mockman is using self-signed-certification to create https server
\n
Install rootCA on your client and trust it before you send https requests
\n
\n
\n
\n
Todos
\n
Server
\n
\n
ipcMain && ipcRender communication
\n
dababase support
\n
create a new mock
\n
update a mock
\n
remove a mock
\n
query a mock info
\n
create an api
\n
update an api
\n
remove an api
\n
query an api info
\n
start an express server with a mock config
\n
handle errors while starting the server
\n
\n
Client
\n
\n
brand header dislay
\n
mock sider display
\n
mock-detail and api-list display
\n
api-detail display
\n
create a new mock
\n
update a mock
\n
remove a mock
\n
query a mock info
\n
create an api
\n
update an api
\n
remove an api
\n
query an api info
\n
request params check list
\n
response k-v input group
\n
response code editor
\n
add blur event to jsonEditor
\n
add a log panel to show the logs of an active mock server process
\n
add https support
\n
group the apis with tag
\n
check the conflict of all mocks
\n
Export/Import mock or api configurations
\n
\n
License
\n
\n
Contribute
\n
# install the dependencies \nnpm install\n\n# serve with hot reload at localhost:9080\nnpm run dev \n\n# build mockman\nnpm run build\n\n# run unit tests\nnpm test \n\n# lint all JS/Vue component files in `src/`\nnpm run lint \n
Mockman is a powerful and convenient tool that helps you to manage and start mock servers locally.
\n
With the app, you can easily configure the routes, request format and response of a mock server
\n
\n
Screenshot
\n
\n
\n
Usage
\n
\n\n
Create your mock server - click the add button
\n
Configure the name, port and prefix of your move server, make sure the port is not in use, or Mockman will give you a error notification.
\n
Add some apis for your mock server.
\n
Configure the method, route, response code, latency, required request options and reponse data of each api.
\n
Start the server - click the start button.
\n
After all, you can test your api locally.
\n\n
\n
Where will your api data be stored?
\n
\n
Your data will be stored as a sqlite file absolutely on your local, the path will be different on different operation system.
\n
\n
\n
\n
%APPDATA% for Windows
\n
$XDG_CONFIG_HOME or ~/.config for Linux
\n
~/Library/Application Support for macOS
\n
\n
\n
Be attention before you start https server
\n
\n
\n
Mockman is using self-signed-certification to create https server
\n
Install rootCA on your client and trust it before you send https requests
\n
\n
\n
\n
Todos
\n
Server
\n
\n
ipcMain && ipcRender communication
\n
dababase support
\n
create a new mock
\n
update a mock
\n
remove a mock
\n
query a mock info
\n
create an api
\n
update an api
\n
remove an api
\n
query an api info
\n
start an express server with a mock config
\n
handle errors while starting the server
\n
\n
Client
\n
\n
brand header dislay
\n
mock sider display
\n
mock-detail and api-list display
\n
api-detail display
\n
create a new mock
\n
update a mock
\n
remove a mock
\n
query a mock info
\n
create an api
\n
update an api
\n
remove an api
\n
query an api info
\n
request params check list
\n
response k-v input group
\n
response code editor
\n
add blur event to jsonEditor
\n
add a log panel to show the logs of an active mock server process
\n
add https support
\n
group the apis with tag
\n
check the conflict of all mocks
\n
Export/Import mock or api configurations
\n
\n
License
\n
\n
Contribute
\n
# install the dependencies \nnpm install\n\n# serve with hot reload at localhost:9080\nnpm run dev \n\n# build mockman\nnpm run build\n\n# run unit tests\nnpm test \n\n# lint all JS/Vue component files in `src/`\nnpm run lint \n
# Make sure homebrew knows about the latest mojibar\n$ brew update && brew upgrade brew-cask\n# Install mojibar\n$ brew cask install mojibar
\n
After installation, find Mojibar in your apps folder or search Mojibar in spotlight. Mojibar will appear in your tray at the top right corner of your screen.
\n
To upgrade mojibar installed from brew-cask to a newer version:
# Make sure homebrew knows about the latest mojibar\n$ brew update && brew upgrade brew-cask\n# Install mojibar\n$ brew cask install mojibar
\n
After installation, find Mojibar in your apps folder or search Mojibar in spotlight. Mojibar will appear in your tray at the top right corner of your screen.
\n
To upgrade mojibar installed from brew-cask to a newer version:
Mockoon is the easiest and quickest way to run mock APIs locally. No remote deployment, no account required, open source.\nIt has been built with Electron and can be used on Windows (exe), Linux (deb, rpm, Appimage and Snap) and MacOS (dmg or brew). You can download it here: mockoon.com
\n
\n
Sponsors
\n
If you like Mockoon, you can support the project with a one-time donation:\n
You can get Mockoon latest release directly from this repository or on the official website. Mockoon is also available through Homebrew brew install --cask mockoon, Snap store snap install mockoon, Chocolatey choco install mockoon or AUR yay -S mockoon-bin (or any other AUR helper).
\n
Documentation
\n
You will find the documentation on the official website. It covers Mockoon's most complex features. Feel free to contribute or ask for new topics to be covered.
\n
Support/feedback
\n
You can discuss all things related to Mockoon, and ask for help, on the official community. It's also a good place to discuss bugs and feature requests before opening an issue on this repository. For more chat-like discussions, you can also join our Discord server.
\n
Contributing
\n
If you are interested in contributing to Mockoon, please take a look at the contributing guidelines.
Mockoon is the easiest and quickest way to run mock APIs locally. No remote deployment, no account required, open source.\nIt has been built with Electron and can be used on Windows (exe), Linux (deb, rpm, Appimage and Snap) and MacOS (dmg or brew). You can download it here: mockoon.com
\n
\n
Sponsors
\n
If you like Mockoon, you can support the project with a one-time donation:\n
You can get Mockoon latest release directly from this repository or on the official website. Mockoon is also available through Homebrew brew install --cask mockoon, Snap store snap install mockoon, Chocolatey choco install mockoon or AUR yay -S mockoon-bin (or any other AUR helper).
\n
Documentation
\n
You will find the documentation on the official website. It covers Mockoon's most complex features. Feel free to contribute or ask for new topics to be covered.
\n
Support/feedback
\n
You can discuss all things related to Mockoon, and ask for help, on the official community. It's also a good place to discuss bugs and feature requests before opening an issue on this repository. For more chat-like discussions, you can also join our Discord server.
\n
Contributing
\n
If you are interested in contributing to Mockoon, please take a look at the contributing guidelines.
It is recommended to install Motrix using the installation package (Motrix-Setup-x.y.z.exe) to ensure a complete experience, such as associating torrent files, capturing magnet links, etc.
\n
If you use package management tools to manage applications on Windows, such as Chocolatey, scoop. You can use them to install Motrix.
\n
Chocolatey
\n
Thanks to @Yato for continuing to maintain the Motrix Chocolatey package. To install motrix, run the following command from the command line or from PowerShell:
If you prefer the portable version, you can use scoop (need Windows 7+) to install Motrix.
\n
scoop bucket add extras\nscoop install motrix
\n
macOS
\n
The macOS users can install Motrix using brew cask, thanks to PR of @Mitscherlich.
\n
brew update && brew install --cask motrix
\n
Linux
\n
You can download the AppImage (for all Linux distributions) or snap to install Motrix, see GitHub/release for more Linux installation package formats.
\n
Motrix may need to run with sudo for the first time in Linux because there is no permission to create the download session file (/var/cache/aria2.session).
\n
If you want to build from source code, please read the Build section.
\n
AppImage
\n
The latest version of Motrix AppImage requires you to manually perform desktop integration. Please check the documentation of AppImageLauncher .
\n
\n
Desktop Integration\nSince electron-builder 21 desktop integration is not a part of produced AppImage file.\nAppImageLauncher is the recommended way to integrate AppImages.
\n
\n
Deepin 20 Beta users failed to install Motrix, please follow the steps below:
\n
Open the Terminal, paste and run the following command to install Motrix again.
\n
sudo apt --fix-broken install
\n
Snap
\n
Motrix has been listed on Snapcraft , Ubuntu users recommend downloading from the Snap Store.
\n
Tips for v1.5.10
\n
The tray may not display the indicator normally, which makes it inconvenient to exit the application.
\n
Please unchecked Preferences--Basic Settings--Hide App Menu (Windows & Linux Only), click Save & Apply. Then click \"Exit\" in the File menu to exit the application.
\n
Please update to v1.5.12 and above, you can use the keyboard shortcut Ctrl + q to quickly exit the application.
\n
AUR
\n
For Arch Linux users, Motrix is available in aur, thanks to the maintainer @weearc.
\n
Run the following command to install:
\n
yay motrix
\n
Flatpak
\n
Thanks to the PR of @proletarius101, Motrix has been listed Flathub, Linux users who like the Flatpak can try it.
\n
# Install\nflatpak install flathub net.agalwood.Motrix\n\n# Run\nflatpak run net.agalwood.Motrix
\n
✨ Features
\n
\n
🕹 Simple and clear user interface
\n
🦄 Supports BitTorrent & Magnet
\n
☑️ BitTorrent selective download
\n
📡 Update tracker list every day automatically
\n
🔌 UPnP & NAT-PMP Port Mapping
\n
🎛 Up to 10 concurrent download tasks
\n
🚀 Supports 64 threads in a single task
\n
🚥 Supports speed limit
\n
🕶 Mock User-Agent
\n
🔔 Download completed Notification
\n
💻 Ready for Touch Bar (Mac only)
\n
🤖 Resident system tray for quick operation
\n
📟 Tray speed meter displays real-time speed (Mac only)
\n
🌑 Dark mode
\n
🗑 Delete related files when removing tasks (optional)
It is recommended to install Motrix using the installation package (Motrix-Setup-x.y.z.exe) to ensure a complete experience, such as associating torrent files, capturing magnet links, etc.
\n
If you use package management tools to manage applications on Windows, such as Chocolatey, scoop. You can use them to install Motrix.
\n
Chocolatey
\n
Thanks to @Yato for continuing to maintain the Motrix Chocolatey package. To install motrix, run the following command from the command line or from PowerShell:
If you prefer the portable version, you can use scoop (need Windows 7+) to install Motrix.
\n
scoop bucket add extras\nscoop install motrix
\n
macOS
\n
The macOS users can install Motrix using brew cask, thanks to PR of @Mitscherlich.
\n
brew update && brew install --cask motrix
\n
Linux
\n
You can download the AppImage (for all Linux distributions) or snap to install Motrix, see GitHub/release for more Linux installation package formats.
\n
Motrix may need to run with sudo for the first time in Linux because there is no permission to create the download session file (/var/cache/aria2.session).
\n
If you want to build from source code, please read the Build section.
\n
AppImage
\n
The latest version of Motrix AppImage requires you to manually perform desktop integration. Please check the documentation of AppImageLauncher .
\n
\n
Desktop Integration\nSince electron-builder 21 desktop integration is not a part of produced AppImage file.\nAppImageLauncher is the recommended way to integrate AppImages.
\n
\n
Deepin 20 Beta users failed to install Motrix, please follow the steps below:
\n
Open the Terminal, paste and run the following command to install Motrix again.
\n
sudo apt --fix-broken install
\n
Snap
\n
Motrix has been listed on Snapcraft , Ubuntu users recommend downloading from the Snap Store.
\n
Tips for v1.5.10
\n
The tray may not display the indicator normally, which makes it inconvenient to exit the application.
\n
Please unchecked Preferences--Basic Settings--Hide App Menu (Windows & Linux Only), click Save & Apply. Then click \"Exit\" in the File menu to exit the application.
\n
Please update to v1.5.12 and above, you can use the keyboard shortcut Ctrl + q to quickly exit the application.
\n
AUR
\n
For Arch Linux users, Motrix is available in aur, thanks to the maintainer @weearc.
\n
Run the following command to install:
\n
yay motrix
\n
Flatpak
\n
Thanks to the PR of @proletarius101, Motrix has been listed Flathub, Linux users who like the Flatpak can try it.
\n
# Install\nflatpak install flathub net.agalwood.Motrix\n\n# Run\nflatpak run net.agalwood.Motrix
\n
✨ Features
\n
\n
🕹 Simple and clear user interface
\n
🦄 Supports BitTorrent & Magnet
\n
☑️ BitTorrent selective download
\n
📡 Update tracker list every day automatically
\n
🔌 UPnP & NAT-PMP Port Mapping
\n
🎛 Up to 10 concurrent download tasks
\n
🚀 Supports 64 threads in a single task
\n
🚥 Supports speed limit
\n
🕶 Mock User-Agent
\n
🔔 Download completed Notification
\n
💻 Ready for Touch Bar (Mac only)
\n
🤖 Resident system tray for quick operation
\n
📟 Tray speed meter displays real-time speed (Mac only)
\n
🌑 Dark mode
\n
🗑 Delete related files when removing tasks (optional)
A tool which lets you create screenshots of entire movies in an instant.\n
\n
\n
CUSTOMISE LOOK - Set a custom grid, adjust file and frame specific data, margins etc. to create a custom look for your MoviePrints.
\n
SET IN AND OUT POINTS - Define custom In and Out Points for your MoviePrint if you only want to use a section of the movie.
\n
INSERT AND MOVE THUMBS - Easily insert thumbs and move them around via drag and drop.
\n
SELECT FRAMES - Scrub through the movie with ease and select frames for every single thumb individually.
\n
SAVE THUMBS - Easily save individual thumbs or save all thumbs of a MoviePrint at once.
\n
BATCH CREATE - Automatically create MoviePrints from all your movies.
\n
SHOT DETECTION - Scan the movie with a simple shot detection to get more interesting MoviePrints.
\n
TIMELINE VIEW - Change to timeline view where every thumb is as wide as the shot is long.
\n
EMBED MOVIEPRINT DATA - Embed the data of the chosen thumbs to reedit your MoviePrint at a later stage.
\n
\n
MoviePrint is using openCV as the roadmap includes utilising computer vision algorithms.
\n
Privacy
\n
MoviePrint does not collect any data. All work including detection is done in the app itself (Note: It currently connets on startup to fonts.googleapis.com due to a dependency to semantic ui a ui framework.)
\n
Please give feedback
\n
As we are not collecting any data from you, we are dependent on you talking to us. If you have a minute, we would very much appreciate if you tell us
\n
\n
how you found out about MoviePrint
\n
how you use the software
\n
what you use MoviePrint images for
\n
what you like, what you dislike
\n
and anything else you think we should know to make a better product
\n
\n
You can use this form or the Contact us button in the app.
\n
Want to stay updated?
\n
Do you want to be informed when new features are released? Just check Keep me up-to-date in this form or use the Contact us button in the app.\nWe will only ever send you MoviePrint related updates.
The app was tested on Mac OSX and Windows. Running and building it on other platforms might require additional changes to the code. Especially when it comes to linking and packaging the libraries.
To have ffmpeg support in opencv4nodejs you need to have ffmpeg installed (v3.4.2 works, v4.1 should too)
\n
We'll need opencv4nodejs to work which requires npm install --global windows-build-tools
\n
We need better-sqlite3 to work which additionally requires VC++ 2015.3 v14.00(v140) toolset for desktop\n
\n
Start Visual Studio Installer
\n
Modify Visual Studio Build Tools 2017
\n
Click on Individual components
\n
Tick VC++ 2015.3 v14.00 (v140) toolset for desktop
\n
Click on Modify/Install
\n
\n
\n
Make sure you have python 2 (not 3) installed (v2.7.15 works), test by running python --version
\n
Run the command yarn (this may take 10+ minutes and may automatically download supporting libraries from Microsoft). If this process errors out, try to debug.
\n\n
The rest of the instructions are the same for Mac and Windows:
A tool which lets you create screenshots of entire movies in an instant.\n
\n
\n
CUSTOMISE LOOK - Set a custom grid, adjust file and frame specific data, margins etc. to create a custom look for your MoviePrints.
\n
SET IN AND OUT POINTS - Define custom In and Out Points for your MoviePrint if you only want to use a section of the movie.
\n
INSERT AND MOVE THUMBS - Easily insert thumbs and move them around via drag and drop.
\n
SELECT FRAMES - Scrub through the movie with ease and select frames for every single thumb individually.
\n
SAVE THUMBS - Easily save individual thumbs or save all thumbs of a MoviePrint at once.
\n
BATCH CREATE - Automatically create MoviePrints from all your movies.
\n
SHOT DETECTION - Scan the movie with a simple shot detection to get more interesting MoviePrints.
\n
TIMELINE VIEW - Change to timeline view where every thumb is as wide as the shot is long.
\n
EMBED MOVIEPRINT DATA - Embed the data of the chosen thumbs to reedit your MoviePrint at a later stage.
\n
\n
MoviePrint is using openCV as the roadmap includes utilising computer vision algorithms.
\n
Privacy
\n
MoviePrint does not collect any data. All work including detection is done in the app itself (Note: It currently connets on startup to fonts.googleapis.com due to a dependency to semantic ui a ui framework.)
\n
Please give feedback
\n
As we are not collecting any data from you, we are dependent on you talking to us. If you have a minute, we would very much appreciate if you tell us
\n
\n
how you found out about MoviePrint
\n
how you use the software
\n
what you use MoviePrint images for
\n
what you like, what you dislike
\n
and anything else you think we should know to make a better product
\n
\n
You can use this form or the Contact us button in the app.
\n
Want to stay updated?
\n
Do you want to be informed when new features are released? Just check Keep me up-to-date in this form or use the Contact us button in the app.\nWe will only ever send you MoviePrint related updates.
The app was tested on Mac OSX and Windows. Running and building it on other platforms might require additional changes to the code. Especially when it comes to linking and packaging the libraries.
To have ffmpeg support in opencv4nodejs you need to have ffmpeg installed (v3.4.2 works, v4.1 should too)
\n
We'll need opencv4nodejs to work which requires npm install --global windows-build-tools
\n
We need better-sqlite3 to work which additionally requires VC++ 2015.3 v14.00(v140) toolset for desktop\n
\n
Start Visual Studio Installer
\n
Modify Visual Studio Build Tools 2017
\n
Click on Individual components
\n
Tick VC++ 2015.3 v14.00 (v140) toolset for desktop
\n
Click on Modify/Install
\n
\n
\n
Make sure you have python 2 (not 3) installed (v2.7.15 works), test by running python --version
\n
Run the command yarn (this may take 10+ minutes and may automatically download supporting libraries from Microsoft). If this process errors out, try to debug.
\n\n
The rest of the instructions are the same for Mac and Windows:
docker run -d -p 3000:3000 mongoclient/mongoclient
\n
To set an external mongodb which is required for meteor to work, you can set MONGO_URL environment variable. Otherwise nosqlclient will install mongodb to container and use it.
\n
To persist your connections and settings simply bind /data/db directory to your local machine as below.
\n
docker run -d -p 3000:3000 -v <your_path>:/data/db mongoclient/mongoclient
\n
History
\n
Please check history file for version information.
\n
License
\n
Nosqlclient is licensed under MIT for prior version 2.0.0, but for 2.0.0 and higher versions are licensed under AGPLv3.
\n
We use JetBrains products to develop Nosqlclient !
docker run -d -p 3000:3000 mongoclient/mongoclient
\n
To set an external mongodb which is required for meteor to work, you can set MONGO_URL environment variable. Otherwise nosqlclient will install mongodb to container and use it.
\n
To persist your connections and settings simply bind /data/db directory to your local machine as below.
\n
docker run -d -p 3000:3000 -v <your_path>:/data/db mongoclient/mongoclient
\n
History
\n
Please check history file for version information.
\n
License
\n
Nosqlclient is licensed under MIT for prior version 2.0.0, but for 2.0.0 and higher versions are licensed under AGPLv3.
\n
We use JetBrains products to develop Nosqlclient !
Sit Healthy is a lightweight desktop app that runs in the background.
\n
\n
Smart reminders notify you when it's time to get up and move from your desk.
\n
Quick tips inform you of useful ways to improve your sitting health.
\n
The app is constantly being updated with new content.
\n
A serious solution to a serious problem.
\n
\n
\n
\"Today, our bodies are breaking down from obesity, high blood pressure, diabetes, cancer, depression and the cascade of health ills and everyday malaise that come from what scientists have named sitting disease.\" - Dr. James Levine
\n
\n
Screenshots
\n
\n\n\n
\n
",
+ "readmeOriginal": "
\n
Sit Healthy
\n
Sit Healthy is a lightweight desktop app that runs in the background.
\n
\n
Smart reminders notify you when it's time to get up and move from your desk.
\n
Quick tips inform you of useful ways to improve your sitting health.
\n
The app is constantly being updated with new content.
\n
A serious solution to a serious problem.
\n
\n
\n
\"Today, our bodies are breaking down from obesity, high blood pressure, diabetes, cancer, depression and the cascade of health ills and everyday malaise that come from what scientists have named sitting disease.\" - Dr. James Levine
Move files to where they should & call yourself mr. clean
\n
Aggregate files . bulk renaming
\n
A minimal looking cross-platform desktop application made with Electron that handles quick file aggregation and bulk renaming
\n
\n\n \n \n
\n
\n
\n
\n
\n
About
\n
Are you an internet guy? downloading hundreds of files and then scrolling over all of them to find a few?\nDownload folder is so cluttered with files that it takes a significant amount of time to open?\nAs a programmer want to remove those annoying spaces from file names in bulk?
\n
Mr.d'clutterer is then going to be a life saver application for you :) simply drop a folder or selected files on to it to make them organized in fraction of a second.
\n
Features
\n\n
Drag and drop
\n
Rename files on-the-fly
\n
Aggregate files by extensions and types (more coming soon..)
\n
Process files under sub-directories too
\n
Quick access to settings from the right click context-menu ⚡
\n
Minimal and beautiful ❤️
\n
Auto updates itself
\n
Available both for linux & windows
\n\n
Download
\n
Download the right installer for your os from Here
\n
Note
\n
If you are looking for a tiny version of this app without a gui that works right form the file managers' right click menu, check NaughtyLust (Linux Only)
\n
Demo
\n
\n
Settings Menu
\n
Access settings right from the right click context-menu 🆒
\n
\n
Usage Guide
\n
Directory Handling
\n
If any folders (directories) dropped, files under those will also be taken under consideration
\n
Default Mode
\n
Aggregate files based on their types with directory handling on
\n
License
\n
\n
MIT License
\n
\n
\n
Copyright (c) 2020 Dipankar Pal
\n
\n
Permission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:
\n
The above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.
\n
THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.
\n
Support
\n
All kinds of supports are welcome 🙌! the most basic way to show your support is to star 🌟 the project, or to raise issues 💬 you can also support this project by becoming a sponsor on GitHub👏 Or By Making A Paypal Donation :)
qikQR : Minimal QR Code Generator App Made With Electron.
\n
cppcheck-action : Check Security Flaws In Your C/C++ Codes Right From GitHub Action Workflows.
\n
autopy-lot : GitHub Action Setup To Convert Jupyter Notebooks To Python Scripts And Markdowns.
\n
\n
\n
\n
Happy Coding
\n
\n
",
+ "readmeOriginal": "
\n
\n
Mr. D'clutterer
\n
Move files to where they should & call yourself mr. clean
\n
Aggregate files . bulk renaming
\n
A minimal looking cross-platform desktop application made with Electron that handles quick file aggregation and bulk renaming
\n
\n\n \n \n
\n
\n
\n
\n
\n
About
\n
Are you an internet guy? downloading hundreds of files and then scrolling over all of them to find a few?\nDownload folder is so cluttered with files that it takes a significant amount of time to open?\nAs a programmer want to remove those annoying spaces from file names in bulk?
\n
Mr.d'clutterer is then going to be a life saver application for you :) simply drop a folder or selected files on to it to make them organized in fraction of a second.
\n
Features
\n\n
Drag and drop
\n
Rename files on-the-fly
\n
Aggregate files by extensions and types (more coming soon..)
\n
Process files under sub-directories too
\n
Quick access to settings from the right click context-menu ⚡
\n
Minimal and beautiful ❤️
\n
Auto updates itself
\n
Available both for linux & windows
\n\n
Download
\n
Download the right installer for your os from Here
\n
Note
\n
If you are looking for a tiny version of this app without a gui that works right form the file managers' right click menu, check NaughtyLust (Linux Only)
\n
Demo
\n
\n
Settings Menu
\n
Access settings right from the right click context-menu 🆒
\n
\n
Usage Guide
\n
Directory Handling
\n
If any folders (directories) dropped, files under those will also be taken under consideration
\n
Default Mode
\n
Aggregate files based on their types with directory handling on
\n
License
\n
\n
MIT License
\n
\n
\n
Copyright (c) 2020 Dipankar Pal
\n
\n
Permission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:
\n
The above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.
\n
THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.
\n
Support
\n
All kinds of supports are welcome 🙌! the most basic way to show your support is to star 🌟 the project, or to raise issues 💬 you can also support this project by becoming a sponsor on GitHub👏 Or By Making A Paypal Donation :)
deleting any file which detected as duplicated file. \nthis function will detecting duplicated file just in the recent folder, when you have selecting some file as follows:
deleting any file which detected as duplicated file. \nthis function will detecting duplicated file just in the recent folder, when you have selecting some file as follows:
A simple, clean and cross-platform music player. (museeks.io)
\n
\n
Features
\n
Museeks aims to be a simple and easy to use music player with a clean UI. You will not find tons of features, as its goals is not to compete with more complete and more famous music players. Here is a little preview though:
\n
\n
💻 Cross-platform music player (Linux, macOS and Windows)
Museeks is currently in development. This implies some things can break after an update (database schemes changes, config...).
\n
If you encounter freezes or crashes when using the app, you can reset Museeks by following these steps:
\n
\n
Go to the Museeks folder directory\n
\n
Windows: %AppData%\\museeks
\n
OSX: ~/Library/Application Support/museeks
\n
Linux: ~/.config/museeks/ or $XDG_CONFIG_HOME/museeks
\n
\n
\n
Delete:\n
\n
IndexedDB folder
\n
config.json file
\n
\n
\n
Restart Museeks
\n
\n
If you still get problems after that, please open an issue :)
\n
Bug report
\n
If you want to report a bug, first, thanks a lot, that helps us a lot. Please open an issue and mention your OS, your Museeks version, and how to reproduce it. Adding a screen of the console (Menu -> View -> Toggle Developer Tools) is a big help too.
\n
Contribute
\n
\n
Fork and clone
\n
Master may be unstable, checkout to a tag to have a stable state of the app
\n
yarn install --frozen-lockfile && yarn run dev then run in a separate terminal yarn run museeks:debug
\n
yarn run dev will watch for file changes using Webpack which will recompile JSX and CSS files.
\n
\n
Please respect a few rules:
\n
\n
Before making complex stuff, don't hesitate to open an issue first to discuss about it ;)
\n
Make the code readable and comment if needed
\n
Make sure your build pass
\n
\n
Then open a PR :)
\n
",
+ "readmeOriginal": "
Museeks
\n
\n\n
\n
A simple, clean and cross-platform music player. (museeks.io)
\n
\n
Features
\n
Museeks aims to be a simple and easy to use music player with a clean UI. You will not find tons of features, as its goals is not to compete with more complete and more famous music players. Here is a little preview though:
\n
\n
💻 Cross-platform music player (Linux, macOS and Windows)
Museeks is currently in development. This implies some things can break after an update (database schemes changes, config...).
\n
If you encounter freezes or crashes when using the app, you can reset Museeks by following these steps:
\n
\n
Go to the Museeks folder directory\n
\n
Windows: %AppData%\\museeks
\n
OSX: ~/Library/Application Support/museeks
\n
Linux: ~/.config/museeks/ or $XDG_CONFIG_HOME/museeks
\n
\n
\n
Delete:\n
\n
IndexedDB folder
\n
config.json file
\n
\n
\n
Restart Museeks
\n
\n
If you still get problems after that, please open an issue :)
\n
Bug report
\n
If you want to report a bug, first, thanks a lot, that helps us a lot. Please open an issue and mention your OS, your Museeks version, and how to reproduce it. Adding a screen of the console (Menu -> View -> Toggle Developer Tools) is a big help too.
\n
Contribute
\n
\n
Fork and clone
\n
Master may be unstable, checkout to a tag to have a stable state of the app
\n
yarn install --frozen-lockfile && yarn run dev then run in a separate terminal yarn run museeks:debug
\n
yarn run dev will watch for file changes using Webpack which will recompile JSX and CSS files.
\n
\n
Please respect a few rules:
\n
\n
Before making complex stuff, don't hesitate to open an issue first to discuss about it ;)
Music Kitten, or simply Kitten, is an Electron application that plays audio\ntracks when CS:GO gives it certain cues. Essentially, this allows you to\ncreate and use your own music kits.
To run Music Kitten from source, you'll need node. If you've never\nconfigured node before, I recommend using\nnvm on Linux and Mac OS,\nor nvm for Windows.
\n
Once you have node and npm ready to go, cd to where Kitten was cloned. Next, I\nsuggest that you delete the package-lock.json file since it can cause problems.\nThen run npm install and npm start and you'll be running Kitten.
\n
To build Kitten for your target platform, do npm run dist.
\n
How to use
\n
The first thing Kitten is going to do is request a directory to look in for\nmusic kits. Kitten's configuration file is also stored here. Create/select a\ndedicated folder for Kitten to use.
\n
If you'd like to use a different port than the default, change the value in the\ntextbox, click save, and restart Kitten.
\n
If CS:GO was already open before you started the setup process, you may need to\nrestart it.
\n
Remember to mute in-game music if you haven't done so.
\n
Lastly, you need music kits. A music kit is a collection of audio files grouped\nin a directory in the Kitten save folder. Basically, inside the folder you\npicked at the beginning, you're going to have a folder for each music kit you\nhave. If you don't have any music kits, Kitten will offer to download the\nsample music kit. Otherwise, you can\ndownload one from musickitten.net or make\nyour own. Which brings us to...
\n
Creating kits
\n
First thing is making a folder for the kit. Create a directory in the Kitten\nfolder you chose to use and call it whatever you want the kit to be called.\nInside, you'll need to have these audio files:
\n\n
mainmenu
\n\n
\n
mainmenu plays and loops at the mainmenu. Should be long enough to not drive\npeople crazy since it loops.
\n
\n\n
startround_01 - startround_03
\n\n
\n
startround_0X starts playing in the frozen phase of a new round and loops\nuntil the round starts. These should be short, around 8 seconds (or shorter).\nThere are three variants from which Kitten selects randomly.
\n
\n\n
startaction_01 - startaction_03
\n\n
\n
startaction_0X plays as soon as the startround track ends and the round has\nalready started. In other words, startround_0X should seamlessly transition\ninto startaction_0X. This track fades out automatically. Make it at least 10\nseconds.
\n
\n\n
bombplanted
\n\n
\n
bombplanted plays when the bomb gets planted. It plays and loops (if necessary) for\n30 seconds. The delay before it starts is due to CS:GO taking it's time\nnotifying Kitten. The delay varies from time to time.
\n
\n\n
bombtenseccount
\n\n
\n
bombtenseccount plays and loops (if necessary) 30 seconds after bombplanted\nstarted playing. If bombplanted was late, this will be too.
\n
\n\n
wonround
\n\n
\n
Plays (and loops) when you win. Anything over 20 seconds is excessive.
\n
\n\n
lostround
\n\n
\n
Plays (and loops) when you lose. Anything over 20 seconds is excessive.
\n
\n\n
roundmvpanthem_01
\n\n
\n
roundmvpanthem_01 plays (and loops) when you're the MVP*.\nAnything over 20 seconds is excessive. Despite the naming convention,\nthere's only one MVP anthem. The name was chosen to align with the naming\nscheme already in place for real music kits.
\n
\n
*Due to how CS:GO sends information, this won't play if you're dead and\nspectating another player. in that case, it'll just play wonround.
\n\n
You can use any file type that Chrome's audio player can play. I'd recommend\nanything that supports gapless playback (like FLAC). Filenames are CASE\nSENSITIVE
\n
Optionally, you can add a cover.jpeg to the music kit's folder. This is\ndisplayed in Kitten when the kit is selected.
\n
Take a look at the sample music kit for an example of what a music kit could\nlook like:\nBig Croint Music Kit
\n
",
+ "readmeOriginal": "
\n
\n\n\n\n
\n
Music Kitten, or simply Kitten, is an Electron application that plays audio\ntracks when CS:GO gives it certain cues. Essentially, this allows you to\ncreate and use your own music kits.
To run Music Kitten from source, you'll need node. If you've never\nconfigured node before, I recommend using\nnvm on Linux and Mac OS,\nor nvm for Windows.
\n
Once you have node and npm ready to go, cd to where Kitten was cloned. Next, I\nsuggest that you delete the package-lock.json file since it can cause problems.\nThen run npm install and npm start and you'll be running Kitten.
\n
To build Kitten for your target platform, do npm run dist.
\n
How to use
\n
The first thing Kitten is going to do is request a directory to look in for\nmusic kits. Kitten's configuration file is also stored here. Create/select a\ndedicated folder for Kitten to use.
\n
If you'd like to use a different port than the default, change the value in the\ntextbox, click save, and restart Kitten.
\n
If CS:GO was already open before you started the setup process, you may need to\nrestart it.
\n
Remember to mute in-game music if you haven't done so.
\n
Lastly, you need music kits. A music kit is a collection of audio files grouped\nin a directory in the Kitten save folder. Basically, inside the folder you\npicked at the beginning, you're going to have a folder for each music kit you\nhave. If you don't have any music kits, Kitten will offer to download the\nsample music kit. Otherwise, you can\ndownload one from musickitten.net or make\nyour own. Which brings us to...
\n
Creating kits
\n
First thing is making a folder for the kit. Create a directory in the Kitten\nfolder you chose to use and call it whatever you want the kit to be called.\nInside, you'll need to have these audio files:
\n\n
mainmenu
\n\n
\n
mainmenu plays and loops at the mainmenu. Should be long enough to not drive\npeople crazy since it loops.
\n
\n\n
startround_01 - startround_03
\n\n
\n
startround_0X starts playing in the frozen phase of a new round and loops\nuntil the round starts. These should be short, around 8 seconds (or shorter).\nThere are three variants from which Kitten selects randomly.
\n
\n\n
startaction_01 - startaction_03
\n\n
\n
startaction_0X plays as soon as the startround track ends and the round has\nalready started. In other words, startround_0X should seamlessly transition\ninto startaction_0X. This track fades out automatically. Make it at least 10\nseconds.
\n
\n\n
bombplanted
\n\n
\n
bombplanted plays when the bomb gets planted. It plays and loops (if necessary) for\n30 seconds. The delay before it starts is due to CS:GO taking it's time\nnotifying Kitten. The delay varies from time to time.
\n
\n\n
bombtenseccount
\n\n
\n
bombtenseccount plays and loops (if necessary) 30 seconds after bombplanted\nstarted playing. If bombplanted was late, this will be too.
\n
\n\n
wonround
\n\n
\n
Plays (and loops) when you win. Anything over 20 seconds is excessive.
\n
\n\n
lostround
\n\n
\n
Plays (and loops) when you lose. Anything over 20 seconds is excessive.
\n
\n\n
roundmvpanthem_01
\n\n
\n
roundmvpanthem_01 plays (and loops) when you're the MVP*.\nAnything over 20 seconds is excessive. Despite the naming convention,\nthere's only one MVP anthem. The name was chosen to align with the naming\nscheme already in place for real music kits.
\n
\n
*Due to how CS:GO sends information, this won't play if you're dead and\nspectating another player. in that case, it'll just play wonround.
\n\n
You can use any file type that Chrome's audio player can play. I'd recommend\nanything that supports gapless playback (like FLAC). Filenames are CASE\nSENSITIVE
\n
Optionally, you can add a cover.jpeg to the music kit's folder. This is\ndisplayed in Kitten when the kit is selected.
\n
Take a look at the sample music kit for an example of what a music kit could\nlook like:\nBig Croint Music Kit
Multrin is a cross-platform app built on Electron that lets you to organize apps in tabs by simply dropping them onto Multrin. It aims to greatly improve your productivity and organization.
\n
\n
\n
NOTE: Multrin works currently only on Windows and macOS. Support for Linux coming soon.
If you have found any bugs or just want to see some new features in Multrin, feel free to open an issue. I'm open to any suggestions and bug reports would be really helpful for me and appreciated very much. Multrin is in heavy development and some bugs may occur. Also, please don't hesitate to open a pull request. This is really important to me and for the further development of this project.
\n
Running
\n
Before running Multrin in development mode, please ensure you have Node.js installed on your machine.
\n
When running on Windows, make sure you have build tools installed. You can install them by running as administrator:
\n
$ npm i -g windows-build-tools
\n
Firstly, run this command to install all needed dependencies. If you have encountered any problems, please report it. I will try to help as much as I can.
\n
$ npm i
\n
Now the native modules need to be rebuilt with Electron's headers. To do that, please run:
\n
$ npm run rebuild
\n
The given command below will run Multrin in the development mode.
Multrin is a cross-platform app built on Electron that lets you to organize apps in tabs by simply dropping them onto Multrin. It aims to greatly improve your productivity and organization.
\n
\n
\n
NOTE: Multrin works currently only on Windows and macOS. Support for Linux coming soon.
If you have found any bugs or just want to see some new features in Multrin, feel free to open an issue. I'm open to any suggestions and bug reports would be really helpful for me and appreciated very much. Multrin is in heavy development and some bugs may occur. Also, please don't hesitate to open a pull request. This is really important to me and for the further development of this project.
\n
Running
\n
Before running Multrin in development mode, please ensure you have Node.js installed on your machine.
\n
When running on Windows, make sure you have build tools installed. You can install them by running as administrator:
\n
$ npm i -g windows-build-tools
\n
Firstly, run this command to install all needed dependencies. If you have encountered any problems, please report it. I will try to help as much as I can.
\n
$ npm i
\n
Now the native modules need to be rebuilt with Electron's headers. To do that, please run:
\n
$ npm run rebuild
\n
The given command below will run Multrin in the development mode.
You said to yourself: 'Now it is time to rest. Let's play for 5 mins.' But it became unstoppable after starting. And in this way, your afternoon was wasted.
\n
You should download Mr Noplay, who gives an end to no-end rests and play times.
If you need Linux version, plz open an issue. Android & iOS versions might come into being in the future.
\n
For any other questions, open an isuue or contact me at tianze%scris.top (% → @)
\n
Features
\n
\n
A vivid and easy-to-use user interface.
\n
Multi-platform support: Windows & macOS
\n
Multi-language support: English & Chinese
\n
The powerful work routine that makes controlling time reliable
\n
Go fullscreen on start to make planning time concentrated
\n
Auto-shutdown when over-time is too long to control the time
\n
Pause & Resume
\n
Punishments for example annoying music to impel you to stop
\n
Today View to set the maximum time you can use today\n
\n
tip set today time to stop you from opening computer for too many times in a day
\n
\n
\n
A coin system called R Point to spur you to stop in time
\n
Support start on login
\n
Lock Mode support\n
\n
tip tired of exiting the app on start and then started wasting time? let other people set a lockmode password for you
\n
\n
\n
Update system and update notice
\n
Tutorial
\n
Default time settings
\n
Donate system
\n
\n
License and Copyright
\n
Copyright (c) 2019-2020 Tianze Ds Qiu and other contributors. All rights reserved.
\n
Mr Noplay is under MPL v2.0.
\n
For the information about which package we used, plz go to Fossa and see.
\n
\n
Languages
\n
\n
简体中文
\n
English
\n
Want to contribute? Please first open an isuue.
\n
\n
Build Process
\n
# get dependencies\nyarn\ncd electron\nyarn\n\n# dev\nyarn run dev\n\n# build to electron\nyarn run electron-dev\nyarn run electron-mac\nyarn run electron-win\n\n# build to web (at ../mrnoplay.web/)\nyarn run web
You said to yourself: 'Now it is time to rest. Let's play for 5 mins.' But it became unstoppable after starting. And in this way, your afternoon was wasted.
\n
You should download Mr Noplay, who gives an end to no-end rests and play times.
If you need Linux version, plz open an issue. Android & iOS versions might come into being in the future.
\n
For any other questions, open an isuue or contact me at tianze%scris.top (% → @)
\n
Features
\n
\n
A vivid and easy-to-use user interface.
\n
Multi-platform support: Windows & macOS
\n
Multi-language support: English & Chinese
\n
The powerful work routine that makes controlling time reliable
\n
Go fullscreen on start to make planning time concentrated
\n
Auto-shutdown when over-time is too long to control the time
\n
Pause & Resume
\n
Punishments for example annoying music to impel you to stop
\n
Today View to set the maximum time you can use today\n
\n
tip set today time to stop you from opening computer for too many times in a day
\n
\n
\n
A coin system called R Point to spur you to stop in time
\n
Support start on login
\n
Lock Mode support\n
\n
tip tired of exiting the app on start and then started wasting time? let other people set a lockmode password for you
\n
\n
\n
Update system and update notice
\n
Tutorial
\n
Default time settings
\n
Donate system
\n
\n
License and Copyright
\n
Copyright (c) 2019-2020 Tianze Ds Qiu and other contributors. All rights reserved.
\n
Mr Noplay is under MPL v2.0.
\n
For the information about which package we used, plz go to Fossa and see.
\n
\n
Languages
\n
\n
简体中文
\n
English
\n
Want to contribute? Please first open an isuue.
\n
\n
Build Process
\n
# get dependencies\nyarn\ncd electron\nyarn\n\n# dev\nyarn run dev\n\n# build to electron\nyarn run electron-dev\nyarn run electron-mac\nyarn run electron-win\n\n# build to web (at ../mrnoplay.web/)\nyarn run web
Notice: Due to studies and other reasons, I'm currently unable to continue developing the project, however, new pull requests are welcome and I'll pick it up when my time allows.
\n
Musify
\n
\n
Musify is a simple and fast music player, built from the ground up, using web technologies such as HTML, CSS and JavaScript, all wrapped on Electron Framework.\nThis is my first project as a computer science student. I've tried my best to write a code that follows common coding conventions, but keep in mind that you may find common beginner errors. If so, feel free to help and contribute to improve this app.
Notice: Due to studies and other reasons, I'm currently unable to continue developing the project, however, new pull requests are welcome and I'll pick it up when my time allows.
\n
Musify
\n
\n
Musify is a simple and fast music player, built from the ground up, using web technologies such as HTML, CSS and JavaScript, all wrapped on Electron Framework.\nThis is my first project as a computer science student. I've tried my best to write a code that follows common coding conventions, but keep in mind that you may find common beginner errors. If so, feel free to help and contribute to improve this app.
All contributions are welcome!! Please check negative/issues for things that need attention, or feel free to create your own. Please make sure you create an issue first, and then do the work and a submit a PR.
Locate and copy dist/Negative-darwin-x64/Negative.app to your Applications folder
\n\n
Testing
\n
Important: Tests get run against the built app. If you are attempting to run tests and the results are not what you expected, you need to npm run build again.
\n\n
npm run build
\n
npm test
\n\n
Developing
\n
Compiling
\n
\n
gulp - Compile, combine, and minify files for the renderer process. This isn't necessary for files in the main process. Make sure this is running when working on UI.
\n
\n
NPM Scripts
\n
\n
npm start - Start the app with the following environment variables:\n
\n
NODE_ENV=development
\n
ELECTRON_ENABLE_LOGGING=true
\n
ELECTRON_ENABLE_STACK_DUMPING=true
\n
\n
\n
npm run build - Build the production app\n\n
Compiles JavaScript and Sass
\n
Copies necessary files to ./release/
\n
Runs npm install --production in ./release/
\n
Builds the app moves it to ./dist/
\n\n
\n
npm run lint - Run ESLint
\n
npm test - Run Mocha tests
\n
npm run travis\n\n
Run build
\n
Run test
\n\n
\n
npm run open - Starts the app from dist/Negative-darwin-x64/Negative.app
All contributions are welcome!! Please check negative/issues for things that need attention, or feel free to create your own. Please make sure you create an issue first, and then do the work and a submit a PR.
Locate and copy dist/Negative-darwin-x64/Negative.app to your Applications folder
\n\n
Testing
\n
Important: Tests get run against the built app. If you are attempting to run tests and the results are not what you expected, you need to npm run build again.
\n\n
npm run build
\n
npm test
\n\n
Developing
\n
Compiling
\n
\n
gulp - Compile, combine, and minify files for the renderer process. This isn't necessary for files in the main process. Make sure this is running when working on UI.
\n
\n
NPM Scripts
\n
\n
npm start - Start the app with the following environment variables:\n
\n
NODE_ENV=development
\n
ELECTRON_ENABLE_LOGGING=true
\n
ELECTRON_ENABLE_STACK_DUMPING=true
\n
\n
\n
npm run build - Build the production app\n\n
Compiles JavaScript and Sass
\n
Copies necessary files to ./release/
\n
Runs npm install --production in ./release/
\n
Builds the app moves it to ./dist/
\n\n
\n
npm run lint - Run ESLint
\n
npm test - Run Mocha tests
\n
npm run travis\n\n
Run build
\n
Run test
\n\n
\n
npm run open - Starts the app from dist/Negative-darwin-x64/Negative.app
Netron has experimental support for PyTorch, TensorFlow, TorchScript, OpenVINO, Torch, Vitis AI, Arm NN, BigDL, Chainer, CNTK, Deeplearning4j, MediaPipe, ML.NET and scikit-learn.
\n
\n
Install
\n
macOS: Download the .dmg file or run brew install netron
\n
Linux: Download the .AppImage file or run snap install netron
\n
Windows: Download the .exe installer or run winget install netron
Netron has experimental support for PyTorch, TensorFlow, TorchScript, OpenVINO, Torch, Vitis AI, Arm NN, BigDL, Chainer, CNTK, Deeplearning4j, MediaPipe, ML.NET and scikit-learn.
\n
\n
Install
\n
macOS: Download the .dmg file or run brew install netron
\n
Linux: Download the .AppImage file or run snap install netron
\n
Windows: Download the .exe installer or run winget install netron
A minimalistic music player, designed for simplicity. Built on electron, uses Howler for handling music playback, Svelte for the UI, and music-metadata to retrieve ID3 tags.
\n
This can also serve as a starting point to implement your own front-end/UI for a music Player.
Download the build for your OS. Start the application and then click on the Folders tab on the top left corner, this will bring up a window where you can select the folder where you want to play your audio files from.\nOnce you select a folder with songs, just click play.
\n
Building from the repo
\n
Clone the repository, make it your working directory, and then on your terminal run npm install.\nOnce all the dependencies have finished downloading, run npm run app-dev to test it, and npm run build to build it for your platform.
\n
Features
\n
\n
Supports: mp3, opus, ogg, wav, aac, m4a and webm.
\n
Reads ID3 tags and displays the artist and album art (if it exists).
\n
Quickly switch tracks from the playlist.
\n
Search for songs from the search bar.
\n
Instantly switch between Dark, Light and Disco modes.
\n
Use keyboard shortcuts to control playback.
\n
\n
Shortcuts
\n
Next track: 🠊 |\nPrevious track: 🠈 |\nVolume up: 🠉 |\nVolume down: 🠋 |\nPlay/pause: Space
\n
Screenshots
\n
\n\n
\n
\n\n
\n
Upcoming Features
\n
Some new features and under the hood stuff that will be or has already been implemented. They'll be included in the next update.
\n
\n
Nothing new yet!
\n
\n
Contributing
\n
Please read CONTRIBUTING.md before raising a PR or creating an issue.
A minimalistic music player, designed for simplicity. Built on electron, uses Howler for handling music playback, Svelte for the UI, and music-metadata to retrieve ID3 tags.
\n
This can also serve as a starting point to implement your own front-end/UI for a music Player.
Download the build for your OS. Start the application and then click on the Folders tab on the top left corner, this will bring up a window where you can select the folder where you want to play your audio files from.\nOnce you select a folder with songs, just click play.
\n
Building from the repo
\n
Clone the repository, make it your working directory, and then on your terminal run npm install.\nOnce all the dependencies have finished downloading, run npm run app-dev to test it, and npm run build to build it for your platform.
\n
Features
\n
\n
Supports: mp3, opus, ogg, wav, aac, m4a and webm.
\n
Reads ID3 tags and displays the artist and album art (if it exists).
\n
Quickly switch tracks from the playlist.
\n
Search for songs from the search bar.
\n
Instantly switch between Dark, Light and Disco modes.
\n
Use keyboard shortcuts to control playback.
\n
\n
Shortcuts
\n
Next track: 🠊 |\nPrevious track: 🠈 |\nVolume up: 🠉 |\nVolume down: 🠋 |\nPlay/pause: Space
\n
Screenshots
\n
\n\n
\n
\n\n
\n
Upcoming Features
\n
Some new features and under the hood stuff that will be or has already been implemented. They'll be included in the next update.
\n
\n
Nothing new yet!
\n
\n
Contributing
\n
Please read CONTRIBUTING.md before raising a PR or creating an issue.
Network Status Check application written with Electron, Bootstrap, jQuery
\n
This is a tool to add URLs and ports to check to see if they are open or not. You can add as many items to the list, and edit the list as well if needed. You can save your list and eventually reimport the list as well on launch or by using the Load URLs button.
\n
Main Window
\n
\n
Run Check
\n
\n
Quick Code Tour
\n
\n
The code entry point is in package.json under the key \"main\". The value is \"main.js\"
\n
main.js creates a BrowserWindow and loads index.html. It also has event handlers that enable keyboard shortcuts for Developer Tools on various platforms. Note that loadURL uses a template literal to give the source file's location.`file://${__dirname}/app/index.html`
\n
index.html loads Bootstrap's CSS in the <head> tag and renderer.js after the closing <body> tag. On the web Bootstrap's JavaScript would also load in this location but the Electron way is to load it in renderer.js with a require(). Note that these src and href attributes use normal relative paths. An HTTP server is not necessary.
\n
renderer.js loads jQuery, Bootstrap and it's dependency; Tether. Each is assigned to the window object because this is the web application custom. It's not the Node.js or Electron custom because window is a global. For now we must do it this way or it won't work.
\n
setup.js setups up some overall settings for the application
\n
app.js is the real worker of functions.
\n
\n
Releases
\n
At this time the releases are for Windows as that is my main developing platform and where I use this tool mostly; on Windows environments.
Electron Forge allows us to make builds based on our operating system we are running from. Linux (Debian) and Windows 10 tested.
\n
npm run make
\n
You can check websites like google.com, github.com, or any URL you need and the port. It is best to use the FQDN for local addresses or use the hostnames IP instead.
\n
Please let me know if you have any issues or questions. If you have a suggestion for approval create an issue or a pull request.
\n
",
+ "readmeOriginal": "
Network Status Check application written with Electron, Bootstrap, jQuery
\n
This is a tool to add URLs and ports to check to see if they are open or not. You can add as many items to the list, and edit the list as well if needed. You can save your list and eventually reimport the list as well on launch or by using the Load URLs button.
\n
Main Window
\n
\n
Run Check
\n
\n
Quick Code Tour
\n
\n
The code entry point is in package.json under the key \"main\". The value is \"main.js\"
\n
main.js creates a BrowserWindow and loads index.html. It also has event handlers that enable keyboard shortcuts for Developer Tools on various platforms. Note that loadURL uses a template literal to give the source file's location.`file://${__dirname}/app/index.html`
\n
index.html loads Bootstrap's CSS in the <head> tag and renderer.js after the closing <body> tag. On the web Bootstrap's JavaScript would also load in this location but the Electron way is to load it in renderer.js with a require(). Note that these src and href attributes use normal relative paths. An HTTP server is not necessary.
\n
renderer.js loads jQuery, Bootstrap and it's dependency; Tether. Each is assigned to the window object because this is the web application custom. It's not the Node.js or Electron custom because window is a global. For now we must do it this way or it won't work.
\n
setup.js setups up some overall settings for the application
\n
app.js is the real worker of functions.
\n
\n
Releases
\n
At this time the releases are for Windows as that is my main developing platform and where I use this tool mostly; on Windows environments.
Electron Forge allows us to make builds based on our operating system we are running from. Linux (Debian) and Windows 10 tested.
\n
npm run make
\n
You can check websites like google.com, github.com, or any URL you need and the port. It is best to use the FQDN for local addresses or use the hostnames IP instead.
\n
Please let me know if you have any issues or questions. If you have a suggestion for approval create an issue or a pull request.
Nicepage gives the ultimate freedom for Web Design 3.0.\nBuild your mobile-friendly Joomla Templates, WordPress Themes and HTML5 websites with no coding in free desktop aplications for Windows and Mac. Nicepage Page Builder is available as a Joomla Extension and WordPress Plugin. There is also a Nicepage edition with online hosting.
\n
Absolute Creativity With No Coding
\n
Nicepage is simple drag-and-drop editor to implement any ideas.
\n
\n
Easy Drag-n-Drop. Easily drag-n-drop to customize anything on your website.
\n
No Coding. Add, edit, move, and modify everything. All visually!
\n
Mobile-Friendly. Build websites that look great on all modern devices.
\n
1000s Web Templates. Select from a huge variety of designer-made templates.
Nicepage gives the ultimate freedom for Web Design 3.0.\nBuild your mobile-friendly Joomla Templates, WordPress Themes and HTML5 websites with no coding in free desktop aplications for Windows and Mac. Nicepage Page Builder is available as a Joomla Extension and WordPress Plugin. There is also a Nicepage edition with online hosting.
\n
Absolute Creativity With No Coding
\n
Nicepage is simple drag-and-drop editor to implement any ideas.
\n
\n
Easy Drag-n-Drop. Easily drag-n-drop to customize anything on your website.
\n
No Coding. Add, edit, move, and modify everything. All visually!
\n
Mobile-Friendly. Build websites that look great on all modern devices.
\n
1000s Web Templates. Select from a huge variety of designer-made templates.
Works completely in the tray. Hides automatically when it looses focus.
\n
Does not appear in the taskbar and window lists when hidden.
\n
Supports keyboard media keys to control the player.
\n
A powerful queue manager to manage your playing queue.
\n
Saves your state so you can continue from where you left off last time.
\n
A simple and efficient playlist system.
\n
Automatically creates playlists based on the Library Sub-Folder Structure
\n
Highly Efficient.
\n
More Features to come soon.
\n
\n
How To Use
\n
\n
Download the appropriate setup and install.
\n
The app only lives in the tray. You have to manipulate it from there. - For Windows, the icon will in the tray next to the clock on the taskbar. Click to show the player. Right click will open up the tray menu with extra options. - For Ubuntu and MacOS, the icon will be in the top-right corner of the screen.
\n
You can change the app to behave as regular windowed app in the settings if you want.
\n
\n
For First Time Users:
\n
\n
Click the settings button on the top-right of the window and select the folder with your music files.
\n
Click of refresh button and wait for the tracks to be loaded.
Works completely in the tray. Hides automatically when it looses focus.
\n
Does not appear in the taskbar and window lists when hidden.
\n
Supports keyboard media keys to control the player.
\n
A powerful queue manager to manage your playing queue.
\n
Saves your state so you can continue from where you left off last time.
\n
A simple and efficient playlist system.
\n
Automatically creates playlists based on the Library Sub-Folder Structure
\n
Highly Efficient.
\n
More Features to come soon.
\n
\n
How To Use
\n
\n
Download the appropriate setup and install.
\n
The app only lives in the tray. You have to manipulate it from there. - For Windows, the icon will in the tray next to the clock on the taskbar. Click to show the player. Right click will open up the tray menu with extra options. - For Ubuntu and MacOS, the icon will be in the top-right corner of the screen.
\n
You can change the app to behave as regular windowed app in the settings if you want.
\n
\n
For First Time Users:
\n
\n
Click the settings button on the top-right of the window and select the folder with your music files.
\n
Click of refresh button and wait for the tracks to be loaded.
When you launch nimblenote you'll be greeted with a welcome page, and after you start typing notes, type in ? into the search box to get additional help.
When you launch nimblenote you'll be greeted with a welcome page, and after you start typing notes, type in ? into the search box to get additional help.
NodeJs Package Manager is an organizer for your npm and Bower packages. So we can call npm package manager and bower package manager\nIt's really easy to check, upgrade or downgrade packages, originally specified during in the one click.\nYou can access all README.md files, Contributors, Dependencies and DevDependencies of package based on their versions.
NodeJs Package Manager is an organizer for your npm and Bower packages. So we can call npm package manager and bower package manager\nIt's really easy to check, upgrade or downgrade packages, originally specified during in the one click.\nYou can access all README.md files, Contributors, Dependencies and DevDependencies of package based on their versions.
This is an Electron template to embed Node-RED with a Dashboard generated by node-red-dashboard.
\n
You can base off this model and update the package.json file to include your own required dependencies.
\n
To Use
\n
To clone and run this repository you'll need Git and Node.js (which comes with npm) installed on your computer. From your command line:
\n
# Clone this repository\ngit clone https://github.com/dceejay/electron-node-red.git\n# Go into the repository\ncd electron-node-red\n# Install dependencies and run the app\nnpm install && npm start
\n
TL:DR - building runtimes
\n
You can run npm run build to build binaries of \"everything\".
\n
Builds are created in the dist directory.
\n
Packaging your application
\n
# build for OSX 64 bits\nnpm run build:osx\n\n# build for Windows 64 bits\nnpm run build:win64\n\n# build for Linux 64 bits\nnpm run build:linux64\n
\n
Learn more about Electron and its API in the documentation.
\n
Use Node-RED command to run. Flows are stored in ~/.node-red.
\n
If you build Node-RED package with community nodes, rename pakcage-pack.json to package.json.
This is an Electron template to embed Node-RED with a Dashboard generated by node-red-dashboard.
\n
You can base off this model and update the package.json file to include your own required dependencies.
\n
To Use
\n
To clone and run this repository you'll need Git and Node.js (which comes with npm) installed on your computer. From your command line:
\n
# Clone this repository\ngit clone https://github.com/dceejay/electron-node-red.git\n# Go into the repository\ncd electron-node-red\n# Install dependencies and run the app\nnpm install && npm start
\n
TL:DR - building runtimes
\n
You can run npm run build to build binaries of \"everything\".
\n
Builds are created in the dist directory.
\n
Packaging your application
\n
# build for OSX 64 bits\nnpm run build:osx\n\n# build for Windows 64 bits\nnpm run build:win64\n\n# build for Linux 64 bits\nnpm run build:linux64\n
\n
Learn more about Electron and its API in the documentation.
\n
Use Node-RED command to run. Flows are stored in ~/.node-red.
\n
If you build Node-RED package with community nodes, rename pakcage-pack.json to package.json.
NodemailerApp is the ultimate cross platform email debugging app.
\n
App includes local SMTP and POP3 servers, a sendmail replacement, and it imports emails from EML files, EMLX files, large MBOX files from Gmail takeout, Maildir folders and Postfix queue files for inspection and preview. Ever wanted to view the actual HTML source of a nicely designed email instead of some garbled rfc822 text? Just open the HTML tab of an email to see it.
\n
Features:
\n
\n
Preview emails either in rich text or plain text mode. View the source of the entire message or the decoded HTML content
\n
Sendmail replacement to catch emails from applications that pipe to sendmail (eg. PHP mail(…)).
\n
Local development server to catch emails from applications that send via SMTP (Nodemailer, PHPMailer etc.).
\n
Message upload to relay a caught message either to next SMTP server or to an IMAP server.
\n
Extensive search to find long lost emails.
\n
Large mailbox import. Received a 10GB mbox takeout file from Gmail? No problem, just import it to NodemailerApp.
\n
Catchall service to accept messages from the internet.
NodemailerApp is the ultimate cross platform email debugging app.
\n
App includes local SMTP and POP3 servers, a sendmail replacement, and it imports emails from EML files, EMLX files, large MBOX files from Gmail takeout, Maildir folders and Postfix queue files for inspection and preview. Ever wanted to view the actual HTML source of a nicely designed email instead of some garbled rfc822 text? Just open the HTML tab of an email to see it.
\n
Features:
\n
\n
Preview emails either in rich text or plain text mode. View the source of the entire message or the decoded HTML content
\n
Sendmail replacement to catch emails from applications that pipe to sendmail (eg. PHP mail(…)).
\n
Local development server to catch emails from applications that send via SMTP (Nodemailer, PHPMailer etc.).
\n
Message upload to relay a caught message either to next SMTP server or to an IMAP server.
\n
Extensive search to find long lost emails.
\n
Large mailbox import. Received a 10GB mbox takeout file from Gmail? No problem, just import it to NodemailerApp.
\n
Catchall service to accept messages from the internet.
I couldn't find a note-taking app that ticked all the boxes I'm interested in: notes are written and rendered in GitHub Flavored Markdown, no WYSIWYG, no proprietary formats, I can run a search & replace across all notes, notes support attachments, the app isn't bloated, the app has a pretty interface, tags are indefinitely nestable and can import Evernote notes (because that's what I was using before).
Part of this comparison is personal opinion: you may disagree on the UI front, things I consider bloat may be considered features by somebody else etc. but hopefully this comparison did a good job at illustrating the main differences.
\n
Features
\n
Markdown-based
\n
Notes are written in GitHub Flavored Markdown, and you can also write KaTeX expressions, Mermaid diagrams and so much more, check out our full Markdown cheatsheet.
\n
Notable also gives you a very powerful Markdown editor, it's the same one VS Code uses in fact, so features like multi-cursors, a minimap and best-in-class syntax highlighting are built-in.
Notes and attachments are simply stored on your disk, this is extremely portable and powerful: you could edit your notes with your favorite editor, have them synchronized via Dropbox, run Git on them, run a regex-based search and replace on them etc.
Zen mode provides a minimalistic editing and reading experience, hiding everything that's not necessary.
\n
Notable is also keyboard friendly, has a quick open window, and we'll soon add a command palette too, so you won't have to click any buttons if you don't want to.
A lot more features are implemented, some of the most important ones are listed here.
\n
Is a feature you care about currently missing? Make sure to browse the issue tracker and add your \"👍\" reaction to the issues you care most about, as we also use those reactions to prioritize issues.
\n
Contributing
\n
There are multiple ways to contribute to this project, read about them here.
\n
Useful Links
\n
\n
Chat: we have a public real-time chat, come join us there.
\n
Cheatsheet: the online version of our built-in Markdown cheatsheet.
\n
Customizations: collection of community-created customizations and tips.
\n
Donations: you can financially support the project via this GitHub Sponsorship page.
I couldn't find a note-taking app that ticked all the boxes I'm interested in: notes are written and rendered in GitHub Flavored Markdown, no WYSIWYG, no proprietary formats, I can run a search & replace across all notes, notes support attachments, the app isn't bloated, the app has a pretty interface, tags are indefinitely nestable and can import Evernote notes (because that's what I was using before).
Part of this comparison is personal opinion: you may disagree on the UI front, things I consider bloat may be considered features by somebody else etc. but hopefully this comparison did a good job at illustrating the main differences.
\n
Features
\n
Markdown-based
\n
Notes are written in GitHub Flavored Markdown, and you can also write KaTeX expressions, Mermaid diagrams and so much more, check out our full Markdown cheatsheet.
\n
Notable also gives you a very powerful Markdown editor, it's the same one VS Code uses in fact, so features like multi-cursors, a minimap and best-in-class syntax highlighting are built-in.
Notes and attachments are simply stored on your disk, this is extremely portable and powerful: you could edit your notes with your favorite editor, have them synchronized via Dropbox, run Git on them, run a regex-based search and replace on them etc.
Zen mode provides a minimalistic editing and reading experience, hiding everything that's not necessary.
\n
Notable is also keyboard friendly, has a quick open window, and we'll soon add a command palette too, so you won't have to click any buttons if you don't want to.
A lot more features are implemented, some of the most important ones are listed here.
\n
Is a feature you care about currently missing? Make sure to browse the issue tracker and add your \"👍\" reaction to the issues you care most about, as we also use those reactions to prioritize issues.
\n
Contributing
\n
There are multiple ways to contribute to this project, read about them here.
\n
Useful Links
\n
\n
Chat: we have a public real-time chat, come join us there.
\n
Cheatsheet: the online version of our built-in Markdown cheatsheet.
\n
Customizations: collection of community-created customizations and tips.
\n
Donations: you can financially support the project via this GitHub Sponsorship page.
Warning: This app is now deprecated, you should use Notable instead, which is a much better note-taking app overall, its zen mode can replace Noty's UI pretty effectively and it is very actively developed.
Warning: This app is now deprecated, you should use Notable instead, which is a much better note-taking app overall, its zen mode can replace Noty's UI pretty effectively and it is very actively developed.
nteract is an open-source organization committed to creating fantastic\ninteractive computing experiences that allow people to collaborate with ease.
\n
We build SDKs, applications, and libraries that help you and your team make\nthe most of interactive (particularly Jupyter) notebooks and REPLs.
\n
To learn more about the nteract open source organization and the rest of our\nprojects, please visit our website.
\n
What's in this repo?
\n
This repo is a monorepo. It contains the code for the nteract core SDK and\nnteract's desktop and web applications. It also contains the documentation for\nthe SDK and the applications. Here's a quick guide to the contents of the\nmonorepo.
\n
\n\n
\n
Folder
\n
Description
\n
\n\n\n
\n
applications/desktop
\n
Source code for the nteract desktop application. The desktop application is a cross-platform app built using Electron.
\n
\n
\n
applications/jupyter-extension
\n
Source code the nteract Jupyter extension. This extension can be installed alongside Jupyter classic and JupyterLab in your Jupyter deployments or personal Jupyter server.
\n
\n
\n
packages
\n
JavaScript packages that are part of the nteract core SDK.
\n
\n
\n
changelogs
\n
Changelogs for each release of the nteract core SDK and applications.
\n
\n\n
\n
How do I contribute to this repo?
\n
If you are interested in contributing to nteract, please read the\ncontribution guidelines for information on how to set up\nyour nteract repo for development, how to write tests and validate changes,\nhow to update documentation, and how to submit your code changes for review on\nGitHub.
\n
How do I use the nteract core SDK?
\n
If you are a developer who wants to build an nteract-based notebook application,\ncheck out the following documentation resources for more info.
This page contains the documentation for our suite of composable React components. It contains code samples that you can reference when building your nteract-based UI.
\n
\n\n
\n
Our documentation is living. We are always making changes and adding more\ncontent. If you have feedback about the documentation, please open an issue\nin this repo. If you are interested in submitting a change to our documentation\npage, please review the contribution guidelines and\nsubmit a pull request.
\n
How do I use the nteract desktop application?
\n
To get started with the nteract desktop app, head over to the\nnteract homepage to download the application for your\noperating system.
\n
Once you've download the app, head over to our\ndocumentation page for tutorials and guides on\nusing the app for your data analysis and science workflows.
\n
Supporting nteract
\n
nteract is a non-profit open-source organization fiscally sponsored by\nNumFOCUS. If you are interested in supporting development on nteract, please consider making a recurring donation.
\n
Development on nteract is also supported by the following organizations.
\n
\n
\n
\n\n
\n
\n\n
\n
\n
\n
\n
\n
\n
",
+ "readmeOriginal": "
\n
the interactive computing suite for you
\n
\n\n\n\n\n
\n
nteract is an open-source organization committed to creating fantastic\ninteractive computing experiences that allow people to collaborate with ease.
\n
We build SDKs, applications, and libraries that help you and your team make\nthe most of interactive (particularly Jupyter) notebooks and REPLs.
\n
To learn more about the nteract open source organization and the rest of our\nprojects, please visit our website.
\n
What's in this repo?
\n
This repo is a monorepo. It contains the code for the nteract core SDK and\nnteract's desktop and web applications. It also contains the documentation for\nthe SDK and the applications. Here's a quick guide to the contents of the\nmonorepo.
\n
\n\n
\n
Folder
\n
Description
\n
\n\n\n
\n
applications/desktop
\n
Source code for the nteract desktop application. The desktop application is a cross-platform app built using Electron.
\n
\n
\n
applications/jupyter-extension
\n
Source code the nteract Jupyter extension. This extension can be installed alongside Jupyter classic and JupyterLab in your Jupyter deployments or personal Jupyter server.
\n
\n
\n
packages
\n
JavaScript packages that are part of the nteract core SDK.
\n
\n
\n
changelogs
\n
Changelogs for each release of the nteract core SDK and applications.
\n
\n\n
\n
How do I contribute to this repo?
\n
If you are interested in contributing to nteract, please read the\ncontribution guidelines for information on how to set up\nyour nteract repo for development, how to write tests and validate changes,\nhow to update documentation, and how to submit your code changes for review on\nGitHub.
\n
How do I use the nteract core SDK?
\n
If you are a developer who wants to build an nteract-based notebook application,\ncheck out the following documentation resources for more info.
This page contains the documentation for our suite of composable React components. It contains code samples that you can reference when building your nteract-based UI.
\n
\n\n
\n
Our documentation is living. We are always making changes and adding more\ncontent. If you have feedback about the documentation, please open an issue\nin this repo. If you are interested in submitting a change to our documentation\npage, please review the contribution guidelines and\nsubmit a pull request.
\n
How do I use the nteract desktop application?
\n
To get started with the nteract desktop app, head over to the\nnteract homepage to download the application for your\noperating system.
\n
Once you've download the app, head over to our\ndocumentation page for tutorials and guides on\nusing the app for your data analysis and science workflows.
\n
Supporting nteract
\n
nteract is a non-profit open-source organization fiscally sponsored by\nNumFOCUS. If you are interested in supporting development on nteract, please consider making a recurring donation.
\n
Development on nteract is also supported by the following organizations.
nuclear is a free music streaming program that pulls content from free sources all over the internet.
\n
If you know mps-youtube, this is a similar music player but with a GUI.\nIt's also focusing more on audio. Imagine Spotify which you don't have to pay for and with a bigger library.
Searching for and playing music from YouTube (including integration with playlists and SponsorBlock), Jamendo, Audius and SoundCloud
\n
Searching for albums (powered by Last.fm and Discogs), album view, automatic song lookup based on artist and track name (in progress, can be dodgy sometimes)
\n
Song queue, which can be exported as a playlist
\n
Loading saved playlists (stored in json files)
\n
Scrobbling to last.fm (along with updating the 'now playing' status)
Nuclear has already been translated to several languages, and we're always looking for contributors who would like to add more. Below is a list of currently available languages, along with contributors who helped to translate Nuclear to that language.
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.
\n
",
+ "readmeOriginal": "
\n
\n
Desktop music player focused on streaming from free sources
nuclear is a free music streaming program that pulls content from free sources all over the internet.
\n
If you know mps-youtube, this is a similar music player but with a GUI.\nIt's also focusing more on audio. Imagine Spotify which you don't have to pay for and with a bigger library.
Searching for and playing music from YouTube (including integration with playlists and SponsorBlock), Jamendo, Audius and SoundCloud
\n
Searching for albums (powered by Last.fm and Discogs), album view, automatic song lookup based on artist and track name (in progress, can be dodgy sometimes)
\n
Song queue, which can be exported as a playlist
\n
Loading saved playlists (stored in json files)
\n
Scrobbling to last.fm (along with updating the 'now playing' status)
Nuclear has already been translated to several languages, and we're always looking for contributors who would like to add more. Below is a list of currently available languages, along with contributors who helped to translate Nuclear to that language.
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.
A Node.js & Electron application for easily configuring your freshly-imaged OctoPi microSD adapter
\n
\n
Node.js is an open-source, cross-platform JavaScript run-time environment that executes JavaScript code server-side.
\n
Electron is an open-source framework for developing executable cross-platform desktop applications.
\n
OctoPrint is the leading web software for controlling 3D printers, created/maintained by Gina Häußge
\n
OctoPi is a Raspberry-specific distro of OctoPrint, maintained by Guy Sheffer
\n
\n
Overview
\n
Getting started with OctoPrint—as loaded on a Raspberry Pi computer—involves installing an OctoPi image and then some configuration work before this computer can bootup. This application hopes to make that configuration step much easier by introducing a desktop application to perform this step.
\n
\n
Installation
\n
At the moment, only OSX and Windows installers are available. Two Linux versions are available (AppImage and deb) which require a small amount of work to get going.
\n\n
Download the latest OctoPi image and follow the instructions there to burn it to your microSD card
\n
Using the octopi-init software here, configure that microSD card from your workstation, ejecting it when finished
\n
Put the microSD card into the Raspberry Pi and boot it to continue
\n\n
\n
Windows installation
\n
After downloading the setup executable, you may see the error dialog \"Windows protected your PC: Windows Defender SmartScreen prevented an unrecognized app from starting. Running this app might put your PC at risk. More info...\"
\n
This is Microsoft taking a page out of Apple's playbook and also trying to charge developers each year to digitally sign apps they're giving away for free.
\n
Simply click the More info link and select the Run anyway button to continue.
\n
Linux installation
\n
After downloading the AppImage file, you'll minimally need to mark the file so that it can be executed.
\n
Make it executable by running chmod a+x octopi-init*.AppImage then execute it with ./octopi-init*.AppImage
\n
Alternately, for the deb file image, you'd want to install it with sudo apt install ~/Downloads/octopi-init-1.0.9_amd64.deb, for example.
\n
Apple warning message
\n
When running octopi-init the first time, you'll need to Ctl-Click the application and select Open. Otherwise, you'll see a confusing warning like this:
\n
\n
It's just Apple trying to make $99 per developer per year as part of their business model. As suggested, Ctl-Click the program and choose Open to see:
\n
\n
Then just click the Open button again and you should be good to go. You won't have to repeat this again, in theory.
\n
\n\n
\n
Description
\n
Version
\n
Author
\n
Last Update
\n
\n\n\n
\n
octopi-init
\n
v1.1.2
\n
OutsourcedGuru
\n
August 23, 2018
\n
\n\n
\n
\n\n
\n
Donate
\n
\n
Cryptocurrency
\n
\n\n\n
\n
\n
\n
\n
\n
\n
Ethereum
\n
\n
Bitcoin
\n
\n\n
\n
",
+ "readmeOriginal": "
octopi-init
\n
A Node.js & Electron application for easily configuring your freshly-imaged OctoPi microSD adapter
\n
\n
Node.js is an open-source, cross-platform JavaScript run-time environment that executes JavaScript code server-side.
\n
Electron is an open-source framework for developing executable cross-platform desktop applications.
\n
OctoPrint is the leading web software for controlling 3D printers, created/maintained by Gina Häußge
\n
OctoPi is a Raspberry-specific distro of OctoPrint, maintained by Guy Sheffer
\n
\n
Overview
\n
Getting started with OctoPrint—as loaded on a Raspberry Pi computer—involves installing an OctoPi image and then some configuration work before this computer can bootup. This application hopes to make that configuration step much easier by introducing a desktop application to perform this step.
\n
\n
Installation
\n
At the moment, only OSX and Windows installers are available. Two Linux versions are available (AppImage and deb) which require a small amount of work to get going.
\n\n
Download the latest OctoPi image and follow the instructions there to burn it to your microSD card
\n
Using the octopi-init software here, configure that microSD card from your workstation, ejecting it when finished
\n
Put the microSD card into the Raspberry Pi and boot it to continue
\n\n
\n
Windows installation
\n
After downloading the setup executable, you may see the error dialog \"Windows protected your PC: Windows Defender SmartScreen prevented an unrecognized app from starting. Running this app might put your PC at risk. More info...\"
\n
This is Microsoft taking a page out of Apple's playbook and also trying to charge developers each year to digitally sign apps they're giving away for free.
\n
Simply click the More info link and select the Run anyway button to continue.
\n
Linux installation
\n
After downloading the AppImage file, you'll minimally need to mark the file so that it can be executed.
\n
Make it executable by running chmod a+x octopi-init*.AppImage then execute it with ./octopi-init*.AppImage
\n
Alternately, for the deb file image, you'd want to install it with sudo apt install ~/Downloads/octopi-init-1.0.9_amd64.deb, for example.
\n
Apple warning message
\n
When running octopi-init the first time, you'll need to Ctl-Click the application and select Open. Otherwise, you'll see a confusing warning like this:
\n
\n
It's just Apple trying to make $99 per developer per year as part of their business model. As suggested, Ctl-Click the program and choose Open to see:
\n
\n
Then just click the Open button again and you should be good to go. You won't have to repeat this again, in theory.
To clone and run this repository you'll need Git and Node.js (which comes with npm) installed on your computer.
\n
The first thing you need is the source code, in your command line:
\n
# Clone this repository\ngit clone https://github.com/liberodark/ODrive
\n
This will download all the source code in a \"ODrive\" folder in the current directory. Alternatively, you can download and extract the zip from github's interface.
\n
The steps below (Setup, Build, Run) are to execute in order to ready everything.
\n
Setup
\n
This step is only needed once, in order to install the necessary environment on your computer for ODrive to run.
\n
# Needed for electron 1.7+ to run, as it's based on chrome\nsudo apt install libgconf-2-4
\n
Note: If you're using Linux Bash for Windows, see this guide or use node from the command prompt.
\n
Build
\n
This step is to execute every new version of the source code.
\n
In the project directory:
\n
npm install
\n
Note: If you're using Ubuntu and you get an error message about a missing node binary, you may want to try this:
\n
sudo ln -s `which nodejs` /usr/bin/node
\n
If you are working on the code yourself and editing some files in app/assets/, you will need to run npm run webpack (or npm install) for those changes to have an impact on the application.
\n
Run
\n
In the project directory:
\n
npm start
\n
On Windows, you can make a .bat file with start cmd /k npm start that then you can double click to launch the program.
\n
The launch-on-startup functionality is only available on bundled releases. See the Deployment section.
\n
Testing
\n
To make sure the code is ok and run some sanity checks on it:
\n
npm test
\n
Deployment
\n
Releases
\n
There are currently three \"release\" formats supported: nsis (Windows installer) for Windows, AppImage for Linux, and DMG for Mac. You can generate them like this:
\n
npm run release-windows\nnpm run release-linux\nnpm run release-mac
\n
To create a different format, like a deb or rpm package for example:
\n
For DEB
\n
npm run release-linux deb
\n
For RPM
\n
sudo yum install rpm-build -y\nnpm run release-linux rpm\n
\n
The releases are generated in the dist folder.
\n
All formats supported by electron-builder are available, such as 7z, zip, tar.gz, deb, rpm, freebsd, pacman, p5p, apk, dmg, pkg, mas, nsis, appx, msi...
\n
Permissionless deployment
\n
An appimage on linux already runs permissionless. Anyway, you can just do:
\n
# Permissonless deployment\nnpm run release-windows dir # or zip, 7zip, tar.xz, tar.7z, ...
\n
This will create a folder in dist that you can just copy to a Windows machine.
To clone and run this repository you'll need Git and Node.js (which comes with npm) installed on your computer.
\n
The first thing you need is the source code, in your command line:
\n
# Clone this repository\ngit clone https://github.com/liberodark/ODrive
\n
This will download all the source code in a \"ODrive\" folder in the current directory. Alternatively, you can download and extract the zip from github's interface.
\n
The steps below (Setup, Build, Run) are to execute in order to ready everything.
\n
Setup
\n
This step is only needed once, in order to install the necessary environment on your computer for ODrive to run.
\n
# Needed for electron 1.7+ to run, as it's based on chrome\nsudo apt install libgconf-2-4
\n
Note: If you're using Linux Bash for Windows, see this guide or use node from the command prompt.
\n
Build
\n
This step is to execute every new version of the source code.
\n
In the project directory:
\n
npm install
\n
Note: If you're using Ubuntu and you get an error message about a missing node binary, you may want to try this:
\n
sudo ln -s `which nodejs` /usr/bin/node
\n
If you are working on the code yourself and editing some files in app/assets/, you will need to run npm run webpack (or npm install) for those changes to have an impact on the application.
\n
Run
\n
In the project directory:
\n
npm start
\n
On Windows, you can make a .bat file with start cmd /k npm start that then you can double click to launch the program.
\n
The launch-on-startup functionality is only available on bundled releases. See the Deployment section.
\n
Testing
\n
To make sure the code is ok and run some sanity checks on it:
\n
npm test
\n
Deployment
\n
Releases
\n
There are currently three \"release\" formats supported: nsis (Windows installer) for Windows, AppImage for Linux, and DMG for Mac. You can generate them like this:
\n
npm run release-windows\nnpm run release-linux\nnpm run release-mac
\n
To create a different format, like a deb or rpm package for example:
\n
For DEB
\n
npm run release-linux deb
\n
For RPM
\n
sudo yum install rpm-build -y\nnpm run release-linux rpm\n
\n
The releases are generated in the dist folder.
\n
All formats supported by electron-builder are available, such as 7z, zip, tar.gz, deb, rpm, freebsd, pacman, p5p, apk, dmg, pkg, mas, nsis, appx, msi...
\n
Permissionless deployment
\n
An appimage on linux already runs permissionless. Anyway, you can just do:
\n
# Permissonless deployment\nnpm run release-windows dir # or zip, 7zip, tar.xz, tar.7z, ...
\n
This will create a folder in dist that you can just copy to a Windows machine.
Copyright (C) 2017-present, HyunmoAhn\n\nThis program is free software: you can redistribute it and/or modify\nit under the terms of the GNU General Public License as published by\nthe Free Software Foundation, either version 3 of the License, or\n(at your option) any later version.\n\nThis program is distributed in the hope that it will be useful,\nbut WITHOUT ANY WARRANTY; without even the implied warranty of\nMERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\nGNU General Public License for more details.\n\nYou should have received a copy of the GNU General Public License\nalong with this program. If not, see <http://www.gnu.org/licenses/>.\n
\n",
+ "readmeOriginal": "
\n
Oh-My-Desk
\n
\n \n \n \n \n \n \n \n
\n
It is using web page as a widget that desktop application.
Copyright (C) 2017-present, HyunmoAhn\n\nThis program is free software: you can redistribute it and/or modify\nit under the terms of the GNU General Public License as published by\nthe Free Software Foundation, either version 3 of the License, or\n(at your option) any later version.\n\nThis program is distributed in the hope that it will be useful,\nbut WITHOUT ANY WARRANTY; without even the implied warranty of\nMERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\nGNU General Public License for more details.\n\nYou should have received a copy of the GNU General Public License\nalong with this program. If not, see <http://www.gnu.org/licenses/>.\n
A browser built on top of Electron using nothing but pure web technologies.
\n
\n
\n
Features
\n
\n
Your web menu - Open tabs, your favorites and history only one click away, no longer hidden behind a scrollbar or menu option.
\n
Smarter url bar - Our URL bar will show you the true domain of a site just in case you do click anything fishy.
\n
Minimal UI - The simplest we could possible make the browser without causing more clicks.
\n
\n
Contributing
\n
If you find any bugs or want to improve OhHai Browser please feel free to submit a pull request, open an issue or send a homing pigeon. OhHai Browser is under constant development meaning bugs may happen from time to time (we're only human!). It would be great if you could point these our or even help us defeat them.
\n
Running
\n
Before running OhHai Browser please make sure you have the latestNode.js installed on your machine.
\n
To run, open the repo in a terminal and run:
\n
npm install\n
\n
Once this is done you can open the project in your editor of choice and run:
\n
npm run debug\n
\n
This should open the development version of the browser.
\n
Simples!
\n
",
+ "readmeOriginal": "
\n\n
OhHai Browser
\n
\n
\n
A browser built on top of Electron using nothing but pure web technologies.
\n
\n
\n
Features
\n
\n
Your web menu - Open tabs, your favorites and history only one click away, no longer hidden behind a scrollbar or menu option.
\n
Smarter url bar - Our URL bar will show you the true domain of a site just in case you do click anything fishy.
\n
Minimal UI - The simplest we could possible make the browser without causing more clicks.
\n
\n
Contributing
\n
If you find any bugs or want to improve OhHai Browser please feel free to submit a pull request, open an issue or send a homing pigeon. OhHai Browser is under constant development meaning bugs may happen from time to time (we're only human!). It would be great if you could point these our or even help us defeat them.
\n
Running
\n
Before running OhHai Browser please make sure you have the latestNode.js installed on your machine.
\n
To run, open the repo in a terminal and run:
\n
npm install\n
\n
Once this is done you can open the project in your editor of choice and run:
\n
npm run debug\n
\n
This should open the development version of the browser.
Note: I am taking an indefinite break on this project as I'm shifting my focus to https://virtc.app.
\n
If you are interested in learning how to share your desktop via the browser, I would recommend looking at simple-peer. If you have any questions regarding this project, you can reach me at ruben@leunix.nl.
\n
On/Office
\n
\n
On/Office was created to give you some distraction-free privacy during your work. Making use of powerful Virtual Reality and Web technologies, this application offers you a customisable, virtual room where the screen from your computer is streamed in front of you. Fetch a comfy seat, wear your headset and get ready to work distraction-free.
\n
Features
\n
🏢 Carry a virtual office with you anywhere.
\n
🌍 Change your environment to anything you'd like with a Panoramic image.
\n
🔗 Powered by web technology. Runs on any headset supporting WebVR.
\n
🖱️ A handy virtual cursor to keep your mouse position on the virtual screen synced at all times
\n
💻 Available for Windows and Mac. Linux version pending.
\n
😎 Fully open-source. Read the DEVELOPMENT.md file for more background on how the code is structured and how you can get involved.
\n
Supported headsets
\n
\n
HTC Vive
\n
Windows MR
\n
Oculus Quest
\n
Oculus Go
\n
Samsung Gear VR
\n
Google Daydream
\n
Google Cardboard (Android & iOS)
\n
\n
(but technically, any headset with support for WebVR will work)
\n
Roadmap
\n
\n
Provide separate instructions per supported headset (*)
Place applications as separate windows in the virtual environments (*)
\n
\n
These issues are sorted in random order. Each item has an entry on the issues page. You can find the current progress there. Feel free to contribute in any way possible. Anything is welcome: Feedback, thoughts on priority, implementations, ideas for new features, etc.
\n
Contributors
\n
\n
Nick van Manen for his invaluable contributions in getting this project up and running.
Peter Kassenaar whose workshop inspired me to rewrite the client to a VueJS project.
\n
\n
",
+ "readmeOriginal": "
Note: I am taking an indefinite break on this project as I'm shifting my focus to https://virtc.app.
\n
If you are interested in learning how to share your desktop via the browser, I would recommend looking at simple-peer. If you have any questions regarding this project, you can reach me at ruben@leunix.nl.
\n
On/Office
\n
\n
On/Office was created to give you some distraction-free privacy during your work. Making use of powerful Virtual Reality and Web technologies, this application offers you a customisable, virtual room where the screen from your computer is streamed in front of you. Fetch a comfy seat, wear your headset and get ready to work distraction-free.
\n
Features
\n
🏢 Carry a virtual office with you anywhere.
\n
🌍 Change your environment to anything you'd like with a Panoramic image.
\n
🔗 Powered by web technology. Runs on any headset supporting WebVR.
\n
🖱️ A handy virtual cursor to keep your mouse position on the virtual screen synced at all times
\n
💻 Available for Windows and Mac. Linux version pending.
\n
😎 Fully open-source. Read the DEVELOPMENT.md file for more background on how the code is structured and how you can get involved.
\n
Supported headsets
\n
\n
HTC Vive
\n
Windows MR
\n
Oculus Quest
\n
Oculus Go
\n
Samsung Gear VR
\n
Google Daydream
\n
Google Cardboard (Android & iOS)
\n
\n
(but technically, any headset with support for WebVR will work)
\n
Roadmap
\n
\n
Provide separate instructions per supported headset (*)
Place applications as separate windows in the virtual environments (*)
\n
\n
These issues are sorted in random order. Each item has an entry on the issues page. You can find the current progress there. Feel free to contribute in any way possible. Anything is welcome: Feedback, thoughts on priority, implementations, ideas for new features, etc.
\n
Contributors
\n
\n
Nick van Manen for his invaluable contributions in getting this project up and running.
\n Opale is a wrapper for the famous Facebook Messenger widely used nowadays. More than a wrapper, Opale brings\nsomething very particular, the Opale bubble. You've certainly experienced the Facebook Messenger bubble which you\ncan play with on your Android smartphone, Opale does the same old trick on your computer. The bubble tells you\nhow many conversations you've missed, and it blinks when you get incoming messages. It's really useful when you're\nmulti-tasking and you just don't want to switch between tabs or windows slowly since it's a pain.
\n
\n\n
\n
Features
\n
\n
Messenger app native from Facebook
\n
Bubble which you can interact with and use to show/hide chat and which you can move around.
\n
Shortcuts which you can use to show/hide the bubble or show/hide the chat.
\n
Some settings allowing you to save your account informations and to log you automatically in Messenger.
\n
The bubble keeps always on top so that you can always have it right under the hand.
\n
Opale Messenger keeps in your system tray, and the bubble can be toggled by right-cliking on it.
\n
\n
Keyboard shortcuts
\n
\n\n
\n
Description
\n
Keys
\n
\n\n\n
\n
Toggle bubble
\n
AltQ
\n
\n
\n
Toggle chat window
\n
AltA
\n
\n
\n
Unfocus the bubble
\n
AltZ
\n
\n\n
\n
Install
\n
$ git clone https://github.com/DavidMellul/Opale-Messenger.git\n$ cd Opale-Messenger\n$ npm install\n$ npm start
\n
Platforms supported
\n
Since I'm developing Opale Messenger on Windows, everything should work fine on any Windows OS.
\nSince Electron is cross-platform, it should also work well on Mac OS X & Linux but I can't ensure it.
\n
I've tested Opale Messenger on Mac OS Sierra thank's to vmware, everything seems alright. \nThank's to @svin83 who has tested on Linux Mint Mate, Opale works on this Linux distribution and certainly on other distros (Note: The bubble's background doesn't work well on Linux -> see issue).
\n
Builds and Installers
\n
Till now (the 20 January 2017 when I'm writing) the only installer I've been making (with electron-packager and innoSetup) is for Windows 32 bits, so that it works on both operating systems no matter it's architecture is wheter x86 or x64.
Important: Your antivirus may consider checking the installer and the launcher the first time, nevermind I didn't sign my software, nothing to worry about.
\n
Further improvements
\n
I would be glad if someone could give me a feedback or just tell me how I could simply improve. \nI would consider being a lot more greatful if someone could package the app so that users could use Opale Messenger on both Windows and Mac (Linux maybe ?) with an installer. ( ---> Further teamworking on cool projects ?)
\n
Bugs and Issues
\n
If you catch any suspect behavior or anything you could simply describe as an \"issue\" / \"bug\", please post an issue / pull request about it.
\n
Disclaimer
\n
Remark 1: I'm a student in computer science, I'm mainly focused on software development, please be constructive and keen on anything you could think is a bad habit since I've almost never experienced web development more than some tricky webdesign and some AJAX (JQuery / JS / PHP).
\nRemark 2: I don't believe I'll have time to maintain this project or to make it better since it's purpose was to train cross-platform hybrid software development, any help would be sincerely very appreciated.
\n
License
\n
This software is under the MIT License which can be found in the file named as LICENSE.
\n
",
+ "readmeOriginal": "
\n\n Opale Messenger \n
\n
\n Opale is a wrapper for the famous Facebook Messenger widely used nowadays. More than a wrapper, Opale brings\nsomething very particular, the Opale bubble. You've certainly experienced the Facebook Messenger bubble which you\ncan play with on your Android smartphone, Opale does the same old trick on your computer. The bubble tells you\nhow many conversations you've missed, and it blinks when you get incoming messages. It's really useful when you're\nmulti-tasking and you just don't want to switch between tabs or windows slowly since it's a pain.
\n
\n\n
\n
Features
\n
\n
Messenger app native from Facebook
\n
Bubble which you can interact with and use to show/hide chat and which you can move around.
\n
Shortcuts which you can use to show/hide the bubble or show/hide the chat.
\n
Some settings allowing you to save your account informations and to log you automatically in Messenger.
\n
The bubble keeps always on top so that you can always have it right under the hand.
\n
Opale Messenger keeps in your system tray, and the bubble can be toggled by right-cliking on it.
\n
\n
Keyboard shortcuts
\n
\n\n
\n
Description
\n
Keys
\n
\n\n\n
\n
Toggle bubble
\n
AltQ
\n
\n
\n
Toggle chat window
\n
AltA
\n
\n
\n
Unfocus the bubble
\n
AltZ
\n
\n\n
\n
Install
\n
$ git clone https://github.com/DavidMellul/Opale-Messenger.git\n$ cd Opale-Messenger\n$ npm install\n$ npm start
\n
Platforms supported
\n
Since I'm developing Opale Messenger on Windows, everything should work fine on any Windows OS.
\nSince Electron is cross-platform, it should also work well on Mac OS X & Linux but I can't ensure it.
\n
I've tested Opale Messenger on Mac OS Sierra thank's to vmware, everything seems alright. \nThank's to @svin83 who has tested on Linux Mint Mate, Opale works on this Linux distribution and certainly on other distros (Note: The bubble's background doesn't work well on Linux -> see issue).
\n
Builds and Installers
\n
Till now (the 20 January 2017 when I'm writing) the only installer I've been making (with electron-packager and innoSetup) is for Windows 32 bits, so that it works on both operating systems no matter it's architecture is wheter x86 or x64.
Important: Your antivirus may consider checking the installer and the launcher the first time, nevermind I didn't sign my software, nothing to worry about.
\n
Further improvements
\n
I would be glad if someone could give me a feedback or just tell me how I could simply improve. \nI would consider being a lot more greatful if someone could package the app so that users could use Opale Messenger on both Windows and Mac (Linux maybe ?) with an installer. ( ---> Further teamworking on cool projects ?)
\n
Bugs and Issues
\n
If you catch any suspect behavior or anything you could simply describe as an \"issue\" / \"bug\", please post an issue / pull request about it.
\n
Disclaimer
\n
Remark 1: I'm a student in computer science, I'm mainly focused on software development, please be constructive and keen on anything you could think is a bad habit since I've almost never experienced web development more than some tricky webdesign and some AJAX (JQuery / JS / PHP).
\nRemark 2: I don't believe I'll have time to maintain this project or to make it better since it's purpose was to train cross-platform hybrid software development, any help would be sincerely very appreciated.
\n
License
\n
This software is under the MIT License which can be found in the file named as LICENSE.
Open IAS Scoreboard is still in development and not ready for production use.
\n
Open IAS Scoreboard is an Electron application originaly for putting scoreboards on IASAS event livestreams.
\n
While this was the original use of Open IAS Scoreboard, feel free to use the program for any purpose. Any pull requests that expand the capabilities of Open IAS Scoreboard, even beyond the original purpose is appreciated.
\n
Features
\n
\n
Scorekeeping
\n
Game Clock\n
\n
Count Down
\n
Count Up
\n
Adjust on the fly
\n
\n
\n
Keyboard Bindings
\n
Set Team Logo
\n
Multiple Scoreboard Tabs\n
\n
Set up future games in a new tab then keep it hidden
\n
Control multiple Scoreboard scoreboards through one control window.
If you found a bug or have a feature request, please make an issue.
\n
Feel free to make pull requests with bug fixes or new features. You may also make an issue with a new feature proposal so that it can be discussed before beginning work.
Open IAS Scoreboard is still in development and not ready for production use.
\n
Open IAS Scoreboard is an Electron application originaly for putting scoreboards on IASAS event livestreams.
\n
While this was the original use of Open IAS Scoreboard, feel free to use the program for any purpose. Any pull requests that expand the capabilities of Open IAS Scoreboard, even beyond the original purpose is appreciated.
\n
Features
\n
\n
Scorekeeping
\n
Game Clock\n
\n
Count Down
\n
Count Up
\n
Adjust on the fly
\n
\n
\n
Keyboard Bindings
\n
Set Team Logo
\n
Multiple Scoreboard Tabs\n
\n
Set up future games in a new tab then keep it hidden
\n
Control multiple Scoreboard scoreboards through one control window.
If you found a bug or have a feature request, please make an issue.
\n
Feel free to make pull requests with bug fixes or new features. You may also make an issue with a new feature proposal so that it can be discussed before beginning work.
This is the reference client for the OpenBazaar network. It is an interface for your OpenBazaar node, to use it you will need to run an OpenBazaar node either locally or on a remote server.
\n
For full installable versions of the OpenBazaar app, with the server and client bundled together, go to the OpenBazaar download page.
\n
\n
Getting Started
\n
To create a local development copy of the reference client, clone the client repository into a directory of your choice:
Make sure you have Node.js and NPM installed. Node versions older than 8.9.2 or NPM versions older than 5.5.1 may not work.
\n
This client uses Babel to compile ES6 JavaScript. You should be familiar with ES6 before modifying its code.
\n
Installation
\n\n
Navigate to the directory you cloned the repo into.
\n
Enter npm install
\n\n
Running
\n
npm start will:
\n
\n
compile your Sass / re-compile on changes
\n
run BrowserSync in watch mode so the app automatically refreshes on JS and HTML changes and dynamically injects any CSS / Sass changes**.
\n
launch the Electron app
\n
\n
** At this time, the app will not refresh on main.js (or other root folder JS changes). This would require the entire Electron app to refresh and BrowserSync is only refreshing our browser.
\n
Linux Troubleshooting
\n
If you see an ENOSPC error after trying npm start and you are using Linux, you may need to do the following:
\n\n
Enter this on the command line:\necho fs.inotify.max_user_watches=524288 | sudo tee -a /etc/sysctl.conf && sudo sysctl -p
\n\n
For Arch Linux add this line to /etc/sysctl.d/99-sysctl.conf:\nfs.inotify.max_user_watches=524288
\n\n
Execute: sysctl --system
\n\n
This will prevent your system from having errors due to too many files being watched.
\n
Linting
\n
npm run lint will run eslint on the JS files.
\n
npm run lint:watch will run eslint on any JS file changes.
\n
Testing
\n
npm run test will execute test files in the test folder.
\n
npm run test:watch will execute the tests on any file changes.
You can request new languages there, and contribute to the translation of existing languages.
\n
New languages are usually added when they reach 80% or more completion, and not removed from the client unless they fall below 60% for several releases.
\n
License
\n
This project is licensed under the MIT License. You can view LICENSE.MD for more details.
\n
",
+ "readmeOriginal": "
OpenBazaar Client v2
\n
This is the reference client for the OpenBazaar network. It is an interface for your OpenBazaar node, to use it you will need to run an OpenBazaar node either locally or on a remote server.
\n
For full installable versions of the OpenBazaar app, with the server and client bundled together, go to the OpenBazaar download page.
\n
\n
Getting Started
\n
To create a local development copy of the reference client, clone the client repository into a directory of your choice:
Make sure you have Node.js and NPM installed. Node versions older than 8.9.2 or NPM versions older than 5.5.1 may not work.
\n
This client uses Babel to compile ES6 JavaScript. You should be familiar with ES6 before modifying its code.
\n
Installation
\n\n
Navigate to the directory you cloned the repo into.
\n
Enter npm install
\n\n
Running
\n
npm start will:
\n
\n
compile your Sass / re-compile on changes
\n
run BrowserSync in watch mode so the app automatically refreshes on JS and HTML changes and dynamically injects any CSS / Sass changes**.
\n
launch the Electron app
\n
\n
** At this time, the app will not refresh on main.js (or other root folder JS changes). This would require the entire Electron app to refresh and BrowserSync is only refreshing our browser.
\n
Linux Troubleshooting
\n
If you see an ENOSPC error after trying npm start and you are using Linux, you may need to do the following:
\n\n
Enter this on the command line:\necho fs.inotify.max_user_watches=524288 | sudo tee -a /etc/sysctl.conf && sudo sysctl -p
\n\n
For Arch Linux add this line to /etc/sysctl.d/99-sysctl.conf:\nfs.inotify.max_user_watches=524288
\n\n
Execute: sysctl --system
\n\n
This will prevent your system from having errors due to too many files being watched.
\n
Linting
\n
npm run lint will run eslint on the JS files.
\n
npm run lint:watch will run eslint on any JS file changes.
\n
Testing
\n
npm run test will execute test files in the test folder.
\n
npm run test:watch will execute the tests on any file changes.
You can request new languages there, and contribute to the translation of existing languages.
\n
New languages are usually added when they reach 80% or more completion, and not removed from the client unless they fall below 60% for several releases.
\n
License
\n
This project is licensed under the MIT License. You can view LICENSE.MD for more details.
# Clone this repository\n$ git clone https://github.com/tmoreno/open-log-viewer\n\n# Go into the repository\n$ cd open-log-viewer\n\n# Install dependencies\n$ npm install\n\n# Build app\n$ npm run build\n\n# Run the app\n$ npm run start
\n
Download
\n
Open Log Viewer is available for Linux, Mac and Windows
# Clone this repository\n$ git clone https://github.com/tmoreno/open-log-viewer\n\n# Go into the repository\n$ cd open-log-viewer\n\n# Install dependencies\n$ npm install\n\n# Build app\n$ npm run build\n\n# Run the app\n$ npm run start
\n
Download
\n
Open Log Viewer is available for Linux, Mac and Windows
Based on the universe of Hereva created by David Revoy with contributions by Craig Maloney.\nCorrections by Willem Sonke, Moini, Hali, CGand and Alex Gryson.\nTranslated into Spanish by TheFaico
Based on the universe of Hereva created by David Revoy with contributions by Craig Maloney.\nCorrections by Willem Sonke, Moini, Hali, CGand and Alex Gryson.\nTranslated into Spanish by TheFaico
Overlay is a set of tools for developers and designers to measure, align and overlay on-screen graphics and layouts. Similar to xScope but with a simple interface, limited functionality and open source.
From the toolbox you can manage, add tools, display the help page, and show or hide all the items in the screen.
\n
Tools
\n
Guides
\n
Horizontal and vertical guides are useful when you need to align several items in the same axis.
\n
\n
Rulers
\n
Rulers are great to measure objects, they are semi-transparent, in different colors, and can be cloned.
\n
\n
Onion images
\n
The onion image serve as a visual guide to match a layout. Opacity and inverted colors can be applied.
\n
\n
\n
The Grid
\n
The grid is similar to the ruler but covers the whole screen and has no background color. It is a 10x10 pixels fixed grid but that value can be defined in the settings.
\n
\n
Columns
\n
In progress. Not ready yet.
\n
",
+ "readmeOriginal": "
\n
Overlay
\n
\n
Overlay is a set of tools for developers and designers to measure, align and overlay on-screen graphics and layouts. Similar to xScope but with a simple interface, limited functionality and open source.
From the toolbox you can manage, add tools, display the help page, and show or hide all the items in the screen.
\n
Tools
\n
Guides
\n
Horizontal and vertical guides are useful when you need to align several items in the same axis.
\n
\n
Rulers
\n
Rulers are great to measure objects, they are semi-transparent, in different colors, and can be cloned.
\n
\n
Onion images
\n
The onion image serve as a visual guide to match a layout. Opacity and inverted colors can be applied.
\n
\n
\n
The Grid
\n
The grid is similar to the ruler but covers the whole screen and has no background color. It is a 10x10 pixels fixed grid but that value can be defined in the settings.
It aims to be a mix between a text-editor and code-editor. It reads and writes .note files from your native file system. This means it works well with tools like Dropbox for syncing files across your devices.
\n
Much like a code-editor, Opus opens folders and allows you to edit the files inside. You can have multiple windows open, each with a different folder.
\n
Features
\n
\n
🖋 Editing: Supports rich text editing with all the features you'd expect.
\n
📄 Uses Files: Uses tangible files in JSON format, not inaccessible databases.
\n
🌙 Dark Mode: Includes a dark mode for late night writing.
\n
⚙️ Customizable: The sidebar and footer can be hidden for a more focused experience.
\n
📂 Multiple Projects: Opus supports opening multiple folders at once.
\n
✨ Simple: Opus has only the features you need.
\n
\n
Installation
\n
You can download the latest macOS binary from releases.
\n
Alternatively, you can run Opus locally from the command line:
\n
$ git clone https://github.com/pacocoursey/Opus.git\n$ cd opus\n$ npm install\n$ npm start
\n
Screenshots
\n
\n
\n
More Features
\n
\n
Find, replace, goto functionalities.
\n
Spellchecker, easily replace with suggestions via right-click.
\n
Window settings (position, size, dark mode, etc...) are remembered between sessions.
\n
Export notes to plain text, html, and markdown files.
\n
Automatically ask to update note contents if it is edited elsewhere.
\n
Document statistics shown in the footer (line count, word count, cursor position).
\n
\n
Related
\n
\n
Left: distractionless plain text writing application.
\n
Quill: The rich text editor that runs inside Opus.
\n
\n
",
+ "readmeOriginal": "
\n \n
\n
Opus
\n
Opus is a minimal note-taking application.
\n
It aims to be a mix between a text-editor and code-editor. It reads and writes .note files from your native file system. This means it works well with tools like Dropbox for syncing files across your devices.
\n
Much like a code-editor, Opus opens folders and allows you to edit the files inside. You can have multiple windows open, each with a different folder.
\n
Features
\n
\n
🖋 Editing: Supports rich text editing with all the features you'd expect.
\n
📄 Uses Files: Uses tangible files in JSON format, not inaccessible databases.
\n
🌙 Dark Mode: Includes a dark mode for late night writing.
\n
⚙️ Customizable: The sidebar and footer can be hidden for a more focused experience.
\n
📂 Multiple Projects: Opus supports opening multiple folders at once.
\n
✨ Simple: Opus has only the features you need.
\n
\n
Installation
\n
You can download the latest macOS binary from releases.
\n
Alternatively, you can run Opus locally from the command line:
\n
$ git clone https://github.com/pacocoursey/Opus.git\n$ cd opus\n$ npm install\n$ npm start
\n
Screenshots
\n
\n
\n
More Features
\n
\n
Find, replace, goto functionalities.
\n
Spellchecker, easily replace with suggestions via right-click.
\n
Window settings (position, size, dark mode, etc...) are remembered between sessions.
\n
Export notes to plain text, html, and markdown files.
\n
Automatically ask to update note contents if it is edited elsewhere.
\n
Document statistics shown in the footer (line count, word count, cursor position).
\n
\n
Related
\n
\n
Left: distractionless plain text writing application.
\n
Quill: The rich text editor that runs inside Opus.
To setup Orb for your organization, take a look at the onboarding guide.
\n
Features
\n
Object and Context Driven
\n
Orb allows you to rapidly browse through information based on an object hierarchy.
\n
When any resource on the object tree is clicked, all context associated with that object is passed to the resource link.\nSince all variables for an object are automatically injected for you, this allows you to rapidly explore shared queries, dashboards, links, scripts and more.
\n
\n
Backed by Azure Data Explorer
\n
Object heirarchies are user defined and backed by ADX queries. ADX integration allows rapidly searching for objects and discovering hierarchies dynamically.
\n
\n
Extensible and Shareable
\n
All object definitions and hierarchies are defined as JSON config. You can edit object definitions, add resources and share your changes from within Orb.
\n
These config files are stored on a Git repository - this provides a shared view of Live Site resources across the entire organization.
\n
\n
PowerShell Support
\n
Orb allows you to save and share PowerShell snippets. The results of these PowerShell snippets are displayed as web pages rendered using Markdown. These snippets could be common mitigation actions, data collection triggers and more.
\n
Since Orb allows multiple tabs, you can open up saved snippets and run them in parallel. Since the script result is a web page, you can Ctrl + F to search through the output.
\n
You can also use PowerShell scripts to define your Object Hierarchy if you don't have an ADX cluster.
\n
\n
Terminal Integration
\n
In addition to PowerShell Markdown support, you can open a fully functional PowerShell terminal in Orb.\nYou can define custom terminal profiles to launch terminals with custom startup scripts. These startup scripts can also be shared through the git repository, allowing teams to use consistent startup scripts.
\n
\n
Orb Files and Links
\n
You can save Orb state to a file, edit it, pin it to your JumpList to accelerate repeated workflows.
To setup Orb for your organization, take a look at the onboarding guide.
\n
Features
\n
Object and Context Driven
\n
Orb allows you to rapidly browse through information based on an object hierarchy.
\n
When any resource on the object tree is clicked, all context associated with that object is passed to the resource link.\nSince all variables for an object are automatically injected for you, this allows you to rapidly explore shared queries, dashboards, links, scripts and more.
\n
\n
Backed by Azure Data Explorer
\n
Object heirarchies are user defined and backed by ADX queries. ADX integration allows rapidly searching for objects and discovering hierarchies dynamically.
\n
\n
Extensible and Shareable
\n
All object definitions and hierarchies are defined as JSON config. You can edit object definitions, add resources and share your changes from within Orb.
\n
These config files are stored on a Git repository - this provides a shared view of Live Site resources across the entire organization.
\n
\n
PowerShell Support
\n
Orb allows you to save and share PowerShell snippets. The results of these PowerShell snippets are displayed as web pages rendered using Markdown. These snippets could be common mitigation actions, data collection triggers and more.
\n
Since Orb allows multiple tabs, you can open up saved snippets and run them in parallel. Since the script result is a web page, you can Ctrl + F to search through the output.
\n
You can also use PowerShell scripts to define your Object Hierarchy if you don't have an ADX cluster.
\n
\n
Terminal Integration
\n
In addition to PowerShell Markdown support, you can open a fully functional PowerShell terminal in Orb.\nYou can define custom terminal profiles to launch terminals with custom startup scripts. These startup scripts can also be shared through the git repository, allowing teams to use consistent startup scripts.
\n
\n
Orb Files and Links
\n
You can save Orb state to a file, edit it, pin it to your JumpList to accelerate repeated workflows.
Oversetter is an translation app, which allows you to translate content directly from your menu bar. Oversetter is an open-source project based on Angular and Electron. It uses free API of Yandex Translate for text translation.
\n
Features
\n
\n
93 languages - Thanks to Yandex Translate API
\n
Built-in dictionary - Save words and phrases for later
\n
Themes support - Includes dark and light theme
\n
Cross-platform support - Available for MacOs, Linux and Windows
\n
Fast and easy access - Open Oversetter directly from the system tray
\n
Offline mode - Save and learn vocabulary also in offline mode
\n
\n
Screenshots
\n
\n \n Light theme\n
\n
\n \n Dark theme\n
\n
\n \n Dictionary\n
\n
Download
\n
You can download the latest version of the application for macOS, Windows and Linux.
Oversetter is an translation app, which allows you to translate content directly from your menu bar. Oversetter is an open-source project based on Angular and Electron. It uses free API of Yandex Translate for text translation.
\n
Features
\n
\n
93 languages - Thanks to Yandex Translate API
\n
Built-in dictionary - Save words and phrases for later
\n
Themes support - Includes dark and light theme
\n
Cross-platform support - Available for MacOs, Linux and Windows
\n
Fast and easy access - Open Oversetter directly from the system tray
\n
Offline mode - Save and learn vocabulary also in offline mode
\n
\n
Screenshots
\n
\n \n Light theme\n
\n
\n \n Dark theme\n
\n
\n \n Dictionary\n
\n
Download
\n
You can download the latest version of the application for macOS, Windows and Linux.
You also have to install pandoc to export to most formats.
\n
\n
PanWriter is very usable, but also very much a work in progress, as there are still a few rough edges (see TODOs below). Feedback, suggestions and contributions very much welcome! Please open an issue to start a conversation.
\n
Usage
\n
Export preview to PDF
\n
Select File -> 'Print / PDF' and PDF -> 'Save as PDF' in the print dialog (exact naming might depend on your OS).
\n
This will export exactly what’s shown in the preview, and not use pandoc at all.
\n
You can change the styling of the preview and immediately see the changes.
If you have a YAML metadata block, like in the following example, PanWriter will look at the extension of the filename you chose in the dialog, and look up the corresponding key in the output YAML metadata, for example when exporting the following markdown to test.html:
\n
---\ntitle: my document\nfontsize: 18px\npdf-format: latex # optional\noutput:\n html:\n katex: true # for math output\n include-in-header:\n - foo.css\n - bar.js\n latex:\n pdf-engine: xelatex\n toc: true\n toc-depth: 3\n template: letter.tex\n metadata:\n fontsize: 12pt\n epub:\n to: epub2 # default would be epub3\n---\n\n# my document\n
There are two exceptions to the rule that the key in the output YAML is the file extension:
\n\n
When exporting to a .tex file, the key should be named latex.
\n
When exporting to a .pdf file, the key for PanWriter to look up in the output YAML can be specified with the pdf-format key (see example above). Default is also latex, but you can also use context, html, ms, beamer, revealjs, etc. In fact, you could set it to anything, if you had a corresponding key in the output YAML with a to: field. See also Creating a PDF with pandoc.
\n\n
User Data Directory
\n
You can place certain files in the PanWriter user directory, which should be:
If the directory does not exist, you can create it.
\n
Default CSS and YAML
\n
If you put a default.yaml file in the data directory, PanWriter will merge this with the YAML in your input file (to determine the command-line arguments to call pandoc with) and add the --metadata-file option. The YAML should be in the same format as above.
\n
To include CSS in your default.yaml, you can also use the same format as in-document metadata, for example:
You can e.g. put type: letter in the YAML of your input document. In that case, PanWriter will look for letter.yaml instead of default.yaml in the user data directory.
\n
Markdown syntax
\n
We use markdown-it for the preview pane, which is fully CommonMark-compliant. It supports GFM tables (basically pandoc pipe_tables) and GFM Strikethrough (strikeout) out of the box. We also added a bunch of plugins, to make the preview behave as much as pandoc as possible (including attributes, fenced_divs, definition_lists, footnotes, grid_tables, implicit_figures, subscript, superscript, yaml_metadata_block and tex_math_dollars). We explicitly don't support raw_html or raw_tex, since everything should be doable with the fenced_divs, bracketed_spans and raw_attribute extensions.
\n
However, there might still be minor differences between the preview and File -> 'Print / PDF' on one hand, and File -> Export on the other.
raw_attribute: we should probably just strip them from preview
\n
backslash at end of paragraph, e.g. ![](foo.png) \\ An ugly workaround that already works is ![](foo.png)
\n
\n
Pandoc markdown supports a few more things which will not render correctly in the preview, but which are not so commonly used. However, you can still use them in your markdown file, and export via pandoc will work.
\n
Launching from the command-line
\n
You can set up your system to launch PanWriter with:
\n
panwriter myfile.md\n
\n
On macOS, you should put the following in your ~/.bash_profile or similar:
\n
function panwriter(){ open -a PanWriter \"$@\"; }\n
\n
On Linux and Windows, you can make an alias to the correct location of the panwriter executable.
\n
About CSS for print
\n
Unfortunately, still no browser fully implements the CSS specs for paged media (paged media are e.g. print or PDF). Therefore, PanWriter's preview is powered by pagedjs – a collection of paged media polyfills by pagedmedia.org. Some background on using CSS for print:
git clone git@github.com:mb21/panwriter.git\ncd panwriter\nyarn install\n\n## To run the app in development mode:\nyarn run electron:dev\n\n## To build distributable app package (goes to ./dist):\nyarn dist\n
\n
Check out the package.json for more scripts to run.
\n
TODOs
\n
\n
Preview:\n
\n
respect css, toc metadata fields
\n
\n
\n
Editor:\n
\n
expand Format menu
\n
spell check
\n
improve find/replace
\n
\n
\n
add a Settings/Preferences window (or should this just be a settings.yaml file?) where you can:\n
\n
set a CodeMirror editor theme css
\n
edit the default CSS and YAML files
\n
choose pandoc executable (probably with file-open dialog, which we can use for app sandboxing with security-scoped bookmarks)
\n
\n
\n
Write pandoc lua filter that does some PanWriter-specific transformations:\n
You also have to install pandoc to export to most formats.
\n
\n
PanWriter is very usable, but also very much a work in progress, as there are still a few rough edges (see TODOs below). Feedback, suggestions and contributions very much welcome! Please open an issue to start a conversation.
\n
Usage
\n
Export preview to PDF
\n
Select File -> 'Print / PDF' and PDF -> 'Save as PDF' in the print dialog (exact naming might depend on your OS).
\n
This will export exactly what’s shown in the preview, and not use pandoc at all.
\n
You can change the styling of the preview and immediately see the changes.
If you have a YAML metadata block, like in the following example, PanWriter will look at the extension of the filename you chose in the dialog, and look up the corresponding key in the output YAML metadata, for example when exporting the following markdown to test.html:
\n
---\ntitle: my document\nfontsize: 18px\npdf-format: latex # optional\noutput:\n html:\n katex: true # for math output\n include-in-header:\n - foo.css\n - bar.js\n latex:\n pdf-engine: xelatex\n toc: true\n toc-depth: 3\n template: letter.tex\n metadata:\n fontsize: 12pt\n epub:\n to: epub2 # default would be epub3\n---\n\n# my document\n
There are two exceptions to the rule that the key in the output YAML is the file extension:
\n\n
When exporting to a .tex file, the key should be named latex.
\n
When exporting to a .pdf file, the key for PanWriter to look up in the output YAML can be specified with the pdf-format key (see example above). Default is also latex, but you can also use context, html, ms, beamer, revealjs, etc. In fact, you could set it to anything, if you had a corresponding key in the output YAML with a to: field. See also Creating a PDF with pandoc.
\n\n
User Data Directory
\n
You can place certain files in the PanWriter user directory, which should be:
If the directory does not exist, you can create it.
\n
Default CSS and YAML
\n
If you put a default.yaml file in the data directory, PanWriter will merge this with the YAML in your input file (to determine the command-line arguments to call pandoc with) and add the --metadata-file option. The YAML should be in the same format as above.
\n
To include CSS in your default.yaml, you can also use the same format as in-document metadata, for example:
You can e.g. put type: letter in the YAML of your input document. In that case, PanWriter will look for letter.yaml instead of default.yaml in the user data directory.
\n
Markdown syntax
\n
We use markdown-it for the preview pane, which is fully CommonMark-compliant. It supports GFM tables (basically pandoc pipe_tables) and GFM Strikethrough (strikeout) out of the box. We also added a bunch of plugins, to make the preview behave as much as pandoc as possible (including attributes, fenced_divs, definition_lists, footnotes, grid_tables, implicit_figures, subscript, superscript, yaml_metadata_block and tex_math_dollars). We explicitly don't support raw_html or raw_tex, since everything should be doable with the fenced_divs, bracketed_spans and raw_attribute extensions.
\n
However, there might still be minor differences between the preview and File -> 'Print / PDF' on one hand, and File -> Export on the other.
raw_attribute: we should probably just strip them from preview
\n
backslash at end of paragraph, e.g. ![](foo.png) \\ An ugly workaround that already works is ![](foo.png)
\n
\n
Pandoc markdown supports a few more things which will not render correctly in the preview, but which are not so commonly used. However, you can still use them in your markdown file, and export via pandoc will work.
\n
Launching from the command-line
\n
You can set up your system to launch PanWriter with:
\n
panwriter myfile.md\n
\n
On macOS, you should put the following in your ~/.bash_profile or similar:
\n
function panwriter(){ open -a PanWriter \"$@\"; }\n
\n
On Linux and Windows, you can make an alias to the correct location of the panwriter executable.
\n
About CSS for print
\n
Unfortunately, still no browser fully implements the CSS specs for paged media (paged media are e.g. print or PDF). Therefore, PanWriter's preview is powered by pagedjs – a collection of paged media polyfills by pagedmedia.org. Some background on using CSS for print:
git clone git@github.com:mb21/panwriter.git\ncd panwriter\nyarn install\n\n## To run the app in development mode:\nyarn run electron:dev\n\n## To build distributable app package (goes to ./dist):\nyarn dist\n
\n
Check out the package.json for more scripts to run.
\n
TODOs
\n
\n
Preview:\n
\n
respect css, toc metadata fields
\n
\n
\n
Editor:\n
\n
expand Format menu
\n
spell check
\n
improve find/replace
\n
\n
\n
add a Settings/Preferences window (or should this just be a settings.yaml file?) where you can:\n
\n
set a CodeMirror editor theme css
\n
edit the default CSS and YAML files
\n
choose pandoc executable (probably with file-open dialog, which we can use for app sandboxing with security-scoped bookmarks)
\n
\n
\n
Write pandoc lua filter that does some PanWriter-specific transformations:\n
P3X OneNote Linux is, actually, an independent browser window for the online OneNote. You can use this program without having to clutter your browser. The main functions are:
\n
\n
that is independent from any browser, as it works in it's own process
\n
it provides a tray, that allows you to close your browser while it keeps running in the tray
\n
the data is cached and is faster than always opening a new window
\n
it allows you to sign in with the corporate or the personal login
\n
when there is a new update, it auto updates itself (Only in the AppImage version.)
\n
the program allows to use other Microsoft online applications, but the dedicated purpose is to use OneNote
\n
\n
Verbose feature info
\n
\n
Dark mode is enabled (but it is a hack, not supported by Microsoft, so quirky)
\n
To show the menu, click ALT
\n
Desktop menu
\n
Icon
\n
There is a bottom bar\n
\n
It shows the current location
\n
When you click on this bar, the location URL is copied into the clipboard
\n
\n
\n
There is a new button on the Edit menu\n
\n
Copy this location to the clipboard\n
\n
This is the same function that is on the bottom bar when you click on it
\n
\n
\n
\n
\n
Restart button (empty your cache, you can login again if there is an error)
\n
Remember last notebook (as much Online Onenote allows ...)
\n
Menu > Settings\n
\n
Close to the tray\n
\n
If checked, will minimize to the tray instead of quit
\n
If un-checked, default quit close button behaviour (quit the app)
\n
\n
\n
\n
\n
You are able to set a proxy in the settings menu.
\n
There is now a menu called Corporate home\n
\n
Given, I do not have a Corporate login, I cannot debug it at all.\n
\n
If something is not working, the only way is to provide your login and I could probably fix it. Otherwise, I see nothing.
\n
\n
\n
\n
\n
The OneNote language is controlled by Microsoft, and we try to work with Online OneNote, but we are getting a hard time, but the Electron UI is now able to use any language.\n
Allows using multiple instances (with some quirks, as the config will not be synchronized using multiple instances at once, so it can provide wrong results - to make it to work, configure with 1 instance, exit, then use multiple instances).\n
\n
Multiple instances is not recommended (it was requested and provided).
After downloading the AppImage, make it an executable.
\n
mkdir -p $HOME/opt\nmv ~/Downloads/p3x-onenote-a.b.c-x86_64.AppImage $HOME/opt/\nchmod +x $HOME/opt/p3x-onenote-a.b.c-x86_64.AppImage\n# Then you can run it\n$HOME/opt/p3x-onenote-a.b.c-x86_64.AppImage &
The corporate login is unstable, either it works or not. Only the personal account that I can provide some minimal support.
\n
Suspend/Sleep/Wake up
\n
I recognized, that after suspend/sleep and then wake up, the app is not saving the pages anymore. For now, the solution is, that after wake up, restart the app.
\n
Not working on SNAP on some versions
\n
Usually, on stable distros are working with SNAP, but usually non stable Linux distros could not work. Please, try using the AppImage, that is usually better than SNAP.
For file names do not use camelCase, but use kebab-case. Folder should be named as kebab-case as well. As you can see, all code filenames are using it like that, please do not change that.\nPlease apply the .editorconfig settings in your IDE.
\n
If you try to build the app with AppImage, you have to change from electrondependencies to devDependencies, this is because it is created to be able to run this app from NPM instead of an AppImage.
🙏 This is an open-source project. Star this repository, if you like it, or even donate to maintain the servers and the development. Thank you so much!
\n
Possible, this server, rarely, is down, please, hang on for 15-30 minutes and the server will be back up.
\n
All my domains (patrikx3.com and corifeus.com) could have minor errors, since I am developing in my free time. However, it is usually stable.
\n
Note about versioning: Versions are cut in Major.Minor.Patch schema. Major is always the current year. Minor is either 4 (January - June) or 10 (July - December). Patch is incremental by every build. If there is a breaking change, it should be noted in the readme.
P3X OneNote Linux is, actually, an independent browser window for the online OneNote. You can use this program without having to clutter your browser. The main functions are:
\n
\n
that is independent from any browser, as it works in it's own process
\n
it provides a tray, that allows you to close your browser while it keeps running in the tray
\n
the data is cached and is faster than always opening a new window
\n
it allows you to sign in with the corporate or the personal login
\n
when there is a new update, it auto updates itself (Only in the AppImage version.)
\n
the program allows to use other Microsoft online applications, but the dedicated purpose is to use OneNote
\n
\n
Verbose feature info
\n
\n
Dark mode is enabled (but it is a hack, not supported by Microsoft, so quirky)
\n
To show the menu, click ALT
\n
Desktop menu
\n
Icon
\n
There is a bottom bar\n
\n
It shows the current location
\n
When you click on this bar, the location URL is copied into the clipboard
\n
\n
\n
There is a new button on the Edit menu\n
\n
Copy this location to the clipboard\n
\n
This is the same function that is on the bottom bar when you click on it
\n
\n
\n
\n
\n
Restart button (empty your cache, you can login again if there is an error)
\n
Remember last notebook (as much Online Onenote allows ...)
\n
Menu > Settings\n
\n
Close to the tray\n
\n
If checked, will minimize to the tray instead of quit
\n
If un-checked, default quit close button behaviour (quit the app)
\n
\n
\n
\n
\n
You are able to set a proxy in the settings menu.
\n
There is now a menu called Corporate home\n
\n
Given, I do not have a Corporate login, I cannot debug it at all.\n
\n
If something is not working, the only way is to provide your login and I could probably fix it. Otherwise, I see nothing.
\n
\n
\n
\n
\n
The OneNote language is controlled by Microsoft, and we try to work with Online OneNote, but we are getting a hard time, but the Electron UI is now able to use any language.\n
Allows using multiple instances (with some quirks, as the config will not be synchronized using multiple instances at once, so it can provide wrong results - to make it to work, configure with 1 instance, exit, then use multiple instances).\n
\n
Multiple instances is not recommended (it was requested and provided).
After downloading the AppImage, make it an executable.
\n
mkdir -p $HOME/opt\nmv ~/Downloads/p3x-onenote-a.b.c-x86_64.AppImage $HOME/opt/\nchmod +x $HOME/opt/p3x-onenote-a.b.c-x86_64.AppImage\n# Then you can run it\n$HOME/opt/p3x-onenote-a.b.c-x86_64.AppImage &
The corporate login is unstable, either it works or not. Only the personal account that I can provide some minimal support.
\n
Suspend/Sleep/Wake up
\n
I recognized, that after suspend/sleep and then wake up, the app is not saving the pages anymore. For now, the solution is, that after wake up, restart the app.
\n
Not working on SNAP on some versions
\n
Usually, on stable distros are working with SNAP, but usually non stable Linux distros could not work. Please, try using the AppImage, that is usually better than SNAP.
For file names do not use camelCase, but use kebab-case. Folder should be named as kebab-case as well. As you can see, all code filenames are using it like that, please do not change that.\nPlease apply the .editorconfig settings in your IDE.
\n
If you try to build the app with AppImage, you have to change from electrondependencies to devDependencies, this is because it is created to be able to run this app from NPM instead of an AppImage.
🙏 This is an open-source project. Star this repository, if you like it, or even donate to maintain the servers and the development. Thank you so much!
\n
Possible, this server, rarely, is down, please, hang on for 15-30 minutes and the server will be back up.
\n
All my domains (patrikx3.com and corifeus.com) could have minor errors, since I am developing in my free time. However, it is usually stable.
\n
Note about versioning: Versions are cut in Major.Minor.Patch schema. Major is always the current year. Minor is either 4 (January - June) or 10 (July - December). Patch is incremental by every build. If there is a breaking change, it should be noted in the readme.
📡 P3X Redis UI is a very functional handy database GUI and works in your pocket on the responsive web or as a desktop app v2021.10.106
\n
Bugs are evident™ - MATRIX️
\n
NodeJs LTS Version Requirement
\n
=12.13.0\n\">
>=12.13.0\n
\n
Built on NodeJs
\n
v14.17.2\n
\n
Only the latest LTS variant is supported.
\n
Description
\n
p3x-redis-ui is a new Redis GUI which can serve as a backend server or as a desktop application.
\n
Some of the features are coming below.
\n
The best use case for this Redis GUI, if you manage tons of JSON, as it includes JSONEditor and ACE. Check out the different options in the edit json button dialog. :)
\n\n \n
Warning
\n
If you are reading the readme fom Docker, the links are not working, please read the readme from GitHub or Corifeus @
It is not recommend to generate the configuration JSON via a text editor. The perfect solution is to generate the configuration in the GUI, then apply for example in Kubernetes.
This Redis database every day in the morning European time CET restores some data, so you may do whatever you want to do.
\n
Besides, you could experience the test app to exit for 1 second, because it could auto update itself. It auto updates itself when the code from Git changes.
\n
Third, it is a snapshot, it is possible, that the features are different from GitHub or NPM as the releases are usually monthly or as they happen.
After downloading the AppImage, make it an executable.
\n
mkdir -p $HOME/opt\nmv ~/Downloads/p3x-redis-ui-a.b.c-x86_64.AppImage $HOME/opt/\nchmod +x $HOME/opt/p3x-redis-ui-a.b.c-x86_64.AppImage\n# Then you can run it\n$HOME/opt/p3x-redis-ui-a.b.c-x86_64.AppImage &
wget https://raw.githubusercontent.com/patrikx3/redis-ui/master/docker-compose.yml\n# You might want to tune the settings folder in the docker-compose.yml.\n# the /home/user/p3x-redis-ui-settings settings folder in yml should be set by yourself.\ndocker-compose up
\n
Bare
\n
# you can tune the settings folder\n# in the -v first part is where you can set your own folder\nmkdir -p ./p3x-redis-ui-settings\ndocker run -v $PWD/p3x-redis-ui-settings:/settings -h docker-p3x-redis-ui -p 7843:7843 -t -i patrikx3/p3x-redis-ui
You can override the server port via an environment variable P3XRS_PORT
\n
In the connections, you can enable read only mode, which means, the user will not be able to modify via gui and the console (only pub/sub monitor and select database is allowed) is disabled.
\n
In a sub-directory, you can use Nginx/Ingress to rewrite your paths.\n
To show the menu in the desktop version, click ALT
\n
There is a new feature in the settings/tree setting, which limits the received keys, the minimum is 100, the maximum is 100k, so there is no more crash, because of that
\n
Since v2020.4.189, the tree can handle bigger key count, as of now, we are using deferred rendering for the tree - only rendering what is in the viewport, so it should be much faster versus rendering everything at once
\n
Please, check out your Redis use case, if this program can cover your requirements
\n
Does not handle binary data
\n
Does not work with sentinel, but it will be developed at some point of time
\n
Has cluster support\n
\n
Thanks so much for the awesome contribution by @idetoile (now -> @devthejo) of the cluster function.
\n
\n
\n
Able to monitor all channel messages on the console by using a checkbox.
\n
Works with multiple languages
\n
Works as a backend
\n
Works as a desktop via Electron\n
\n
Linux
\n
Windows
\n
macOS
\n
\n
\n
Starts with no settings without config, or setup your own config
\n
Able to create, test, save, delete multiple connections or a readonly connections setup, for shared usage
\n
Able to use the console and interact with Redis\n
\n
TAB or SHIFT + TAB completion like bash is enabled
\n
Cursor UP or DOWN history is enabled
\n
\n
\n
Online you are able to choose the tree separator, for example :, /, -, space etc... or even empty separator
\n
It is based on Redis-Commander and phpRedisAdmin
\n
You can select the database via console or the drop down.\n
\n
The database select drop down shows if the checked database is empty or filled, so you can always know which is filled
\n
\n
\n
Save button to save the db
\n
Full statistics pages, can be useful
\n
This is just a New Kind on the Block in the Redis world, so, of course, there are advantages and disadvantages in the other Redis GUIs
\n
Dark - Dracula / light themes
\n
Search\n
\n
Client side mode searching in keys - small key set
\n
Server side mode searching in keys - large key set
\n
Search mode\n
\n
the search keys starts with a string key
\n
the search keys includes a string in the key
\n
\n
\n
\n
\n
The app is responsive, it works on a phone/tablet as well
\n
There is a key sorting function, which has a penalty, because it sorts with natural-compare, which means it is more human display, then just raw characters, but up to 100k the keys is still ok.
\n
For big key set to be usable paging should be a maximum 1000 keys / page, though for 250 is the sweetest spot
For file names do not use camelCase, but use kebab-case. Folder should be named as kebab-case as well. As you can see, all code filenames are using it like that, please do not change that.\nPlease apply the .editorconfig settings in your IDE.
\n
It creates a package that allows you to compose p3x-redis-ui-server and p3x-redis-ui-material into one:
If you develop on this app, you are required to test, that all JS you code write is working with Electron (as the embedded Electron NodeJs version is usually below the real NodeJs). Once the server and client is running as above, you clone this repo and test like this:
\n
# terminal 1\ngit clone https://github.com/patrikx3/redis-ui-material.git\ncd redis-ui-material\nnpm install\nnpm run dev\n\n# terminal 2\ngit clone https://github.com/patrikx3/redis-ui-server.git\ncd redis-ui-server\nnpm install\nnpm run dev\n\n# if you are not working on Electron, at this point you can fire the browser\n# @ http://localhost:8080/\n\n# terminal 3 \ngit clone https://github.com/patrikx3/redis-ui.git\ncd redis-ui\nnpm install\n./scripts/start-local.sh\n# or\n.\\scripts\\start-local.cmd
\n
Development of the translations
\n
By default, only English is created, but given all strings are from a JS file, it is very quick to spawn another language eg. German, French, Spanish etc ...
For a new language:\nAdd into redis-ui-material/src/bundle.js.
\n
This solution is not using REST at all, but instead uses Socket.IO 🤣, which is weird, but I like it, it is supposed to be more responsive, as there is no big overhead in the HTTP protocol.
🙏 This is an open-source project. Star this repository, if you like it, or even donate to maintain the servers and the development. Thank you so much!
\n
Possible, this server, rarely, is down, please, hang on for 15-30 minutes and the server will be back up.
\n
All my domains (patrikx3.com and corifeus.com) could have minor errors, since I am developing in my free time. However, it is usually stable.
\n
Note about versioning: Versions are cut in Major.Minor.Patch schema. Major is always the current year. Minor is either 4 (January - June) or 10 (July - December). Patch is incremental by every build. If there is a breaking change, it should be noted in the readme.
📡 P3X Redis UI is a very functional handy database GUI and works in your pocket on the responsive web or as a desktop app v2021.10.106
\n
Bugs are evident™ - MATRIX️
\n
NodeJs LTS Version Requirement
\n
>=12.13.0\n
\n
Built on NodeJs
\n
v14.17.2\n
\n
Only the latest LTS variant is supported.
\n
Description
\n
p3x-redis-ui is a new Redis GUI which can serve as a backend server or as a desktop application.
\n
Some of the features are coming below.
\n
The best use case for this Redis GUI, if you manage tons of JSON, as it includes JSONEditor and ACE. Check out the different options in the edit json button dialog. :)
\n\n \n
Warning
\n
If you are reading the readme fom Docker, the links are not working, please read the readme from GitHub or Corifeus @
It is not recommend to generate the configuration JSON via a text editor. The perfect solution is to generate the configuration in the GUI, then apply for example in Kubernetes.
This Redis database every day in the morning European time CET restores some data, so you may do whatever you want to do.
\n
Besides, you could experience the test app to exit for 1 second, because it could auto update itself. It auto updates itself when the code from Git changes.
\n
Third, it is a snapshot, it is possible, that the features are different from GitHub or NPM as the releases are usually monthly or as they happen.
After downloading the AppImage, make it an executable.
\n
mkdir -p $HOME/opt\nmv ~/Downloads/p3x-redis-ui-a.b.c-x86_64.AppImage $HOME/opt/\nchmod +x $HOME/opt/p3x-redis-ui-a.b.c-x86_64.AppImage\n# Then you can run it\n$HOME/opt/p3x-redis-ui-a.b.c-x86_64.AppImage &
wget https://raw.githubusercontent.com/patrikx3/redis-ui/master/docker-compose.yml\n# You might want to tune the settings folder in the docker-compose.yml.\n# the /home/user/p3x-redis-ui-settings settings folder in yml should be set by yourself.\ndocker-compose up
\n
Bare
\n
# you can tune the settings folder\n# in the -v first part is where you can set your own folder\nmkdir -p ./p3x-redis-ui-settings\ndocker run -v $PWD/p3x-redis-ui-settings:/settings -h docker-p3x-redis-ui -p 7843:7843 -t -i patrikx3/p3x-redis-ui
You can override the server port via an environment variable P3XRS_PORT
\n
In the connections, you can enable read only mode, which means, the user will not be able to modify via gui and the console (only pub/sub monitor and select database is allowed) is disabled.
\n
In a sub-directory, you can use Nginx/Ingress to rewrite your paths.\n
To show the menu in the desktop version, click ALT
\n
There is a new feature in the settings/tree setting, which limits the received keys, the minimum is 100, the maximum is 100k, so there is no more crash, because of that
\n
Since v2020.4.189, the tree can handle bigger key count, as of now, we are using deferred rendering for the tree - only rendering what is in the viewport, so it should be much faster versus rendering everything at once
\n
Please, check out your Redis use case, if this program can cover your requirements
\n
Does not handle binary data
\n
Does not work with sentinel, but it will be developed at some point of time
\n
Has cluster support\n
\n
Thanks so much for the awesome contribution by @idetoile (now -> @devthejo) of the cluster function.
\n
\n
\n
Able to monitor all channel messages on the console by using a checkbox.
\n
Works with multiple languages
\n
Works as a backend
\n
Works as a desktop via Electron\n
\n
Linux
\n
Windows
\n
macOS
\n
\n
\n
Starts with no settings without config, or setup your own config
\n
Able to create, test, save, delete multiple connections or a readonly connections setup, for shared usage
\n
Able to use the console and interact with Redis\n
\n
TAB or SHIFT + TAB completion like bash is enabled
\n
Cursor UP or DOWN history is enabled
\n
\n
\n
Online you are able to choose the tree separator, for example :, /, -, space etc... or even empty separator
\n
It is based on Redis-Commander and phpRedisAdmin
\n
You can select the database via console or the drop down.\n
\n
The database select drop down shows if the checked database is empty or filled, so you can always know which is filled
\n
\n
\n
Save button to save the db
\n
Full statistics pages, can be useful
\n
This is just a New Kind on the Block in the Redis world, so, of course, there are advantages and disadvantages in the other Redis GUIs
\n
Dark - Dracula / light themes
\n
Search\n
\n
Client side mode searching in keys - small key set
\n
Server side mode searching in keys - large key set
\n
Search mode\n
\n
the search keys starts with a string key
\n
the search keys includes a string in the key
\n
\n
\n
\n
\n
The app is responsive, it works on a phone/tablet as well
\n
There is a key sorting function, which has a penalty, because it sorts with natural-compare, which means it is more human display, then just raw characters, but up to 100k the keys is still ok.
\n
For big key set to be usable paging should be a maximum 1000 keys / page, though for 250 is the sweetest spot
For file names do not use camelCase, but use kebab-case. Folder should be named as kebab-case as well. As you can see, all code filenames are using it like that, please do not change that.\nPlease apply the .editorconfig settings in your IDE.
\n
It creates a package that allows you to compose p3x-redis-ui-server and p3x-redis-ui-material into one:
If you develop on this app, you are required to test, that all JS you code write is working with Electron (as the embedded Electron NodeJs version is usually below the real NodeJs). Once the server and client is running as above, you clone this repo and test like this:
\n
# terminal 1\ngit clone https://github.com/patrikx3/redis-ui-material.git\ncd redis-ui-material\nnpm install\nnpm run dev\n\n# terminal 2\ngit clone https://github.com/patrikx3/redis-ui-server.git\ncd redis-ui-server\nnpm install\nnpm run dev\n\n# if you are not working on Electron, at this point you can fire the browser\n# @ http://localhost:8080/\n\n# terminal 3 \ngit clone https://github.com/patrikx3/redis-ui.git\ncd redis-ui\nnpm install\n./scripts/start-local.sh\n# or\n.\\scripts\\start-local.cmd
\n
Development of the translations
\n
By default, only English is created, but given all strings are from a JS file, it is very quick to spawn another language eg. German, French, Spanish etc ...
For a new language:\nAdd into redis-ui-material/src/bundle.js.
\n
This solution is not using REST at all, but instead uses Socket.IO 🤣, which is weird, but I like it, it is supposed to be more responsive, as there is no big overhead in the HTTP protocol.
🙏 This is an open-source project. Star this repository, if you like it, or even donate to maintain the servers and the development. Thank you so much!
\n
Possible, this server, rarely, is down, please, hang on for 15-30 minutes and the server will be back up.
\n
All my domains (patrikx3.com and corifeus.com) could have minor errors, since I am developing in my free time. However, it is usually stable.
\n
Note about versioning: Versions are cut in Major.Minor.Patch schema. Major is always the current year. Minor is either 4 (January - June) or 10 (July - December). Patch is incremental by every build. If there is a breaking change, it should be noted in the readme.
It's recommended to move the Papyrus.app file to the Applications directory. macOS will prompt you to accept that this runs from an unidentified developer.
\n
Shortcuts
\n
\n\n
\n
Description
\n
Keybinding
\n
\n\n\n
\n
Create a new document
\n
Cmd/CtrlN
\n
\n
\n
Create a new folder
\n
Cmd/CtrlT
\n
\n\n
\n
All keybindings can also be found under the File menu.
\n
Development
\n
The application wraps the official Dropbox Paper website in an Electron browser window (and does some more minor things to round it up).
\n
git clone the repository, npm install all dependencies and you are good to go. You might have to run brew install wine before building the application.
\n
\n\n
\n
Command
\n
Description
\n
\n\n\n
\n
npm start
\n
Starts the application
\n
\n
\n
npm run build
\n
Creates packages for all supported platforms (bundles all below commands)
It's recommended to move the Papyrus.app file to the Applications directory. macOS will prompt you to accept that this runs from an unidentified developer.
\n
Shortcuts
\n
\n\n
\n
Description
\n
Keybinding
\n
\n\n\n
\n
Create a new document
\n
Cmd/CtrlN
\n
\n
\n
Create a new folder
\n
Cmd/CtrlT
\n
\n\n
\n
All keybindings can also be found under the File menu.
\n
Development
\n
The application wraps the official Dropbox Paper website in an Electron browser window (and does some more minor things to round it up).
\n
git clone the repository, npm install all dependencies and you are good to go. You might have to run brew install wine before building the application.
\n
\n\n
\n
Command
\n
Description
\n
\n\n\n
\n
npm start
\n
Starts the application
\n
\n
\n
npm run build
\n
Creates packages for all supported platforms (bundles all below commands)
The Particl Project is committed to providing everyone with privacy, security, resistance to censorship, and freedom in this digital age.
\n
Particl Desktop is a standalone, multi-purpose desktop application capable of hosting multiple functionalities at once and delivering a streamlined user-experience when interacting with Particl's services and applications.
\n
Particl Desktop provides easy access to the Particl Blockchain and the SMSG protocol, hosts Particl coin (PART) related wallets, gives users access to the Particl Marketplace and the encrypted chat application. Additionally, Particl Desktop supports a bot framework to optionally integrate interactions with third-party services within a user-friendly interface. Particl Desktop generally refers to Particl’s flagship application.
\n
With Particl Desktop, you get access to a decentralized platform delivering the following to you:
\n
\n
The Particl Network\nAll services are peer to peer (p2p). No central authority or central server stands between you and the people you interact with. It's a direct connection.\n
\n
An encrypted data exchange protocol\nSecureMessaging (SMSG protocol) is a decentralized storage network (DSN) to store and transfer data between nodes in a privacy-preserving manner. It enables a private and secure environment for e-commerce and communications between users. SMSG powers the Particl Marketplace without bloating the blockchain with excessive data and without leaving any permanent record.
\n
A programmable blockchain with advanced privacy features\nThe Particl Blockchain is a decentralized, immutable, and censorship-proof ledger. It is based on bitcoin technology and has been carefully enhanced by the Particl team to provide a more robust level of privacy through industry-leading privacy technologies. The Particl Blockchain processes and validates payments between two users without requiring any third-party such as a bank or a payment processor.
\n
\n
\n
The privacy coin PART\nPART is a blazing fast and highly flexible cryptocurrency with multiple privacy states. It lets you send and receive payments without revealing your financial data to anyone. The PART coin provides automation, interoperability, complete resistance to censorship, and privacy to the Particl Marketplace.
\n
The Particl Marketplace\nThe Particl Marketplace is a decentralized and privacy-oriented marketplace that lets you buy and sell goods and services on the web without leaving any digital footprint behind. Payments between two users can be initiated using multiple currencies but always settle in PART. No bank account, documentation, email, phone number, or any other identification type is required. It transforms today's e-commerce into a free, secure, and trustworthy place where the market conditions are fair and equal to all.
There currently is an open testnet phase for the upcoming \"Particl V3\" release. Feel free to test the new version; we happily look forward to your feedback.
Note: The most recent development happens on the dev branch. Keep in mind that the development currently happens on a private fork of this repo. This repository is the user interface that works in combination with our particl-core.
\n
\n
In the project's folder:
\n\n
Run ng serve to start the dev server and keep it running
\n
In another terminal window, run yarn run start:electron:dev -testnet --devtools to start Particl Desktop on testnet (the daemon will be updated and launched automatically)\n
\n
-testnet – for running on testnet (omit for running the client on mainnet)
\n
-reindex – reindexes the blockchain (in case you're stuck)
\n
--devtools – automatically opens Developer Tools on client launch
\n
\n
\n\n
Interact with particl-core daemon
\n
You can directly interact with the daemon ran by the Electron version:
\n
./particl-cli -testnet getblockchaininfo\n
\n
Packaging
\n
Windows-only requirements
\n
Building for Windows requires the 32-bit libraries to be available:
Particl is a security and privacy oriented project. As such, a permanent bug bounty program is put in place in order to encourage the responsible disclosure of any bug or vulnerability contained within the Particl code and reward those who find them.
The Particl Project is committed to providing everyone with privacy, security, resistance to censorship, and freedom in this digital age.
\n
Particl Desktop is a standalone, multi-purpose desktop application capable of hosting multiple functionalities at once and delivering a streamlined user-experience when interacting with Particl's services and applications.
\n
Particl Desktop provides easy access to the Particl Blockchain and the SMSG protocol, hosts Particl coin (PART) related wallets, gives users access to the Particl Marketplace and the encrypted chat application. Additionally, Particl Desktop supports a bot framework to optionally integrate interactions with third-party services within a user-friendly interface. Particl Desktop generally refers to Particl’s flagship application.
\n
With Particl Desktop, you get access to a decentralized platform delivering the following to you:
\n
\n
The Particl Network\nAll services are peer to peer (p2p). No central authority or central server stands between you and the people you interact with. It's a direct connection.\n
\n
An encrypted data exchange protocol\nSecureMessaging (SMSG protocol) is a decentralized storage network (DSN) to store and transfer data between nodes in a privacy-preserving manner. It enables a private and secure environment for e-commerce and communications between users. SMSG powers the Particl Marketplace without bloating the blockchain with excessive data and without leaving any permanent record.
\n
A programmable blockchain with advanced privacy features\nThe Particl Blockchain is a decentralized, immutable, and censorship-proof ledger. It is based on bitcoin technology and has been carefully enhanced by the Particl team to provide a more robust level of privacy through industry-leading privacy technologies. The Particl Blockchain processes and validates payments between two users without requiring any third-party such as a bank or a payment processor.
\n
\n
\n
The privacy coin PART\nPART is a blazing fast and highly flexible cryptocurrency with multiple privacy states. It lets you send and receive payments without revealing your financial data to anyone. The PART coin provides automation, interoperability, complete resistance to censorship, and privacy to the Particl Marketplace.
\n
The Particl Marketplace\nThe Particl Marketplace is a decentralized and privacy-oriented marketplace that lets you buy and sell goods and services on the web without leaving any digital footprint behind. Payments between two users can be initiated using multiple currencies but always settle in PART. No bank account, documentation, email, phone number, or any other identification type is required. It transforms today's e-commerce into a free, secure, and trustworthy place where the market conditions are fair and equal to all.
There currently is an open testnet phase for the upcoming \"Particl V3\" release. Feel free to test the new version; we happily look forward to your feedback.
Note: The most recent development happens on the dev branch. Keep in mind that the development currently happens on a private fork of this repo. This repository is the user interface that works in combination with our particl-core.
\n
\n
In the project's folder:
\n\n
Run ng serve to start the dev server and keep it running
\n
In another terminal window, run yarn run start:electron:dev -testnet --devtools to start Particl Desktop on testnet (the daemon will be updated and launched automatically)\n
\n
-testnet – for running on testnet (omit for running the client on mainnet)
\n
-reindex – reindexes the blockchain (in case you're stuck)
\n
--devtools – automatically opens Developer Tools on client launch
\n
\n
\n\n
Interact with particl-core daemon
\n
You can directly interact with the daemon ran by the Electron version:
\n
./particl-cli -testnet getblockchaininfo\n
\n
Packaging
\n
Windows-only requirements
\n
Building for Windows requires the 32-bit libraries to be available:
Particl is a security and privacy oriented project. As such, a permanent bug bounty program is put in place in order to encourage the responsible disclosure of any bug or vulnerability contained within the Particl code and reward those who find them.
Passky is simple password manager, which works on a zero trust architecture. That means only user will be able to decrypt his passwords. So users can safely store their passwords on any server. That means if a server on where all passwords are stored get hacked, hacker won't be able to decrypt passwords and data on this server will be useless for him.
In the search box on the taskbar, type Control Panel and select it from the results.
\n
Select Programs > Programs and Features.
\n
Right click on the Passky and select Uninstall or Uninstall/Change.
\n\n
Debian based distros
\n
sudo dpkg -r passky
\n
Red Hat based distros
\n
sudo rpm -e Passky
\n
Snap
\n
sudo snap remove passky
\n
AppImage
\n\n
Move passky-2.0.2.AppImage to the trash
\n
Empty your trash
\n\n
",
+ "readmeOriginal": "
Passky-Desktop
\n
What is Passky?
\n
Passky is simple password manager, which works on a zero trust architecture. That means only user will be able to decrypt his passwords. So users can safely store their passwords on any server. That means if a server on where all passwords are stored get hacked, hacker won't be able to decrypt passwords and data on this server will be useless for him.
\nA desktop app which converts your minecraft .schematic files you got from worldedit to blueprints for papercraft.
\n \n \n \n
\n\n \n
🚀 How to use?
\n\n
🏡 You need an installed Minecraft Version
\n
🏗 You need to install the Minecraft mod Worldedit
\n
🔨 Start Minecraft and build something amazing
\n
💾//Copy what you built and //schematic save it
\n
🌴 Download a Texturepack
\n
💿 Start this desktop app
\n
🏝 Drop schematic file and texturepack in it
\n
🌟 Let the Program do its magic
\n
🖨 Print out the blueprints
\n
🏘 Make amazing minecraft builds in real!
\n\n
⚠️ Important
\n
\n
PaperCubes is still in BETA. Errors may occur. When you found one, please open an issue for me
\n
Currently works only for schematic files which are taken from minecraft versions smaller than v1.13.0. Versions that are very old won't work eighter. The version of the texturepack should match the minecraft version of the schematic file for best results
\n
Loading times can be very long depending on the size of the schematic
\n
\n
📝 Source Code
\n
In order to use this source code you need to have Node.js, Git and Bower installed globally. After that you have to follow the steps below.
\n
Only for Windows (as admin)
\n
npm install --global --production windows-build-tools\nnpm config set msvs_version 2015 --global
\n
For all platforms
\n
# Clone this repository\ngit clone https://github.com/florianfe/PaperCubes\n# Go into the repository\ncd PaperCubes\n# Install npm dependencies\nnpm install\n# Install bower dependencies\nbower install\n# Compile C++ sources\nnpm run-script compile\n# Run the app in test mode\nnpm start\n# build application for release\n[sudo] npm run-script dist
This Project was inspired by Orthogami (made by mikolalysenko).
\n
The Texture Pack Pixel Perfection (Link) which is used for the Screenshots was made by Hugh \"XSSheep\" Rutland.
\n
\n
📖 License
\n
\n
",
+ "readmeOriginal": "
\n \n
🏡🖨 PaperCubes
\n
\nA desktop app which converts your minecraft .schematic files you got from worldedit to blueprints for papercraft.
\n \n \n \n
\n\n \n
🚀 How to use?
\n\n
🏡 You need an installed Minecraft Version
\n
🏗 You need to install the Minecraft mod Worldedit
\n
🔨 Start Minecraft and build something amazing
\n
💾//Copy what you built and //schematic save it
\n
🌴 Download a Texturepack
\n
💿 Start this desktop app
\n
🏝 Drop schematic file and texturepack in it
\n
🌟 Let the Program do its magic
\n
🖨 Print out the blueprints
\n
🏘 Make amazing minecraft builds in real!
\n\n
⚠️ Important
\n
\n
PaperCubes is still in BETA. Errors may occur. When you found one, please open an issue for me
\n
Currently works only for schematic files which are taken from minecraft versions smaller than v1.13.0. Versions that are very old won't work eighter. The version of the texturepack should match the minecraft version of the schematic file for best results
\n
Loading times can be very long depending on the size of the schematic
\n
\n
📝 Source Code
\n
In order to use this source code you need to have Node.js, Git and Bower installed globally. After that you have to follow the steps below.
\n
Only for Windows (as admin)
\n
npm install --global --production windows-build-tools\nnpm config set msvs_version 2015 --global
\n
For all platforms
\n
# Clone this repository\ngit clone https://github.com/florianfe/PaperCubes\n# Go into the repository\ncd PaperCubes\n# Install npm dependencies\nnpm install\n# Install bower dependencies\nbower install\n# Compile C++ sources\nnpm run-script compile\n# Run the app in test mode\nnpm start\n# build application for release\n[sudo] npm run-script dist
Pencil V3 is a rewrite of Pencil that aims to fix major performance and scalability issues of the application. The new version is under heavy development and we are expecting GA builds in June. The following list summarizes important changes in the new version:
\n
\n
Pencil V3 uses Electron instead of Mozilla XULRunner as the runtime. We expect that by moving into this Nodejs-based environment, the Pencil source code can be much easier for all fellow developers to play with. The fact that Mozilla XULRunner is outdated is also a reason for the movement.
\n
A new, zip-based file format was introduced to support large documents and better embedding of external bitmaps/resources.
\n
A new mechanism for page management that dramatically reduces memory usage for large documents.
\n
Document pages can now be structured into a tree-like model.
\n
Custom fonts can now be embedded into Pencil .epz documents
\n
Printing and PDF export will be improved to support all platforms and with many options
\n
New UI approach
\n
\n
Setting up
\n
Pencil uses Atom Electron as the runtime, follow the these steps to setup the environment:
\n
\n
\n
Clone this repository
\n
\n
\n
Make sure you are using nodejs 5+ (Pencil development only needs npm for package management. Node runtime is not required.)
\n
\n
\n
Checkout this development branch:
\n
$ git checkout development
\n
\n
\n
Install dependencies:
\n
$ npm install
\n
\n
\n
Start Pencil using the prebuilt version of Electron
\n
$ npm start
\n
\n
\n
Supported Platforms
\n
OS X
\n
Only OSX 64bit 10.9 and later are supported.
\n
Windows
\n
Windows 7 and later are supported, older operating systems are not supported (and do not work).
Pencil V3 is a rewrite of Pencil that aims to fix major performance and scalability issues of the application. The new version is under heavy development and we are expecting GA builds in June. The following list summarizes important changes in the new version:
\n
\n
Pencil V3 uses Electron instead of Mozilla XULRunner as the runtime. We expect that by moving into this Nodejs-based environment, the Pencil source code can be much easier for all fellow developers to play with. The fact that Mozilla XULRunner is outdated is also a reason for the movement.
\n
A new, zip-based file format was introduced to support large documents and better embedding of external bitmaps/resources.
\n
A new mechanism for page management that dramatically reduces memory usage for large documents.
\n
Document pages can now be structured into a tree-like model.
\n
Custom fonts can now be embedded into Pencil .epz documents
\n
Printing and PDF export will be improved to support all platforms and with many options
\n
New UI approach
\n
\n
Setting up
\n
Pencil uses Atom Electron as the runtime, follow the these steps to setup the environment:
\n
\n
\n
Clone this repository
\n
\n
\n
Make sure you are using nodejs 5+ (Pencil development only needs npm for package management. Node runtime is not required.)
\n
\n
\n
Checkout this development branch:
\n
$ git checkout development
\n
\n
\n
Install dependencies:
\n
$ npm install
\n
\n
\n
Start Pencil using the prebuilt version of Electron
\n
$ npm start
\n
\n
\n
Supported Platforms
\n
OS X
\n
Only OSX 64bit 10.9 and later are supported.
\n
Windows
\n
Windows 7 and later are supported, older operating systems are not supported (and do not work).
This release is meant to tide us over so that other clients can take it from here.
\n
Thank you to everyone who contributed to this release and all the ones preceding it!\nPaul, Matt McKegg, and Christian Bundy first and foremost, but by now the contributors page shows 94 contributors! 💓
\n
Where do we go from here? Do I have to change client now?
\n
For the time being (the next couple of months) you should be fine to just keep Patchwork running. However, as time progresses and security of the underlying components \"degrades\" (read: already existing issues are discovered) it will become a bad idea to keep running Patchwork.\nBy that time, you should pick a different ssb client.
\n
Why retire Patchwork? Can I keep it alive?
\n
Of course Patchwork is, as always, released under the AGPL license. So if you really wanted to, you could fork it and keep it alive. However, let me (Daan) explain why this is a bad idea:
\n
All the devs say \"Don't do it!\"
\n
Everyone who has spent significant time in the codebase agrees that it is time to retire Patchwork. Over the years, it has seen multiple iterations of developers coming in, trying to change things in a structural way, then burning out on it. It's a pattern, so be warned. This is due to the fact that Patchwork makes some architectural decisions that make it hard to maintain, and even harder for new developers to get into the codebase:
\n
\n
depject is a bespoke dependency injection system, which breaks any kind of navigation and tool support for debugging.
\n
mutant is another bespoke implementation of observables. It is also used for generating HTML, which makes a transition to component-based UI toolkits very hard.
\n
custom sbot: Patchwork doesn't really work except with its own, bundled ssb-server. This is considered bad form for ssb applications.
\n
ssb-db, the bespoke database of the original ssb stack, is deeply baked into patchwork. Migrating to the new #ssb-db2 would be a long and painful process. This is compounded by the fact that patchwork bundles a few custom plugins for ssb-db.
\n
\n
I want to be clear that none of the above are impossible to solve; in fact, they all have straight-forward but labour-intensive solutions. I also want to be clear that these technological choices were all made for good reasons at the time, and I am sure you're as greatful to the developers who made them as I am, for putting their (overwhelmingly volunteered!) time into the project, and for making Patchwork the application that it is. In combination however, the above issues mean that new developers are faced with a very, very steep leaning curve before they're able to even make small changes.\nGiven all of the above, it makes more sense to deprecate Patchwork and focus our efforts on projects like #oasis or #manyverse which are nearing feature parity with Patchwork. If you want to get involved with ssb development, both are great projects for that; they are much more hackable than Patchwork, and follow standard techniques & workflows, so you'll feel right at home.
\n
If you do, against all advice, want to continue developing Patchwork then we kindly request you rename it to reflect the change in leadership.
\n\n
Original Readme
\n
\n
A decentralized messaging and sharing app built on top of Secure Scuttlebutt (SSB).
\n
\n
Features
\n
\n
Connect with friends without depending on any central servers.
\n
Don't worry about spam, you only get messages from people you follow.
\n
Use Patchwork online or offline, the data you need is stored on your device.
\n
Sync messages with friends when you're on the same Wi-Fi network.
\n
Keep secrets with private messages, which are always end-to-end encrypted.
\n
Change and improve Patchwork however you'd like, it's free and open source.
\n
\n
Usage
\n
\n
New to Scuttlebutt? Join the network by connecting to a pub.
\n\n
Choose a pub from the pub list and copy an invite code.
\n
Open Patchwork and select Join Pub.
\n
Paste the invite code and select Redeem Invite.
\n\n
You're done! Check out #new-people to see who else has recently joined.
Building from source? Check out INSTALL.md for more information.
\n
Contributing
\n
Create a new issue to report problems or request features. See\nCONTRIBUTING.md for more information on how to get involved.\nYou can also support the project via donations.
\n
Please note that this project is released with a Contributor Code of\nConduct. By participating in this project you agree to abide by its\nterms.
This release is meant to tide us over so that other clients can take it from here.
\n
Thank you to everyone who contributed to this release and all the ones preceding it!\nPaul, Matt McKegg, and Christian Bundy first and foremost, but by now the contributors page shows 94 contributors! 💓
\n
Where do we go from here? Do I have to change client now?
\n
For the time being (the next couple of months) you should be fine to just keep Patchwork running. However, as time progresses and security of the underlying components \"degrades\" (read: already existing issues are discovered) it will become a bad idea to keep running Patchwork.\nBy that time, you should pick a different ssb client.
\n
Why retire Patchwork? Can I keep it alive?
\n
Of course Patchwork is, as always, released under the AGPL license. So if you really wanted to, you could fork it and keep it alive. However, let me (Daan) explain why this is a bad idea:
\n
All the devs say \"Don't do it!\"
\n
Everyone who has spent significant time in the codebase agrees that it is time to retire Patchwork. Over the years, it has seen multiple iterations of developers coming in, trying to change things in a structural way, then burning out on it. It's a pattern, so be warned. This is due to the fact that Patchwork makes some architectural decisions that make it hard to maintain, and even harder for new developers to get into the codebase:
\n
\n
depject is a bespoke dependency injection system, which breaks any kind of navigation and tool support for debugging.
\n
mutant is another bespoke implementation of observables. It is also used for generating HTML, which makes a transition to component-based UI toolkits very hard.
\n
custom sbot: Patchwork doesn't really work except with its own, bundled ssb-server. This is considered bad form for ssb applications.
\n
ssb-db, the bespoke database of the original ssb stack, is deeply baked into patchwork. Migrating to the new #ssb-db2 would be a long and painful process. This is compounded by the fact that patchwork bundles a few custom plugins for ssb-db.
\n
\n
I want to be clear that none of the above are impossible to solve; in fact, they all have straight-forward but labour-intensive solutions. I also want to be clear that these technological choices were all made for good reasons at the time, and I am sure you're as greatful to the developers who made them as I am, for putting their (overwhelmingly volunteered!) time into the project, and for making Patchwork the application that it is. In combination however, the above issues mean that new developers are faced with a very, very steep leaning curve before they're able to even make small changes.\nGiven all of the above, it makes more sense to deprecate Patchwork and focus our efforts on projects like #oasis or #manyverse which are nearing feature parity with Patchwork. If you want to get involved with ssb development, both are great projects for that; they are much more hackable than Patchwork, and follow standard techniques & workflows, so you'll feel right at home.
\n
If you do, against all advice, want to continue developing Patchwork then we kindly request you rename it to reflect the change in leadership.
\n\n
Original Readme
\n
\n
A decentralized messaging and sharing app built on top of Secure Scuttlebutt (SSB).
\n
\n
Features
\n
\n
Connect with friends without depending on any central servers.
\n
Don't worry about spam, you only get messages from people you follow.
\n
Use Patchwork online or offline, the data you need is stored on your device.
\n
Sync messages with friends when you're on the same Wi-Fi network.
\n
Keep secrets with private messages, which are always end-to-end encrypted.
\n
Change and improve Patchwork however you'd like, it's free and open source.
\n
\n
Usage
\n
\n
New to Scuttlebutt? Join the network by connecting to a pub.
\n\n
Choose a pub from the pub list and copy an invite code.
\n
Open Patchwork and select Join Pub.
\n
Paste the invite code and select Redeem Invite.
\n\n
You're done! Check out #new-people to see who else has recently joined.
Building from source? Check out INSTALL.md for more information.
\n
Contributing
\n
Create a new issue to report problems or request features. See\nCONTRIBUTING.md for more information on how to get involved.\nYou can also support the project via donations.
\n
Please note that this project is released with a Contributor Code of\nConduct. By participating in this project you agree to abide by its\nterms.
This repository keeps track of Pendulums client source.
\n
Development server
\n
Run npm run start for a dev server. Navigate to http://localhost:4200/. The app will automatically reload if you change any of the source files.
\n
Help us to improve Pendulums and keep it alive
\n
Maintaining servers, fixing issues and bringing new features to Pendulums cost a lot of time and money. We will be grateful if you can show us some love using donations.
\n
",
+ "readmeOriginal": "
Pendulums Web/Desktop/Android Clients
\n
This repository keeps track of Pendulums client source.
\n
Development server
\n
Run npm run start for a dev server. Navigate to http://localhost:4200/. The app will automatically reload if you change any of the source files.
\n
Help us to improve Pendulums and keep it alive
\n
Maintaining servers, fixing issues and bringing new features to Pendulums cost a lot of time and money. We will be grateful if you can show us some love using donations.
Pennywise opens any website or media in a small floating window that remains on top of all other applications. Pennywise windows stays up all the time. No need to keep struggling with alt + tab, use Pennywise for easy multitasking.
\n
Features
\n
\n
Always stays on top of any open applications
\n
Adjustable opacity – it gets out of your way while you work
\n
Resize and place it anywhere
\n
Shortcuts to make you more productive
\n
Lets you multitask while you work
\n
Open source licensed under MIT
\n
Lean small resource footprint, minimal User Interface.
\n
Cross-platform works on MacOS, Windows and Linux
\n
\n
Installation
\n
Download and install the relevant distribution from the releases page.
\n
If you are on MacOS, you can use Homebrew to install it
\n
brew cask install pennywise\n
\n
Enable Flash Support
\n
To enable flash support, copy or link Chrome's Pepperflash plugin into your $HOME/.pennywise-flash. You can find the plugin at the installation path of the Chrome. For example, on MacOS, you can do the below to enable Flash support
Here is the list of some of the possible use cases off the top of my head
\n
\n
\n
Use it as a floating window for your calendar/checklist/assigned-tickets etc
\n
Watching tutorial while you code? Open the video in Pennywise and keep it in front of you
\n
Making a video course? Open the demo in Pennywise and show the output in real time
\n
Working on some web UI? Open it in Pennywise to avoid pressing alt + tab again and again
\n
Play some video, watch some talk or play some TV series while you work
\n
Working on something non-familiar? Open the docs in Pennywise
\n
Open that live football match that you won't want to miss
\n
Use it as a desktop widget
\n
\n
Development
\n
Clone the repository, install the dependencies and start the app
\n
yarn install\nyarn start
\n
Shortcuts
\n
\n
Here is the list of available shortcuts that you may use
\n
\n
\n\n
\n
Shortcut
\n
Description
\n
\n\n\n
\n
Cmd/Ctrl + L
\n
Show Navbar and focus URL input
\n
\n
\n
Cmd/Ctrl + Shift + D
\n
Enable detached mode
\n
\n
\n
Cmd/Ctrl + M
\n
Refresh Page
\n
\n
\n
Cmd/Ctrl + Shift + L
\n
Toggle Navbar on WebPages
\n
\n
\n
Cmd/Ctrl + Shift + Up
\n
Increase Opacity
\n
\n
\n
Cmd/Ctrl + Shift + Down
\n
Decrease Opacity
\n
\n
\n
Cmd/Ctrl + Alt + I
\n
Show Developer Tools
\n
\n
\n
Cmd/Ctrl + [0-9]
\n
Switch Window Opacity
\n
\n\n
\n
\n
Note – Changing the opacity is only supported in Windows and MacOS
\n
\n
Detached Mode
\n
\n
Enabling the detached mode makes Pennywise non-interactive – it will let any interactions fall through to the window below it. To remove the detached mode, focus the window either by clicking the dock icon or by activating it using alt + tab
\n
\n
Screenshots
\n
\n
Homescreen for the application
\n
\n
\n
\n
\n
Anything running in pennywise stays on top of everything
\n
\n
\n
\n
\n
You can change the opacity too
\n
\n
\n
\n
Auto-embed Videos
\n
For some video streaming websites such as Youtube, Vimeo, Twitch, Daily Motion etc, Pennywise shows you the video only web page by default (using the auto-generated embed links), showing you the video in a distract free manner. You can disable that by toggling the Edit > Embed Videos.
\n
\n
Note – In case of youtube, it might not work sometime when the user has put restrictions on the video – in that case, you will have to disable \"Auto Embed\" option from the Edit menu to make them work.
Pennywise opens any website or media in a small floating window that remains on top of all other applications. Pennywise windows stays up all the time. No need to keep struggling with alt + tab, use Pennywise for easy multitasking.
\n
Features
\n
\n
Always stays on top of any open applications
\n
Adjustable opacity – it gets out of your way while you work
\n
Resize and place it anywhere
\n
Shortcuts to make you more productive
\n
Lets you multitask while you work
\n
Open source licensed under MIT
\n
Lean small resource footprint, minimal User Interface.
\n
Cross-platform works on MacOS, Windows and Linux
\n
\n
Installation
\n
Download and install the relevant distribution from the releases page.
\n
If you are on MacOS, you can use Homebrew to install it
\n
brew cask install pennywise\n
\n
Enable Flash Support
\n
To enable flash support, copy or link Chrome's Pepperflash plugin into your $HOME/.pennywise-flash. You can find the plugin at the installation path of the Chrome. For example, on MacOS, you can do the below to enable Flash support
Here is the list of some of the possible use cases off the top of my head
\n
\n
\n
Use it as a floating window for your calendar/checklist/assigned-tickets etc
\n
Watching tutorial while you code? Open the video in Pennywise and keep it in front of you
\n
Making a video course? Open the demo in Pennywise and show the output in real time
\n
Working on some web UI? Open it in Pennywise to avoid pressing alt + tab again and again
\n
Play some video, watch some talk or play some TV series while you work
\n
Working on something non-familiar? Open the docs in Pennywise
\n
Open that live football match that you won't want to miss
\n
Use it as a desktop widget
\n
\n
Development
\n
Clone the repository, install the dependencies and start the app
\n
yarn install\nyarn start
\n
Shortcuts
\n
\n
Here is the list of available shortcuts that you may use
\n
\n
\n\n
\n
Shortcut
\n
Description
\n
\n\n\n
\n
Cmd/Ctrl + L
\n
Show Navbar and focus URL input
\n
\n
\n
Cmd/Ctrl + Shift + D
\n
Enable detached mode
\n
\n
\n
Cmd/Ctrl + M
\n
Refresh Page
\n
\n
\n
Cmd/Ctrl + Shift + L
\n
Toggle Navbar on WebPages
\n
\n
\n
Cmd/Ctrl + Shift + Up
\n
Increase Opacity
\n
\n
\n
Cmd/Ctrl + Shift + Down
\n
Decrease Opacity
\n
\n
\n
Cmd/Ctrl + Alt + I
\n
Show Developer Tools
\n
\n
\n
Cmd/Ctrl + [0-9]
\n
Switch Window Opacity
\n
\n\n
\n
\n
Note – Changing the opacity is only supported in Windows and MacOS
\n
\n
Detached Mode
\n
\n
Enabling the detached mode makes Pennywise non-interactive – it will let any interactions fall through to the window below it. To remove the detached mode, focus the window either by clicking the dock icon or by activating it using alt + tab
\n
\n
Screenshots
\n
\n
Homescreen for the application
\n
\n
\n
\n
\n
Anything running in pennywise stays on top of everything
\n
\n
\n
\n
\n
You can change the opacity too
\n
\n
\n
\n
Auto-embed Videos
\n
For some video streaming websites such as Youtube, Vimeo, Twitch, Daily Motion etc, Pennywise shows you the video only web page by default (using the auto-generated embed links), showing you the video in a distract free manner. You can disable that by toggling the Edit > Embed Videos.
\n
\n
Note – In case of youtube, it might not work sometime when the user has put restrictions on the video – in that case, you will have to disable \"Auto Embed\" option from the Edit menu to make them work.
Perlotto - minimal google music / youtube wrapper wrapper
\n
\n
Perlotto is a minimal wrapper around Google Music and Youtube services\nthat turnes them into real platers but does not add tons of crap on top.\nSo, what's inside?
\n
\n
Google music and Youtube support
\n
Multimedia keys
\n
Last.FM scrobbling
\n
No notifications
\n
\n
That's it.
\n
Development
\n
$ npm install\n$ npm start
\n
My favorite music service is not supported! What can I do?
\n
Adding new music service ranges from trivial to somewhat\ncomplicated in case this service works with external plugins\n(like spotify). Nevertheless, Google music implementation\ncan serve as a boilerplate.
\n
You need to be able to reason of several things to get the\nfull integration:
\n
\n
\n
How to understand that player page is loaded
\n
This is playerLoadedp function in inject.js script.
How to do play/pause ot switch to the next or previous track
\n
The javascript to be executed for this commands is defined\nin content.js script.
\n
\n
\n
How to get information about current song.
\n
This is trackInfo function in inject.js script. Please\nnote that this information is only required for last.fm stuff\nbut who knows if we need it for something else, right?
\n
\n
\n
And of course you need to be able to make your service work\ninside Perlotto app.
\n
\n
\n
Packaging
\n
$ npm run dist
\n
Issues
\n
Whenever you encounter any feel free to raise issues in bugtracker or, what's better,\nto solve them and send pull requests.
\n
License
\n
MIT, except app icon, which was just found on iconfinder. If you are\nthe owner and don't want it to be there, please contact me.
\n
",
+ "readmeOriginal": "
Perlotto - minimal google music / youtube wrapper wrapper
\n
\n
Perlotto is a minimal wrapper around Google Music and Youtube services\nthat turnes them into real platers but does not add tons of crap on top.\nSo, what's inside?
\n
\n
Google music and Youtube support
\n
Multimedia keys
\n
Last.FM scrobbling
\n
No notifications
\n
\n
That's it.
\n
Development
\n
$ npm install\n$ npm start
\n
My favorite music service is not supported! What can I do?
\n
Adding new music service ranges from trivial to somewhat\ncomplicated in case this service works with external plugins\n(like spotify). Nevertheless, Google music implementation\ncan serve as a boilerplate.
\n
You need to be able to reason of several things to get the\nfull integration:
\n
\n
\n
How to understand that player page is loaded
\n
This is playerLoadedp function in inject.js script.
How to do play/pause ot switch to the next or previous track
\n
The javascript to be executed for this commands is defined\nin content.js script.
\n
\n
\n
How to get information about current song.
\n
This is trackInfo function in inject.js script. Please\nnote that this information is only required for last.fm stuff\nbut who knows if we need it for something else, right?
\n
\n
\n
And of course you need to be able to make your service work\ninside Perlotto app.
\n
\n
\n
Packaging
\n
$ npm run dist
\n
Issues
\n
Whenever you encounter any feel free to raise issues in bugtracker or, what's better,\nto solve them and send pull requests.
\n
License
\n
MIT, except app icon, which was just found on iconfinder. If you are\nthe owner and don't want it to be there, please contact me.
Releasing Peacock for the Windows package, Chocolatey, might be our next step.
\n
Mac
\n
Unfortunately, Mac builds are failing and there hasn't been enough testing yet for Peacock to be confident enough in releasing a public build for MacOS.
\n
Linux
\n
Here, you can download Linux builds for Peacock. Hopefully Peacock will have a Flatpak release and possibly an RPM build in the near future.
Both of the build commands use electron-builder and output executables for their respective operating system in the dist/ folder.
\n
Download and initialize Peacock's source code with these commands:
\n\n
git clone https://github.com/peacockweb/peacock.git && cd peacock
\n
npm i
\n\n
Run peacock from source:
\n
npm run start
\n
Build instructions for Windows:
\n
npm run build-win
\n
Build instructions for Linux:
\n
npm run build-linux
\n
F.A.Q.
\n
How does Peacock compare to other privacy browsers like Firefox and Brave?
\n
Both Firefox and Brave are spectacular and every day, Peacock gets closer and closer to their status of privacy. Peacock isn't stable enough yet to be used as a daily driver, but is an awesome experiment nonetheless to test the limits of the web and help make the internet a safer place.
\n
How do I know Peacock doesn't take telemetry?
\n
Peacock is built around on open source technologies and therefore we love transparency. You're welcome to perform your own audits on our entirely open source code! We also include a Components entry in our docs which breaks down all the technologies used in the production of Peacock.
\n
How experimental is Peacock? Can I process any sensitive data on it yet?
\n
Using should hold off on doing anything too sensitive on Peacock for now, it's still in development and bugs are getting patched all the time, but like all apps, some may be missed along the way.
\n
Why use Electron?
\n
Some people are skeptical about Electron for its generally high memory usage, but Electron makes the development process incredibly simple. Electron lets us build a desktop app using web technologies. Eventually, we may switch to something more practical like forking Chromium or Firefox.
\n
How to bypass security warnings?
\n
On Windows, apps are deemed as insecure if they haven't been code-signed with a certificate. Sigining certificates are expensive and therefore, Peacock doesn't have one (yet). This means that Peacock may show up to antiviruses or Windows Defender as a 'suspicious application' but can be easily bypsased selecting \"More Info\" > \"Run Anyway\":
\n
\n
",
+ "readmeOriginal": "
Peacock
\n
\n
\n 🦚 Open source experimental private-by-default web browser. \n Docs |\n Download |\n FAQ\n
Releasing Peacock for the Windows package, Chocolatey, might be our next step.
\n
Mac
\n
Unfortunately, Mac builds are failing and there hasn't been enough testing yet for Peacock to be confident enough in releasing a public build for MacOS.
\n
Linux
\n
Here, you can download Linux builds for Peacock. Hopefully Peacock will have a Flatpak release and possibly an RPM build in the near future.
Both of the build commands use electron-builder and output executables for their respective operating system in the dist/ folder.
\n
Download and initialize Peacock's source code with these commands:
\n\n
git clone https://github.com/peacockweb/peacock.git && cd peacock
\n
npm i
\n\n
Run peacock from source:
\n
npm run start
\n
Build instructions for Windows:
\n
npm run build-win
\n
Build instructions for Linux:
\n
npm run build-linux
\n
F.A.Q.
\n
How does Peacock compare to other privacy browsers like Firefox and Brave?
\n
Both Firefox and Brave are spectacular and every day, Peacock gets closer and closer to their status of privacy. Peacock isn't stable enough yet to be used as a daily driver, but is an awesome experiment nonetheless to test the limits of the web and help make the internet a safer place.
\n
How do I know Peacock doesn't take telemetry?
\n
Peacock is built around on open source technologies and therefore we love transparency. You're welcome to perform your own audits on our entirely open source code! We also include a Components entry in our docs which breaks down all the technologies used in the production of Peacock.
\n
How experimental is Peacock? Can I process any sensitive data on it yet?
\n
Using should hold off on doing anything too sensitive on Peacock for now, it's still in development and bugs are getting patched all the time, but like all apps, some may be missed along the way.
\n
Why use Electron?
\n
Some people are skeptical about Electron for its generally high memory usage, but Electron makes the development process incredibly simple. Electron lets us build a desktop app using web technologies. Eventually, we may switch to something more practical like forking Chromium or Firefox.
\n
How to bypass security warnings?
\n
On Windows, apps are deemed as insecure if they haven't been code-signed with a certificate. Sigining certificates are expensive and therefore, Peacock doesn't have one (yet). This means that Peacock may show up to antiviruses or Windows Defender as a 'suspicious application' but can be easily bypsased selecting \"More Info\" > \"Run Anyway\":
Windows screen saver that displays a photo slideshow, built on\nReact and Electron.
\n
Why?
\n
Since modern LCD displays aren't subject to burn-in, screen savers are a thing of the past... right?
\n
Not if you have your HTPC hooked up to a plasma TV; plasma still has a big problem with burn-in.\nFinding myself in that situation, I needed a screen saver that would protect the screen while a\nmovie is paused. I also wanted it to look great — it's in my living room, after all —\nbut every screen saver I tried looked like it was written decades ago. (Most of them were.)
\n
Modern web technologies make it incredibly easy to create engaging animations. All I needed was a\nway to marry the web tools we know and love to the Windows screen saver framework. That's where\nElectron comes in.
\n
Please note: This is currently a Windows-specific project. You can run the code in Electron on\nother platforms, but you won't get the screen saver integration with the OS.
\n
Before You Build
\n
This screen saver displays a photo slideshow with a simple \"Ken Burns\" effect. It supports two photo\nsources:
\n
\n
Flickr: Photos from the group \"Flickr's Best Landscape\nPhotographers (Post 1 Award 2)\"
\n
A local folder on your computer
\n
\n
Since I didn't feel like implementing a Settings window, you'll need to make some simple code\nchanges to set up a source. If you take a look at the top of src/photoSlideshow.tsx, you'll find\nthe following line of code. Set GET_PHOTOS to either getFlickrPhotos or getLocalPhotos:
\n
const GET_PHOTOS: GetPhotosFn = getFlickrPhotos\n
\n
Then do one of the following:
\n
\n
\n
Flickr: Get a Flickr API key and\nput it in src/constants.ts:
\n
";\n\">
export const FLICKR_API_KEY = \"<your API key goes here>\";\n
\n
\n
\n
Local: Edit src/constants.ts and set LOCAL_FOLDER_PATH to point to your image folder:
A quick warning: When you display random photos from the web, there's always a chance you'll get\nsomething you wouldn't want your kids, your grandma, or your boss to see. The Flickr API call is set\nup to avoid anything NSFW, but photos do end up in the wrong category from time to time —\ndon't say I didn't warn you. If you want to stay on the safe side, you can always use your own local\nfolder of photos.
\n
How to Build
\n
(This project requires Node.js — if you're reading\nthis, you probably already have it.)
\n
Install: Go to the project folder and run the following command:
\n
npm install\n
\n
Build: Go to the project folder and run the following command:
\n
npm run build-electron\n
\n
Run: Once the build is complete, you have a couple of options. If you want to quickly fire it up\nand see what it does, go to the project folder and run:
\n
npm run start-electron\n
\n
Screen Saver: If you want to install the screen saver, look in the\npackage/photo-screen-saver-win32-x64 subfolder and find the file photo-screen-saver.scr.\nRight-click the file and choose Install. When the Windows screen saver settings appear, you'll see\nthat photo-screen-saver is now your selected screen saver.
\n
Development: If you want to work on the React part of the project, you can run npm start to\nlaunch it in the browser. Since it's built on\ncreate-react-app, you get all the benefits of\nwebpack-dev-server including hot module reloading. Note: In this mode you won't be able to use any\nfeatures that depend on Electron, such as loading photos from a local folder.
\n
Behind the Scenes
\n
It's a lot easier than I thought to create a screen saver for Windows — it's just a normal\nexecutable with a .scr extension. The program just needs to display a topmost full-screen window and\nexit on mouse or keyboard activity. These requirements are really easy to meet in Electron!
\n
Note: This project is the bare minimum and won't give you the mini-preview or Settings features.\nThe mini-preview is a pain to implement, and IMO not worth the effort. To support Settings you just\nneed to handle the /S command line argument and display an appropriate UI. (I was too lazy to\nimplement a Settings UI, but you might feel differently!)
\n
Possibilities
\n
This project makes a good starting point for any screen saver you want to create. You could start by\nchanging the Flickr API call to get different types of photos. If photos aren't your cup of tea,\nthere are a lot of cool animations on CodePen and ShaderToy. To get you started, there are four ready-to-run\nanimation components included in this project, each one with a great-looking demo and each one\nillustrating a different basic approach to animation:
\n
\n
DemoCanvas: writes directly to an HTML5 Canvas
\n
DemoCss: uses pure SCSS
\n
DemoShader: implemented as a WebGL fragment shader
\n
DemoThreeJs: uses Three.js to create a 3D animation
\n
\n
At the top of src/app.tsx you'll find the following line of code. Set SHOW_COMPONENT to the\ncomponent you want to see:
You can create your own components using the demos as a template, and using your own code or\nexamples you find on the web. Whatever you use, be sure to comply with the license terms!
\n
License
\n
The MIT License
\n
Copyright (c) 2016 Rand Scullard
\n
",
+ "readmeOriginal": "
photo-screen-saver
\n
\n
Windows screen saver that displays a photo slideshow, built on\nReact and Electron.
\n
Why?
\n
Since modern LCD displays aren't subject to burn-in, screen savers are a thing of the past... right?
\n
Not if you have your HTPC hooked up to a plasma TV; plasma still has a big problem with burn-in.\nFinding myself in that situation, I needed a screen saver that would protect the screen while a\nmovie is paused. I also wanted it to look great — it's in my living room, after all —\nbut every screen saver I tried looked like it was written decades ago. (Most of them were.)
\n
Modern web technologies make it incredibly easy to create engaging animations. All I needed was a\nway to marry the web tools we know and love to the Windows screen saver framework. That's where\nElectron comes in.
\n
Please note: This is currently a Windows-specific project. You can run the code in Electron on\nother platforms, but you won't get the screen saver integration with the OS.
\n
Before You Build
\n
This screen saver displays a photo slideshow with a simple \"Ken Burns\" effect. It supports two photo\nsources:
\n
\n
Flickr: Photos from the group \"Flickr's Best Landscape\nPhotographers (Post 1 Award 2)\"
\n
A local folder on your computer
\n
\n
Since I didn't feel like implementing a Settings window, you'll need to make some simple code\nchanges to set up a source. If you take a look at the top of src/photoSlideshow.tsx, you'll find\nthe following line of code. Set GET_PHOTOS to either getFlickrPhotos or getLocalPhotos:
\n
const GET_PHOTOS: GetPhotosFn = getFlickrPhotos\n
\n
Then do one of the following:
\n
\n
\n
Flickr: Get a Flickr API key and\nput it in src/constants.ts:
\n
export const FLICKR_API_KEY = \"<your API key goes here>\";\n
\n
\n
\n
Local: Edit src/constants.ts and set LOCAL_FOLDER_PATH to point to your image folder:
A quick warning: When you display random photos from the web, there's always a chance you'll get\nsomething you wouldn't want your kids, your grandma, or your boss to see. The Flickr API call is set\nup to avoid anything NSFW, but photos do end up in the wrong category from time to time —\ndon't say I didn't warn you. If you want to stay on the safe side, you can always use your own local\nfolder of photos.
\n
How to Build
\n
(This project requires Node.js — if you're reading\nthis, you probably already have it.)
\n
Install: Go to the project folder and run the following command:
\n
npm install\n
\n
Build: Go to the project folder and run the following command:
\n
npm run build-electron\n
\n
Run: Once the build is complete, you have a couple of options. If you want to quickly fire it up\nand see what it does, go to the project folder and run:
\n
npm run start-electron\n
\n
Screen Saver: If you want to install the screen saver, look in the\npackage/photo-screen-saver-win32-x64 subfolder and find the file photo-screen-saver.scr.\nRight-click the file and choose Install. When the Windows screen saver settings appear, you'll see\nthat photo-screen-saver is now your selected screen saver.
\n
Development: If you want to work on the React part of the project, you can run npm start to\nlaunch it in the browser. Since it's built on\ncreate-react-app, you get all the benefits of\nwebpack-dev-server including hot module reloading. Note: In this mode you won't be able to use any\nfeatures that depend on Electron, such as loading photos from a local folder.
\n
Behind the Scenes
\n
It's a lot easier than I thought to create a screen saver for Windows — it's just a normal\nexecutable with a .scr extension. The program just needs to display a topmost full-screen window and\nexit on mouse or keyboard activity. These requirements are really easy to meet in Electron!
\n
Note: This project is the bare minimum and won't give you the mini-preview or Settings features.\nThe mini-preview is a pain to implement, and IMO not worth the effort. To support Settings you just\nneed to handle the /S command line argument and display an appropriate UI. (I was too lazy to\nimplement a Settings UI, but you might feel differently!)
\n
Possibilities
\n
This project makes a good starting point for any screen saver you want to create. You could start by\nchanging the Flickr API call to get different types of photos. If photos aren't your cup of tea,\nthere are a lot of cool animations on CodePen and ShaderToy. To get you started, there are four ready-to-run\nanimation components included in this project, each one with a great-looking demo and each one\nillustrating a different basic approach to animation:
\n
\n
DemoCanvas: writes directly to an HTML5 Canvas
\n
DemoCss: uses pure SCSS
\n
DemoShader: implemented as a WebGL fragment shader
\n
DemoThreeJs: uses Three.js to create a 3D animation
\n
\n
At the top of src/app.tsx you'll find the following line of code. Set SHOW_COMPONENT to the\ncomponent you want to see:
You can create your own components using the demos as a template, and using your own code or\nexamples you find on the web. Whatever you use, be sure to comply with the license terms!
mkv (aac audio only. ac3 not, but you can convert to aac)
\n
m4v
\n
ogg (ogv)
\n
mov
\n
mp3
\n
flac
\n
\n
Shortcuts
\n
\n\n
\n
key
\n
action
\n
\n\n\n
\n
l
\n
toggle (show/hide) playlist
\n
\n
\n
f
\n
toggle fullscreen
\n
\n
\n
enter
\n
toggle fullscreen
\n
\n
\n
esc
\n
exit fullscreen
\n
\n
\n
m
\n
toggle mute
\n
\n
\n
up
\n
volume increase
\n
\n
\n
down
\n
volume decrease
\n
\n
\n
left
\n
seek -5 sec
\n
\n
\n
right
\n
seek +5 sec
\n
\n
\n
p
\n
previous video
\n
\n
\n
b
\n
previous video
\n
\n
\n
n
\n
next video
\n
\n
\n
space
\n
toggle play/pause
\n
\n
\n
t
\n
toggle always on top
\n
\n
\n
q
\n
quit
\n
\n\n
\n
Mouse events
\n
\n\n
\n
event
\n
action
\n
\n\n\n
\n
mouse move
\n
show controls (auto hide after 1 sec)
\n
\n
\n
leave cursor on controls box
\n
show controls (still visible)
\n
\n
\n
left doubleclick
\n
toggle fullscreen
\n
\n
\n
scroll up
\n
volume increase
\n
\n
\n
scroll down
\n
volume decrease
\n
\n
\n
left click on progressbar
\n
seek to the point
\n
\n
\n
right click
\n
menu open
\n
\n\n
\n
File/Folder drops
\n
\n\n
\n
place
\n
action
\n
\n\n\n
\n
videoplayer area
\n
clear actual playlist, and refill with the new files
\n
\n
\n
playlist area
\n
append files to the actual playlist
\n
\n\n
\n
The application can read folders also, but just 1 level deep:
\n
\n
\n
.
\n
\n
\n
..
\n
\n
\n
Folder
\n
\n
Folder2\n
\n
file level 3
\n
\n
\n
file level 2
\n
file2 level 2
\n
\n
\n
\n
file level 1
\n
\n
\n
file2 level 1
\n
\n
\n
level 1 and level 2 files will append also to the playlist if you drop in at the same time, but level 3 file in Folder2 won't.
\n
'Sorry bro, no mana..'
\n
The electron (and the original too) Chromium/Chrome currently not support multi audio tracks in html 5 video players, so the language change unavilable yet in multi language videos.. :(
\n
Unfortunately I can't test on MacOS, so if you want better support for Mac, buy me a MacBook.. :D .. Or write to me the problems and deficiency what you found and i'll try to fix it.
\n
Screenshots
\n
\n
\n
\n
\n
\n
\n
\n
\n
Licence
\n
Copyright (c) 2018, Krisztián Kis - Phresh-IT. All rights reserved.
mkv (aac audio only. ac3 not, but you can convert to aac)
\n
m4v
\n
ogg (ogv)
\n
mov
\n
mp3
\n
flac
\n
\n
Shortcuts
\n
\n\n
\n
key
\n
action
\n
\n\n\n
\n
l
\n
toggle (show/hide) playlist
\n
\n
\n
f
\n
toggle fullscreen
\n
\n
\n
enter
\n
toggle fullscreen
\n
\n
\n
esc
\n
exit fullscreen
\n
\n
\n
m
\n
toggle mute
\n
\n
\n
up
\n
volume increase
\n
\n
\n
down
\n
volume decrease
\n
\n
\n
left
\n
seek -5 sec
\n
\n
\n
right
\n
seek +5 sec
\n
\n
\n
p
\n
previous video
\n
\n
\n
b
\n
previous video
\n
\n
\n
n
\n
next video
\n
\n
\n
space
\n
toggle play/pause
\n
\n
\n
t
\n
toggle always on top
\n
\n
\n
q
\n
quit
\n
\n\n
\n
Mouse events
\n
\n\n
\n
event
\n
action
\n
\n\n\n
\n
mouse move
\n
show controls (auto hide after 1 sec)
\n
\n
\n
leave cursor on controls box
\n
show controls (still visible)
\n
\n
\n
left doubleclick
\n
toggle fullscreen
\n
\n
\n
scroll up
\n
volume increase
\n
\n
\n
scroll down
\n
volume decrease
\n
\n
\n
left click on progressbar
\n
seek to the point
\n
\n
\n
right click
\n
menu open
\n
\n\n
\n
File/Folder drops
\n
\n\n
\n
place
\n
action
\n
\n\n\n
\n
videoplayer area
\n
clear actual playlist, and refill with the new files
\n
\n
\n
playlist area
\n
append files to the actual playlist
\n
\n\n
\n
The application can read folders also, but just 1 level deep:
\n
\n
\n
.
\n
\n
\n
..
\n
\n
\n
Folder
\n
\n
Folder2\n
\n
file level 3
\n
\n
\n
file level 2
\n
file2 level 2
\n
\n
\n
\n
file level 1
\n
\n
\n
file2 level 1
\n
\n
\n
level 1 and level 2 files will append also to the playlist if you drop in at the same time, but level 3 file in Folder2 won't.
\n
'Sorry bro, no mana..'
\n
The electron (and the original too) Chromium/Chrome currently not support multi audio tracks in html 5 video players, so the language change unavilable yet in multi language videos.. :(
\n
Unfortunately I can't test on MacOS, so if you want better support for Mac, buy me a MacBook.. :D .. Or write to me the problems and deficiency what you found and i'll try to fix it.
\n
Screenshots
\n
\n
\n
\n
\n
\n
\n
\n
\n
Licence
\n
Copyright (c) 2018, Krisztián Kis - Phresh-IT. All rights reserved.
Simple cross-platform project manager and todo app for single persons (freelancers for example).\nOrganize your ideas, projects, tasks, notes.
\n
\n
Nice, clean, oreview design.
\n
Privacy focus.
\n
From the idea to launch. (project states)
\n
Track your work time each todos and all of project.
\n
Get to-dos out of your head and more focus to the present. Free your mind!
\n
\n
Private sphere
\n
Your data is yours.\nPhreshistant not communicate any clouds. All your data is keep on your machine.\nDon't need internet connection or extrernal accounts.
\n
Features
\n
Choose your workspace folder.
\n
Import/Export database files.
\n
Choose theme (at moment: light, dark, coffee).
\n
Resize views (project and todo columbs).
\n
Project states (order by this sequence)
\n
\n
Processing (running)
\n
Testing (in review)
\n
Freeze (temporary parked. Ex.: don't want work on it for a while, but in the future maybe wants again)
\n
Idea (all new project start in this state)
\n
Notes (It isn't a really state, you can use this for categories other notes. Even separate life things. For example project name is recipes, todo is the recipe title and the todo note is the recipe description)
\n
Stopped (killed project, but you don't want delete )
\n
Finished (you can re-set states from all to all exept Idea)
\n
\n
Project delete is remove all todos and todo notes also!
\n
Todo states (order by this sequence, secondary order is the priority)
\n
\n
Processing (running)
\n
Testing (in review)
\n
Idle (stopped)
\n
Finished (you can re-set states from all to all)
\n
\n
Todos
\n
\n
Home (todos without any project)
\n
Colorize texts on mouse over (for the easy distinction and for fun :D )
\n
You can create one note (simple text or markdown) each todo with \"Edit note\". Use for description, spec, sub-tasks, etc
\n
Set priority (Low, Medium, High)
\n
Search in todos for quick find it (texts and todo notes in all projects)
\n
Time tracking per todo (auto activate in \"Processing\" and \"Testing\" states and show the elapsed time in realtime)
Periodic (trigger every setted time, between 5-600 mins)
\n
Dialy (trigger every day once at time)
\n
Weekly (trigger every week once at time)
\n
Monthly (trigger every month once at time)
\n
Yearly (trigger every year once at time)
\n
\n
Reminder
\n
\n
Set date and time
\n
Set a text you want show on trigger
\n
Choose the type
\n
Alert window on trigger (optional, default false)
\n
Modal window on trigger (optional, default true)
\n
Focus app window on trigger (optional, default true)
\n
Restore todos to Idle state (flexible scheduling)
\n
\n
You can pick up todos for all types of reminders. On trigger the choosed todos (re)set to \"Idle\" state.
\n
Upgrade 1.1.2 Features
\n
\n
Todo note editor toolbar position fixed on scroll also
\n
Views height resize on maximize and restore also
\n
Electron version upgrade to 4.0
\n
\n
Upgrade 1.1.1 Features
\n
\n
Settings added: Toggle show clock
\n
Settings added: Reload app
\n
Themes added: Purple
\n
Themes added: Hello Kitty (pink)
\n
Themes added: Ubuntu glass
\n
Project- Todo list worktime is now divided to hours only (the old style is still divided to days and years, now it shows in popup on the worktime hover)
\n
Project- Todo list state menu added: 'Workprice'\n(The value of the todo(s) price per hour. Add it to the project for set global price to all todos and/or add to a todo for overwrite/add price just for the task.)
\n
Markdown links (links in todo notes text) opens in your default browser from now on. (This is only valid for the new links, if you want to use the old links, please recreate them in your todo notes.)
\n
\n
Screenshots
\n
\n\n\n\n
\n
Licence
\n
Copyright (c) 2018, Krisztián Kis - Phresh-IT. All rights reserved.
Clone or download the repo and navigate in console to the program's root folder.
\n
Install
\n
npm install\n
\n
Run
\n
npm start\n
\n
Packaging (win32 is x86, others x64)
\n
npm run pack-win32\n\nnpm run pack-win\n\nnpm run pack-lin\n\nnpm run pack-mac\n
\n
Packaged zips not required installion, just unzip and run the executeable file.
\n
Build
\n
npm run dist\n
\n
Support
\n
If you like my work(s), please buy me a coffee or support/donate me. Contributions, issues(problems, ideas) and donates are welcome.
\n
Thank you, Have a nice day!
\n
",
+ "readmeOriginal": "
Phreshistant
\n
Simple cross-platform project manager and todo app for single persons (freelancers for example).\nOrganize your ideas, projects, tasks, notes.
\n
\n
Nice, clean, oreview design.
\n
Privacy focus.
\n
From the idea to launch. (project states)
\n
Track your work time each todos and all of project.
\n
Get to-dos out of your head and more focus to the present. Free your mind!
\n
\n
Private sphere
\n
Your data is yours.\nPhreshistant not communicate any clouds. All your data is keep on your machine.\nDon't need internet connection or extrernal accounts.
\n
Features
\n
Choose your workspace folder.
\n
Import/Export database files.
\n
Choose theme (at moment: light, dark, coffee).
\n
Resize views (project and todo columbs).
\n
Project states (order by this sequence)
\n
\n
Processing (running)
\n
Testing (in review)
\n
Freeze (temporary parked. Ex.: don't want work on it for a while, but in the future maybe wants again)
\n
Idea (all new project start in this state)
\n
Notes (It isn't a really state, you can use this for categories other notes. Even separate life things. For example project name is recipes, todo is the recipe title and the todo note is the recipe description)
\n
Stopped (killed project, but you don't want delete )
\n
Finished (you can re-set states from all to all exept Idea)
\n
\n
Project delete is remove all todos and todo notes also!
\n
Todo states (order by this sequence, secondary order is the priority)
\n
\n
Processing (running)
\n
Testing (in review)
\n
Idle (stopped)
\n
Finished (you can re-set states from all to all)
\n
\n
Todos
\n
\n
Home (todos without any project)
\n
Colorize texts on mouse over (for the easy distinction and for fun :D )
\n
You can create one note (simple text or markdown) each todo with \"Edit note\". Use for description, spec, sub-tasks, etc
\n
Set priority (Low, Medium, High)
\n
Search in todos for quick find it (texts and todo notes in all projects)
\n
Time tracking per todo (auto activate in \"Processing\" and \"Testing\" states and show the elapsed time in realtime)
Periodic (trigger every setted time, between 5-600 mins)
\n
Dialy (trigger every day once at time)
\n
Weekly (trigger every week once at time)
\n
Monthly (trigger every month once at time)
\n
Yearly (trigger every year once at time)
\n
\n
Reminder
\n
\n
Set date and time
\n
Set a text you want show on trigger
\n
Choose the type
\n
Alert window on trigger (optional, default false)
\n
Modal window on trigger (optional, default true)
\n
Focus app window on trigger (optional, default true)
\n
Restore todos to Idle state (flexible scheduling)
\n
\n
You can pick up todos for all types of reminders. On trigger the choosed todos (re)set to \"Idle\" state.
\n
Upgrade 1.1.2 Features
\n
\n
Todo note editor toolbar position fixed on scroll also
\n
Views height resize on maximize and restore also
\n
Electron version upgrade to 4.0
\n
\n
Upgrade 1.1.1 Features
\n
\n
Settings added: Toggle show clock
\n
Settings added: Reload app
\n
Themes added: Purple
\n
Themes added: Hello Kitty (pink)
\n
Themes added: Ubuntu glass
\n
Project- Todo list worktime is now divided to hours only (the old style is still divided to days and years, now it shows in popup on the worktime hover)
\n
Project- Todo list state menu added: 'Workprice'\n(The value of the todo(s) price per hour. Add it to the project for set global price to all todos and/or add to a todo for overwrite/add price just for the task.)
\n
Markdown links (links in todo notes text) opens in your default browser from now on. (This is only valid for the new links, if you want to use the old links, please recreate them in your todo notes.)
\n
\n
Screenshots
\n
\n\n\n\n
\n
Licence
\n
Copyright (c) 2018, Krisztián Kis - Phresh-IT. All rights reserved.
PineSQL is Electron-based SQL manager, which can help you manage your MySQL database, execute remote code, and use constructor to build requests (coming soon).
Use npm i and wait until package installation ends
\n
Finally, execute npm start.
\n\n
",
+ "readmeOriginal": "
PineSQL
\n
PineSQL is Electron-based SQL manager, which can help you manage your MySQL database, execute remote code, and use constructor to build requests (coming soon).
The way we get things done is often project-oriented. However, the files, applications, tasklists, etc. are scattered everywhere. Pile is a place for you to put them all together.
\n
Usage
\n
Before we get started, let me help you get it more clear how to use Pile.
\n
Board
\n
A board (or tab) is a place to hold all the resources of your project or workspace. You can organize your things related to the project/workspace using hubs.
\n
Hub
\n
A hub (or card) is an area for specific stuff. There are currently three kinds of hubs:
\n
App/File
\n
You can add apps or files you may use in this area so that you can quickly access them and open them.
\n
\n \n
\n
Notes
\n
Online resources (often appeared as links) or your thoughts can be taken down here. Markdown is supported! 🎉
# install dependencies\nyarn # or npm install\n\n# serve with hot reload at localhost:9080\nyarn run dev # or npm run dev\n\n# build electron application for production\nyarn run build:dir # or npm run build:dir\n
\n\n
Changelog
\n
Detailed changes for each release are documented in the CHANGELOG.md
The way we get things done is often project-oriented. However, the files, applications, tasklists, etc. are scattered everywhere. Pile is a place for you to put them all together.
\n
Usage
\n
Before we get started, let me help you get it more clear how to use Pile.
\n
Board
\n
A board (or tab) is a place to hold all the resources of your project or workspace. You can organize your things related to the project/workspace using hubs.
\n
Hub
\n
A hub (or card) is an area for specific stuff. There are currently three kinds of hubs:
\n
App/File
\n
You can add apps or files you may use in this area so that you can quickly access them and open them.
\n
\n \n
\n
Notes
\n
Online resources (often appeared as links) or your thoughts can be taken down here. Markdown is supported! 🎉
# install dependencies\nyarn # or npm install\n\n# serve with hot reload at localhost:9080\nyarn run dev # or npm run dev\n\n# build electron application for production\nyarn run build:dir # or npm run build:dir\n
\n\n
Changelog
\n
Detailed changes for each release are documented in the CHANGELOG.md
You need to enter your IPTV provider's details to Settings. When you save, if your authentication works, you will directly see the channel lists on the left side. Select a channel and it will begin shorty.
\n
\n
\n
Future Work
\n
\n
UI work will be done
\n
Need to check Linux HWAccels
\n
\n
Contributing
\n
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
\n
This project is in early phase. If you want to change any function, feel free to do. You could refactor, propose architecture changes, design assets, add new features, provide CI/CD things and build for other platforms. Basically, all changes that can improve this software are welcome.
You need to enter your IPTV provider's details to Settings. When you save, if your authentication works, you will directly see the channel lists on the left side. Select a channel and it will begin shorty.
\n
\n
\n
Future Work
\n
\n
UI work will be done
\n
Need to check Linux HWAccels
\n
\n
Contributing
\n
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
\n
This project is in early phase. If you want to change any function, feel free to do. You could refactor, propose architecture changes, design assets, add new features, provide CI/CD things and build for other platforms. Basically, all changes that can improve this software are welcome.
Currently, PiQture supports Windows and Linux x64, but you can build app using any Electron packaging tool for your platform.\nPiQture doesn't require installation, just run piqture.exe file and you're done!
\n
URL Handler
\n
By default, PiQture handle \"piqture://\" url's. If you try to visit this url in browser, PiQture will open up in windowed mode.
\n
Global shortcut
\n
PiQture will take Ctrl(Cmd)+Alt+S shortcut to take quick screenshots. Even if PiQture is minimized to tray, this shortcut will work.
\n
License
\n
MIT
\n
",
+ "readmeOriginal": "
PiQture
\n
\n
PiQture is Electron-based screenshot tool, which allows you to use global shortcuts, cross-platform usage and high-quality capture
\n
\n
Now open-source
\n
Now, PiQture is available for everyone. Everyone can review and edit the code. Let's make PiQture better!
\n
PiQture uses a number of open source projects to work properly:
Currently, PiQture supports Windows and Linux x64, but you can build app using any Electron packaging tool for your platform.\nPiQture doesn't require installation, just run piqture.exe file and you're done!
\n
URL Handler
\n
By default, PiQture handle \"piqture://\" url's. If you try to visit this url in browser, PiQture will open up in windowed mode.
\n
Global shortcut
\n
PiQture will take Ctrl(Cmd)+Alt+S shortcut to take quick screenshots. Even if PiQture is minimized to tray, this shortcut will work.
A small and compact 8 bit style weather widget designed for your desktop.
\n
Features
\n
\n
It's transparent background allows it to blend in with your current setup
\n
Always stays on your desktop so it won't get in your way. This means it's hidden when you switch windows with alt+tab
\n
Switch between dark mode and light mode, for lighter and darker backgrounds respectively.
\n
Clean interface, with no clutter, all options can be accessed by right clicking.
\n
\n
How to use
\n
\n
Install the package.
\n
Sign up and get your API key from the Dark Sky console.
\n
When you open the app for the first time, a settings menu pops up, paste your API key there.
\n
You can also change how often the weather is updated.
\n
After submitting the settings, right click, refresh and wait for the weather to update.
\n
You can choose where to place the widget by choosing from the Position menu.
\n
The menu can be accessed by right clicking anywhere on the widget.
\n
\n
Known Issues
\n
\n
Sometimes on startup, the background becomes black, instead of transparent. This can be resolved by closing and restarting the application.
\n
The widget can be built for Windows, but the application won't stick to your desktop. This is because the desktop window type in electron only works on X11 and Linux systems.
\n
Sometimes the widget takes too long to load the weather, in that case check your internet connection, and try refreshing a couple of times.
\n
\n
To uninstall
\n
Run this in the terminal
\n
sudo apt-get remove pixelweather\n
\n
Other cool things I made
\n
\n
Dusk Player: A minimalistic music player, designed for simplicity.
A small and compact 8 bit style weather widget designed for your desktop.
\n
Features
\n
\n
It's transparent background allows it to blend in with your current setup
\n
Always stays on your desktop so it won't get in your way. This means it's hidden when you switch windows with alt+tab
\n
Switch between dark mode and light mode, for lighter and darker backgrounds respectively.
\n
Clean interface, with no clutter, all options can be accessed by right clicking.
\n
\n
How to use
\n
\n
Install the package.
\n
Sign up and get your API key from the Dark Sky console.
\n
When you open the app for the first time, a settings menu pops up, paste your API key there.
\n
You can also change how often the weather is updated.
\n
After submitting the settings, right click, refresh and wait for the weather to update.
\n
You can choose where to place the widget by choosing from the Position menu.
\n
The menu can be accessed by right clicking anywhere on the widget.
\n
\n
Known Issues
\n
\n
Sometimes on startup, the background becomes black, instead of transparent. This can be resolved by closing and restarting the application.
\n
The widget can be built for Windows, but the application won't stick to your desktop. This is because the desktop window type in electron only works on X11 and Linux systems.
\n
Sometimes the widget takes too long to load the weather, in that case check your internet connection, and try refreshing a couple of times.
\n
\n
To uninstall
\n
Run this in the terminal
\n
sudo apt-get remove pixelweather\n
\n
Other cool things I made
\n
\n
Dusk Player: A minimalistic music player, designed for simplicity.
Desktop client for Playcode Online Javascript Editor
\n
\n \n \n
Screenshots
\n
\n
Development
\n
$ git clone https://github.com/playcode/playcode-desktop.git\n$ cd Playcode-desktop\n$ npm install\n$ npm start\n$ npm run dist\n
\n
License
\n
This program is free software: you can redistribute it and/or modify\nit under the terms of the GNU General Public License as published by\nthe Free Software Foundation, either version 3 of the License, or\n(at your option) any later version.
\n
This program is distributed in the hope that it will be useful,\nbut WITHOUT ANY WARRANTY; without even the implied warranty of\nMERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\nGNU General Public License for more details.
\n
You should have received a copy of the GNU General Public License\nalong with this program. If not, see http://www.gnu.org/licenses/.
\n
",
+ "readmeOriginal": "
\n
\n
Playcode
\n
\n
Desktop client for Playcode Online Javascript Editor
\n
\n \n \n
Screenshots
\n
\n
Development
\n
$ git clone https://github.com/playcode/playcode-desktop.git\n$ cd Playcode-desktop\n$ npm install\n$ npm start\n$ npm run dist\n
\n
License
\n
This program is free software: you can redistribute it and/or modify\nit under the terms of the GNU General Public License as published by\nthe Free Software Foundation, either version 3 of the License, or\n(at your option) any later version.
\n
This program is distributed in the hope that it will be useful,\nbut WITHOUT ANY WARRANTY; without even the implied warranty of\nMERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\nGNU General Public License for more details.
\n
You should have received a copy of the GNU General Public License\nalong with this program. If not, see http://www.gnu.org/licenses/.
Requer a descoberta da rede para compartilhar com o chromecast. Lembre-se de habilitar o modo visitante do Chromecast para deixá-lo público na sua rede wifi e poder compartilhar através do PC / Mac / Laptop.
\n
\n
\n
Sobre os formatos de vídeo e as legendas
\n\n
Nessa primeira versão, são suportados vídeos mp4 e legendas srt.\nO aplicativo converte as legendas srt em vtt enquanto faz o carregamento do vídeo.\nPara carregar as legendas corretamente, lembre-se de que o arquivo de legenda deve ter o mesmo nome do arquivo de vídeo\ne deve estar no mesmo diretório.
\n
Controles do vídeo com o mouse e o teclado
\n\n
\n
No teclado:
\n
\n
\n
ctrl + l => [LOAD] Abre a tela para selecionar os vídeos
\n
ctrl + p or ctrl + space-bar => Play/Pause
\n
ctrl + m => [MENU] Abre o menu com a lista de vídeos carregados com as opções para acrescentar mais filmes.
\n
ctrl + u => [UNSOUND] Alterna entre Mudo e com Áudio
\n
ctrl+ f => [FULLSCREEN] Entra e sai do modo de Tela cheia
\n
ctrl + q => [QUIT] Fecha o aplicativo
\n
\n
Instruções
\n\n
\n
Requer o módulo nativo do mdns
\n
\n
Na raiz do projeto...\nPrimeiro execute:
\n
\n
sudo npm install ( É necessário usar o sudo aqui porque o Node faz o rebuild do node-gyp e precisa de permissão de root )
\n
\n
Baixa todas as dependências do projeto.
\n
Depois, execute:
\n
\n
npm start
\n
\n
Inicia a aplicação electron
\n
Sobre o módulo mdns( Esse módulo é necessário, porque é utilizado para fazer a comunicação com o chromecast.)
\n
Na raiz do projeto...
\n
\n
Se você não tiver o mdns pode ter alguns erros. Nesse caso, resolva-os assim:
\n
\n
No linux, instale o mdns com:
\n
\n
sudo npm run ubuntu-mdns && sudo npm run dependecy-ubuntu
\n
\n
SE aparecem erros de permissão EACCES, faça isso:
\n
\n
sudo npm run permission
\n
\n
Para gerar o executável para Macos:
\n
\n
npm run pack-osx
\n
\n\n
Para as ditribuições linux (.deb), siga esses passos:
\n
\n
npm run pack-linux64 ( Gera o executável e dá permissão de escrita no diretório criado.Sua senha pode ser solicitada. )\nnpm run install-deb64 ( Com executável gerado, faz a criação de diretório na Home do usuário e aloca os arquivos, registrando um atalho na lista de programas instalados )
\n
\n\n
Para gerar o executável para windows:
\n
\n
npm run pack-win64 ( A versão para windows ainda não foi testada. Ajudem-me a testar! )
Requer a descoberta da rede para compartilhar com o chromecast. Lembre-se de habilitar o modo visitante do Chromecast para deixá-lo público na sua rede wifi e poder compartilhar através do PC / Mac / Laptop.
\n
\n
\n
Sobre os formatos de vídeo e as legendas
\n\n
Nessa primeira versão, são suportados vídeos mp4 e legendas srt.\nO aplicativo converte as legendas srt em vtt enquanto faz o carregamento do vídeo.\nPara carregar as legendas corretamente, lembre-se de que o arquivo de legenda deve ter o mesmo nome do arquivo de vídeo\ne deve estar no mesmo diretório.
\n
Controles do vídeo com o mouse e o teclado
\n\n
\n
No teclado:
\n
\n
\n
ctrl + l => [LOAD] Abre a tela para selecionar os vídeos
\n
ctrl + p or ctrl + space-bar => Play/Pause
\n
ctrl + m => [MENU] Abre o menu com a lista de vídeos carregados com as opções para acrescentar mais filmes.
\n
ctrl + u => [UNSOUND] Alterna entre Mudo e com Áudio
\n
ctrl+ f => [FULLSCREEN] Entra e sai do modo de Tela cheia
\n
ctrl + q => [QUIT] Fecha o aplicativo
\n
\n
Instruções
\n\n
\n
Requer o módulo nativo do mdns
\n
\n
Na raiz do projeto...\nPrimeiro execute:
\n
\n
sudo npm install ( É necessário usar o sudo aqui porque o Node faz o rebuild do node-gyp e precisa de permissão de root )
\n
\n
Baixa todas as dependências do projeto.
\n
Depois, execute:
\n
\n
npm start
\n
\n
Inicia a aplicação electron
\n
Sobre o módulo mdns( Esse módulo é necessário, porque é utilizado para fazer a comunicação com o chromecast.)
\n
Na raiz do projeto...
\n
\n
Se você não tiver o mdns pode ter alguns erros. Nesse caso, resolva-os assim:
\n
\n
No linux, instale o mdns com:
\n
\n
sudo npm run ubuntu-mdns && sudo npm run dependecy-ubuntu
\n
\n
SE aparecem erros de permissão EACCES, faça isso:
\n
\n
sudo npm run permission
\n
\n
Para gerar o executável para Macos:
\n
\n
npm run pack-osx
\n
\n\n
Para as ditribuições linux (.deb), siga esses passos:
\n
\n
npm run pack-linux64 ( Gera o executável e dá permissão de escrita no diretório criado.Sua senha pode ser solicitada. )\nnpm run install-deb64 ( Com executável gerado, faz a criação de diretório na Home do usuário e aloca os arquivos, registrando um atalho na lista de programas instalados )
\n
\n\n
Para gerar o executável para windows:
\n
\n
npm run pack-win64 ( A versão para windows ainda não foi testada. Ajudem-me a testar! )
PlayMe is an unofficial YouTube Music desktop app with some additional tweaks on top.
\n
Why? So that you can enjoy your YouTube Music on desktop, without having to worry about the browser tab which plays it.
\n
How does it work?
\n
It's a basic Electron WebView with Youtube Music. on top of that, additional system functionalities were added. The idea is not to use the Youtube API, but instead, to re-use the original youtube music functionality.
\n
Features:
\n
\n
Handle Media Keys: Play/Pause, Next, Previous
\n
Responsive Window
\n
\n
\n
Install:
\n
macOS 10.9+, Linux, and Windows 7+ are supported
\n
Download the latest version on the website or below.
display system tray icon & allow basic controls from there
\n
display current song & current playlist in system tray
\n
display notification on song changed (if window not visible)
\n
seek while holding forward/backward media controls button
\n
implement preferences
\n
start on launch
\n
customizable global shortcuts
\n
set up automatic updates delivery
\n
create a landing page
\n
suggestions?
\n
\n
Contributing:
\n
Thank you for deciding to contribute! In order to keep it clean & mainainable long term, we'd prefer to follow some good git practices.
\n\n
Fork the repo
\n
Create a local brach off develop (usually) named as following: issue-number/1-3-keywords
\n
Make the changes
\n
Follow the for your commit title(s).
\n
Rebase & clean up commit history (or leave it as it is, but we'll squash & merge)
\n
Push the branch to your own fork
\n
Create a Pull Request from your fork to this repo
\n
Name the PR using the message used in commit, which follows the Commit Guidelines
\n\n
",
+ "readmeOriginal": "
\n
PlayMe is an unofficial YouTube Music desktop app with some additional tweaks on top.
\n
Why? So that you can enjoy your YouTube Music on desktop, without having to worry about the browser tab which plays it.
\n
How does it work?
\n
It's a basic Electron WebView with Youtube Music. on top of that, additional system functionalities were added. The idea is not to use the Youtube API, but instead, to re-use the original youtube music functionality.
\n
Features:
\n
\n
Handle Media Keys: Play/Pause, Next, Previous
\n
Responsive Window
\n
\n
\n
Install:
\n
macOS 10.9+, Linux, and Windows 7+ are supported
\n
Download the latest version on the website or below.
AppImages can be downloaded and run without installation or the need for root rights.
\n
\n
\n
The key idea of the AppImage format is one app = one file. Every AppImage contains an app and all the files the app needs to run. In other words, each AppImage has no dependencies other than what is included in the targeted base operating system(s).
AppImages can be downloaded and run without installation or the need for root rights.
\n
\n
\n
The key idea of the AppImage format is one app = one file. Every AppImage contains an app and all the files the app needs to run. In other words, each AppImage has no dependencies other than what is included in the targeted base operating system(s).
Does it sound familiar? - then this app will be useful for you!\"
\n
A friendly poker party in da' house, a bit drinking, talking, laughing, etc.\nSometimes I forgot about I'm the one of the blinds.. and you?
\n
Features
\n
\n
Save tokens
\n
Save players
\n
Setup the match (select 2-10 players, 5 tokens, blindlift type and time, etc)
\n
track rebuys (optional), tokens (at start and rebuy value), blind values and blindlift time, real bets (optional)
\n
\n
Blindlift types
\n
\n
Fix (Fix on the two smallest value token and not lift it) - for slower games
\n
Gradual (the next small blind is always the previous big blind) - for normal games
\n
Token pairs (the next small blind is the next value token after previous big blind, and after the highest token double the values of blinds) - for faster games
\n
\n
Screenshots
\n
\n\n\n\n\n\n
\n
Licence
\n
Copyright (c) 2018, Krisztián Kis - Phresh-IT. All rights reserved.
Clone or download the repo and navigate in console to the program's root folder.
\n
Install
\n
npm install\n
\n
Run
\n
npm start\n
\n
Packaging (win32 is x86, others x64)
\n
npm run pack-win32\n\nnpm run pack-win\n\nnpm run pack-lin\n\nnpm run pack-mac\n
\n
Packaged zips not required installion, just unzip and run the executeable file.
\n
Support
\n
If you like my work(s), please buy me a coffee or support/donate me. Contributions, issues(problems, ideas) and donates are welcome.
\n
Thank you, Have a nice day!
\n
",
+ "readmeOriginal": "
Phresh Poker Clock
\n
Short story
\n
\n
Who deals?
\n
Am I the blind?\"
\n
\n
Does it sound familiar? - then this app will be useful for you!\"
\n
A friendly poker party in da' house, a bit drinking, talking, laughing, etc.\nSometimes I forgot about I'm the one of the blinds.. and you?
\n
Features
\n
\n
Save tokens
\n
Save players
\n
Setup the match (select 2-10 players, 5 tokens, blindlift type and time, etc)
\n
track rebuys (optional), tokens (at start and rebuy value), blind values and blindlift time, real bets (optional)
\n
\n
Blindlift types
\n
\n
Fix (Fix on the two smallest value token and not lift it) - for slower games
\n
Gradual (the next small blind is always the previous big blind) - for normal games
\n
Token pairs (the next small blind is the next value token after previous big blind, and after the highest token double the values of blinds) - for faster games
\n
\n
Screenshots
\n
\n\n\n\n\n\n
\n
Licence
\n
Copyright (c) 2018, Krisztián Kis - Phresh-IT. All rights reserved.
Polar is personal knowledge repository which supports advanced\nfeatures like incremental reading, annotation, comments, and spaced repetition.\nIt supports reading PDF, EPUB, and the web content.
\n
\n
Features
\n
\n
\n
PDF support We have first-class PDF support thanks to PDF.js. PDFs work well when reading content in book format or when reading scientific\nresearch which is often stored as PDF.
\n
\n
\n
EPUB support Add any EPUB and we also capture web content to EPUB/
\n
\n
\n
Captured Web Pages Download HTML content and save them as offline documents which can be annotated.
\n
\n
\n
Pagemarks Easily keep track of what you're reading and the progress of each document.
\n
\n
\n
Text Highlights Highlight text in PDF and web pages.
\n
\n
\n
Area Highlights Capture a region of the page as a highlight which can be a chart, figure, infographic, etc.
\n
\n
\n
Portable Run across any platform. Linux, MacOS, and Windows supported.
Polar is personal knowledge repository which supports advanced\nfeatures like incremental reading, annotation, comments, and spaced repetition.\nIt supports reading PDF, EPUB, and the web content.
\n
\n
Features
\n
\n
\n
PDF support We have first-class PDF support thanks to PDF.js. PDFs work well when reading content in book format or when reading scientific\nresearch which is often stored as PDF.
\n
\n
\n
EPUB support Add any EPUB and we also capture web content to EPUB/
\n
\n
\n
Captured Web Pages Download HTML content and save them as offline documents which can be annotated.
\n
\n
\n
Pagemarks Easily keep track of what you're reading and the progress of each document.
\n
\n
\n
Text Highlights Highlight text in PDF and web pages.
\n
\n
\n
Area Highlights Capture a region of the page as a highlight which can be a chart, figure, infographic, etc.
\n
\n
\n
Portable Run across any platform. Linux, MacOS, and Windows supported.
To clone and run this application, you'll need Git and Node.js (which comes with npm) installed on your computer. From your command line:
\n
# Clone this repository\n$ git clone https://github.com/amitmerchant1990/pomolectron\n\n# Go into the repository\n$ cd pomolectron\n\n# Install dependencies\n$ npm install\n\n# Run the app\n$ npm start
To clone and run this application, you'll need Git and Node.js (which comes with npm) installed on your computer. From your command line:
\n
# Clone this repository\n$ git clone https://github.com/amitmerchant1990/pomolectron\n\n# Go into the repository\n$ cd pomolectron\n\n# Install dependencies\n$ npm install\n\n# Run the app\n$ npm start
Pomotroid is a simple and configurable Pomodoro timer. It aims to provide a visually-pleasing and reliable way to track productivity using the Pomodoro Technique.
\n
Pomotroid is in its early stages, so feedback and contributions are welcome and appreciated! 🌱
\n
Features
\n
\n
Customize times and number of rounds (persistent)
\n
Charming timer alert sounds (optional)
\n
Desktop notifications (optional)
\n
Minimize to tray (optional)
\n
Several themes included with the ability to create custom themes.
\n
Timer activity logging.
\n
\n
Themes
\n
Pomotroid provides many themes. It's also theme-able, allowing you to customize its appearance.
\n
\n
Visit the theme documentation to view the full list of official themes and for instruction on creating your own.
\n
Install
\n
Download
\n
Download the latest version from the releases page.
\n
Pomotroid is available for Windows, Mac OSX and Linux.
\n
Homebrew
\n
You can also install Pomotroid on macOS with Homebrew:
Note: depending on your OS settings, you may receive a security warning upon installation. This has to do with Pomotroid being an unsigned application. You can find out more by researching code-signing for Apple and Microsoft.
\n
Build Setup
\n
# install dependencies\nnpm i\n\n# serve with hot reload at localhost:9080\nnpm run dev\n\n# build Pomotroid for production\nnpm run build
Pomotroid is a simple and configurable Pomodoro timer. It aims to provide a visually-pleasing and reliable way to track productivity using the Pomodoro Technique.
\n
Pomotroid is in its early stages, so feedback and contributions are welcome and appreciated! 🌱
\n
Features
\n
\n
Customize times and number of rounds (persistent)
\n
Charming timer alert sounds (optional)
\n
Desktop notifications (optional)
\n
Minimize to tray (optional)
\n
Several themes included with the ability to create custom themes.
\n
Timer activity logging.
\n
\n
Themes
\n
Pomotroid provides many themes. It's also theme-able, allowing you to customize its appearance.
\n
\n
Visit the theme documentation to view the full list of official themes and for instruction on creating your own.
\n
Install
\n
Download
\n
Download the latest version from the releases page.
\n
Pomotroid is available for Windows, Mac OSX and Linux.
\n
Homebrew
\n
You can also install Pomotroid on macOS with Homebrew:
Note: depending on your OS settings, you may receive a security warning upon installation. This has to do with Pomotroid being an unsigned application. You can find out more by researching code-signing for Apple and Microsoft.
\n
Build Setup
\n
# install dependencies\nnpm i\n\n# serve with hot reload at localhost:9080\nnpm run dev\n\n# build Pomotroid for production\nnpm run build
Collect and visualize your desktop working activities, i.e., the names and titles of the using apps, locally
\n
Use integrated Kanban Board to make your schedule control easier
\n
Analyse your efficiency
\n
\n
Pomodoro Technique 🍅
\n
The working loop in the Pomodoro Technique is split into a 25-minute focus session and a 5-minute rest session. During a work session, the user focuses on one todo item and should not do anything irrelevant. The Pomodoro Technique can greatly improve the efficiency of work and study and alleviate work fatigue.
\n
In the Pomodoro Logger, the app will record the names and titles of the apps you use on your PC during the working sessions. The titles of apps contain rich semantic information. For example, the browser title includes the title of the website being viewed, and the IDE often provides the project path or project name.
By connecting your todo items with the corresponding recorded Pomodoro sessions, you can analyze how often you are interrupted by email and social software, the time distribution of the application and application title used to complete the task. It will help you have a more comprehensive understanding of your working hours on PC.
\n
Efficiency Analysis
\n
Pomodoro Logger keeps a list of distracting app (you can config it in the setting). When it detect your using distracting apps, you lose your efficiency.
Demonstrating your efficiency by the dots. The larger the hole, the less efficient you are.
\n
\n
You can view the record in detail by clicking the circle
\n
\n \n\n
Data 📈
\n
Pomodoro Logger records your desktop activities when you are in a working session of Pomodoro.
\n
It only records your application activities, including the name and title of the focused application.
\n
You can import / export / delete all your data in the settings.
\n
All the data is saved and processed locally.
\n
Kanban Board
\n
Pomodoro Logger has integrated Kanban Board to help you organize and estimate the time spent of your todos easily with confidence.
\n
The lists in Kanban are divided into Todo, In Progress, and Done. Though lists customization is possible, you are required to preserve In Progress list and Done list in order to track, estimate and analyze your project time spent. You can set the estimated time cost on each todo card. Pomodoro Logger will assist you with the corresponding actual time spent record. i.e., When you are focusing on a Kanban board, it will automatically associate your Pomodoro session with the todo cards of In Progress list in the Kanban, which makes further analysis possible.
\n
To make the statistics more accurate, you can keep the cards of the In Progress list as few as possible to precisely reflect the tasks you are focusing on.
Collect and visualize your desktop working activities, i.e., the names and titles of the using apps, locally
\n
Use integrated Kanban Board to make your schedule control easier
\n
Analyse your efficiency
\n
\n
Pomodoro Technique 🍅
\n
The working loop in the Pomodoro Technique is split into a 25-minute focus session and a 5-minute rest session. During a work session, the user focuses on one todo item and should not do anything irrelevant. The Pomodoro Technique can greatly improve the efficiency of work and study and alleviate work fatigue.
\n
In the Pomodoro Logger, the app will record the names and titles of the apps you use on your PC during the working sessions. The titles of apps contain rich semantic information. For example, the browser title includes the title of the website being viewed, and the IDE often provides the project path or project name.
By connecting your todo items with the corresponding recorded Pomodoro sessions, you can analyze how often you are interrupted by email and social software, the time distribution of the application and application title used to complete the task. It will help you have a more comprehensive understanding of your working hours on PC.
\n
Efficiency Analysis
\n
Pomodoro Logger keeps a list of distracting app (you can config it in the setting). When it detect your using distracting apps, you lose your efficiency.
Demonstrating your efficiency by the dots. The larger the hole, the less efficient you are.
\n
\n
You can view the record in detail by clicking the circle
\n
\n \n\n
Data 📈
\n
Pomodoro Logger records your desktop activities when you are in a working session of Pomodoro.
\n
It only records your application activities, including the name and title of the focused application.
\n
You can import / export / delete all your data in the settings.
\n
All the data is saved and processed locally.
\n
Kanban Board
\n
Pomodoro Logger has integrated Kanban Board to help you organize and estimate the time spent of your todos easily with confidence.
\n
The lists in Kanban are divided into Todo, In Progress, and Done. Though lists customization is possible, you are required to preserve In Progress list and Done list in order to track, estimate and analyze your project time spent. You can set the estimated time cost on each todo card. Pomodoro Logger will assist you with the corresponding actual time spent record. i.e., When you are focusing on a Kanban board, it will automatically associate your Pomodoro session with the todo cards of In Progress list in the Kanban, which makes further analysis possible.
\n
To make the statistics more accurate, you can keep the cards of the In Progress list as few as possible to precisely reflect the tasks you are focusing on.
PreMiD is a simple, configurable utility that allows you to show what you're doing on the web in your Discord now playing status. It supports many different websites, and will support multiple users watching the same content simultaneously in an upcoming update.
\n
Features
\n
· Displays your current web service in Discord as your status. \n· Grants full control over Presences. \n· Supports over 800 web services, still rising! \n· Watch parties and more are coming soon!
\n
Installation/Troubleshooting
\n
Installation instructions, Troubleshooting guides etc. can be located at our docs.
PreMiD is a simple, configurable utility that allows you to show what you're doing on the web in your Discord now playing status. It supports many different websites, and will support multiple users watching the same content simultaneously in an upcoming update.
\n
Features
\n
· Displays your current web service in Discord as your status. \n· Grants full control over Presences. \n· Supports over 800 web services, still rising! \n· Watch parties and more are coming soon!
\n
Installation/Troubleshooting
\n
Installation instructions, Troubleshooting guides etc. can be located at our docs.
Your donations will help to publish to app stores, more frequent releases, faster feature requests implementation.\nPostbird at opencollective: https://opencollective.com/postbird
\n
Contributors
\n
This project exists thanks to all the people who contribute. [Contribute].\n
Your donations will help to publish to app stores, more frequent releases, faster feature requests implementation.\nPostbird at opencollective: https://opencollective.com/postbird
\n
Contributors
\n
This project exists thanks to all the people who contribute. [Contribute].\n
Our planet is a beautiful place. The Google Chrome Earth View extension by Google is a wonderful way to deliver stunning satellite images to us every time we open a new tab, inspiring us on our next web adventure. But why stop there? Why don't get impressed by these the wonders of the earth as well when gazing at this more important rectangle on our screen, our wallpaper. PrettyEarth now grants you the opportunity to bring our blue marble to your desktop.
Our planet is a beautiful place. The Google Chrome Earth View extension by Google is a wonderful way to deliver stunning satellite images to us every time we open a new tab, inspiring us on our next web adventure. But why stop there? Why don't get impressed by these the wonders of the earth as well when gazing at this more important rectangle on our screen, our wallpaper. PrettyEarth now grants you the opportunity to bring our blue marble to your desktop.
Pretzel is Mac desktop app that shows and search keyboard shortcuts based on your current app. Checkout the landing page here.
\n
Features
\n
\n
🔍 In-App quick search: Find your specific shortcut with quick search among hundreds.
\n
⚡ Detects the currently focused app.
\n
🐠 Little distraction from your current task. Clicking on the menubar icon or hit CmdorCtrl + (backtick) on keyboard will automatically opens the shortcut panel.
Because Pretzel has a dependency node-ffi that requires node v8, until node-ffi is compaitable with\nlatest node, you should use nvm to install node v8 to run Pretzel locally. Otherwise, npm install would give you some error regarding node-gyp.
\n
nvm install 8.11.3 # I personally use this version\nnvm ls # to make sure we are currently using node v8\n\nnpm install\nnpm start\n
Pretzel is Mac desktop app that shows and search keyboard shortcuts based on your current app. Checkout the landing page here.
\n
Features
\n
\n
🔍 In-App quick search: Find your specific shortcut with quick search among hundreds.
\n
⚡ Detects the currently focused app.
\n
🐠 Little distraction from your current task. Clicking on the menubar icon or hit CmdorCtrl + (backtick) on keyboard will automatically opens the shortcut panel.
Because Pretzel has a dependency node-ffi that requires node v8, until node-ffi is compaitable with\nlatest node, you should use nvm to install node v8 to run Pretzel locally. Otherwise, npm install would give you some error regarding node-gyp.
\n
nvm install 8.11.3 # I personally use this version\nnvm ls # to make sure we are currently using node v8\n\nnpm install\nnpm start\n
After the image is calculated you have 2 options to save the result:
\n\n
The first one which is selected by default is to save the generated image directly as an image file (option Raster image) - for this after calculating a \"Save as\" dialog shows up in which you can select the name and folder of the file
\n
Alternatively you can choose the option \"vector image\" and then copy&paste the image date from primitive.nextgen into a file with the ending .svg (eg. via Notepad++ or another text editor). Then open the .svg file in eg. inkscape, make some edits if you want and save the result as an image file with the ending .jpg, .png or any other format
\n\n
Hint: According to issue #2 there seem to occur problems on OS X devices with the first option, so please use the second option then.
After the image is calculated you have 2 options to save the result:
\n\n
The first one which is selected by default is to save the generated image directly as an image file (option Raster image) - for this after calculating a \"Save as\" dialog shows up in which you can select the name and folder of the file
\n
Alternatively you can choose the option \"vector image\" and then copy&paste the image date from primitive.nextgen into a file with the ending .svg (eg. via Notepad++ or another text editor). Then open the .svg file in eg. inkscape, make some edits if you want and save the result as an image file with the ending .jpg, .png or any other format
\n\n
Hint: According to issue #2 there seem to occur problems on OS X devices with the first option, so please use the second option then.
Register your .proto files to enable protobuf-related features. Right click on the collection, select 'Manage .proto files' to register the file paths.
\n\n
\n
\n\n
\n
The rest of the request-building interface is similar to Postman.
\n
a. Enter your good old http request parameters (method, url, headers)
\n
b. Select request/response proto messages you want.
\n
c. Fill out the fields in your request proto message.
\n
d. Click send.
\n
e. The response is shown below the request section.
\n
\n\n
\n\n
As of version 0.2.0, you can also set up environments, and reuse variables there throughout your requests on the top-right corner!
\n\n
\n
\n\n
As of version 0.3.0, you can also import / export collections as JSON
\n\n
\n
When importing a collection, all the proto definitions / path to .proto files are also imported. Hence, it's recommended to fix the paths to keep the proto definitions up-to-date.
\n
Note that it's not compatible with Postman collections.
\n
\n\n
\n
As of version 0.4.0, you can also reorder requests / set different expected messages for success(2XX) and failures(others)
\n
\n
\n
That's it for the current version. Enjoy and leave a star if you like it !
As a fallback, you can clone the repo and run npm install && npm run build to build, and npm run start to launch the app. Or, you can actually find configurations on electron builder to get the right distribution version yourself!
\n
Contributing
\n
If you are interested in reporting/fixing issues and contributing directly to the codebase, follow the standard procedures.
\n\n
Create an issue.
\n
Fork the repo.
\n
Submit a PR.
\n
We'll get back to you as soon as we can!
\n\n
Make sure to run npm run lint before submitting your PR!
Register your .proto files to enable protobuf-related features. Right click on the collection, select 'Manage .proto files' to register the file paths.
\n\n
\n
\n\n
\n
The rest of the request-building interface is similar to Postman.
\n
a. Enter your good old http request parameters (method, url, headers)
\n
b. Select request/response proto messages you want.
\n
c. Fill out the fields in your request proto message.
\n
d. Click send.
\n
e. The response is shown below the request section.
\n
\n\n
\n\n
As of version 0.2.0, you can also set up environments, and reuse variables there throughout your requests on the top-right corner!
\n\n
\n
\n\n
As of version 0.3.0, you can also import / export collections as JSON
\n\n
\n
When importing a collection, all the proto definitions / path to .proto files are also imported. Hence, it's recommended to fix the paths to keep the proto definitions up-to-date.
\n
Note that it's not compatible with Postman collections.
\n
\n\n
\n
As of version 0.4.0, you can also reorder requests / set different expected messages for success(2XX) and failures(others)
\n
\n
\n
That's it for the current version. Enjoy and leave a star if you like it !
As a fallback, you can clone the repo and run npm install && npm run build to build, and npm run start to launch the app. Or, you can actually find configurations on electron builder to get the right distribution version yourself!
\n
Contributing
\n
If you are interested in reporting/fixing issues and contributing directly to the codebase, follow the standard procedures.
\n\n
Create an issue.
\n
Fork the repo.
\n
Submit a PR.
\n
We'll get back to you as soon as we can!
\n\n
Make sure to run npm run lint before submitting your PR!
Pullp is a tool to help you manage pull requests and reviews on your Github repositories, available for Mac, Linux and Windows.
\n
An interactive dashboard shows all the open pull requests for your chosen repositories and highlights where your review has been requested. This information syncs with Github every minute! To help you keep track of things, Pullp has configurable desktop notifications to keep you in the loop.
\n
\n
Want to find out more about the pull requests on a particular repository? Selecting a repository shows a full summary of each pull request, including all of the requested reviewers and submitted reviews. If you need to action anything, a click will take you directly to the pull request in Github.
\n
\n
You are also shown the five most recently closed pull requests:
\n
\n
Want to change the way that Pullp notifies you of changes? On the settings screen you can toggle a number of different options:
\n
\n
Pullp is an Electron application built with React.
\n
⚡ Getting Started
\n
\n
Download and install the latest release. You'll want the .dmg file for MacOS or the .AppImage file for Linux
\n
Open the app
\n
On MacOS, if your security settings block you from opening the app, right-click it and select Open. You can then click Open on the warning dialogue that opens up.
\n
Follow the on screen instructions to sign in with Github
\n
Select the repositories you want to monitor with Pullp (you are able to choose from all the ones that you watch on Github
\n
Click Monitor to go to the dashboard screen.
\n
Pullp will refresh the dashboard every minute!
\n
\n\n
❔ FAQs
\n
❓ Why does my repository only show a maximum of 50 open pull requests?
\n
\n
💡 Github applies a cost in points to each request Pullp makes for data. Each hour you are permitted to spend 5000 points. By restricting the maximum pull requests to 50, the cost of each request is manageable. This means Pullp can make more frequent requests, giving you a more \"near-time\" experience. Allowing this maximum limit to be configurable by the user could be a feature in the future.
\n
\n
❓ I am seeing an error saying The amount of pull request data for your selected repositories exceeds Github's maximum limit.
\n
\n
💡 Github places a limit on the maximum number of data nodes that can be returned from a single request. This limit may be breached if you have selected a large number of repositories that have many pull requests. The only solution to this currently is to select fewer repositories.
\n
\n
❓ Can I access the console/Chrome dev tools inside the app?
\n
\n
💡 Yes! Just use the normal Chrome shortcut to open them, e.g. cmd + opt + i on Mac. React and Redux dev tools are not available in the production app, but are enabled if you are running the app in the dev environment.
\n
\n
❓ I can't see my repository on the Select screen.
\n
\n
💡 Make sure you are watching the repository in Github, otherwise it won't appear on the select screen.
\n
\n\n
🏁 Developer Instructions 🏁
\n
🚀 Running dev environment - The simplest way
\n
After npm install, run npm start to start the webpack dev server and electron app.
\n
React and Apollo dev tools will be available inside the Chrome dev tools.
\n
✅ Running the tests
\n
\n
Run npm test.
\n
To run the tests without the file watcher, run npm run test:no-watcher
\n
\n
💫 Optional - Running a local oAuth server
\n
Pullp uses an external auth server to complete Github sign in and receive a token for the Github API. You may want to host a local version of this server. Clone it from https://github.com/rkclark/pullp-oauth-gatekeeper, run it on the port of your choosing and then add the server URL to REACT_APP_OAUTH_GATEKEEPER_URL in the /env/.env.development file inside of Pullp.
\n
If you are connecting to a different GitHub domain than github.com, you can set REACT_APP_GITHUB_DOMAIN to that domain such as github.mycompany.com
\n
Your oauth server will need set of Github oAuth app credentials. To make these:
\n
\n
In Github, go to your settings
\n
Go to Developer Settings, select oAuth Apps (usually selected by default)
\n
Click New oAuth App
\n
Give the app a name, this will be seen when/if your app requests access to any organisations that you are a part of. I suggest pullp!
\n
Set the homepage to whatever you like
\n
The authorization callback URL is not actually used by Pullp, I'd suggest just setting it to http://localhost:3001/auth/github/callback
\n
Click to register the app
\n
Make a note of the client ID and client secret that you are shown on the next screen
\n
\n
Once you have the credentials, create a new .env file in the server project root and add them as
\n
OAUTH_CLIENT_ID=xxx\nOAUTH_CLIENT_SECRET=xxx\n
\n
Optional - Stubbing Github
\n
The project includes a server that provides stub responses for all external dependencies:
\n
\n
Github login page
\n
Github oAuth flow
\n
Github GraphQl server
\n
\n
To run the stub server run npm run stub. This will start the server along with the webpack dev server. Then just run npm run electron:start:dev in another terminal window.
\n
This can be used if you want to work offline or have finer control over the data being received by the app.
\n
Limitations:
\n
\n
The GraphQl endpoint is not a real GraphQl implementation! If you change any queries then they will not work without updating the stub endpoint to watch for them.
\n
To have repos appear on the dashboard, do not select any on the Select screen
\n
Images are not currently stubbed so will simply not be loaded
\n
\n
🔮 Other developer scripts
\n
\n
npm run serve: Run a server that hosts the production files
\n
npm run react:build: Build the React/CSS production files
\n
npm run style: Run the linter report
\n
npm run style-fix: Fix all auto-fixable lint errors
\n
npm run precommit: Runs the linter and test suite - used by Husky whenever a git commit is created
\n
npm run electron: Runs electron against the built production files,
\n
npm run pack: Packages distributable for the current OS and leaves unpackaged files available for inspection for debugging
\n
npm run dist: Builds the production files and then packages them into a distributable for the current OS
\n
npm run ship: Builds the production files, packages them for the current OS, and then pushes them to a draft Github release on the Pullp repository. For this to work, you must have the relevant access rights on the Pullp repository. In addition, you must create a personal token on Github and add it as GH_TOKEN=**YOURTOKEN** in a new file electron-builder.env in the project root. See electron-builder.example.env for an example.
\n
npm run install-wsl: Installs linux versions of all packages except for Electron which is installed as the Windows version. For use when developing using Windows Subsystem for Linux (WSL). This is currently the best workaround available.
\n
\n
CI/CD and Releasing
\n
Pullp uses Travis for CI/CD. This is configured so that any branch that is pushed with a name in the format vX.X.X will be automatically packaged for Mac and Linux and uploaded to Github as a draft release.
\n
Any branch name that doesn't match will have the test suite and linter run against it.
\n
e.g.
\n
\n
a branch with a name v1.9.70 will be created as a draft release with both the Mac and Linux installation files attached.
\n
a branch with a name add-new-feature will not be created as a draft release, but will be tested and linted.
\n
\n
Once the draft release is on Github it can have release notes added and then be published! 👌
\n
",
+ "readmeOriginal": "
Pullp
\n
Pullp is a tool to help you manage pull requests and reviews on your Github repositories, available for Mac, Linux and Windows.
\n
An interactive dashboard shows all the open pull requests for your chosen repositories and highlights where your review has been requested. This information syncs with Github every minute! To help you keep track of things, Pullp has configurable desktop notifications to keep you in the loop.
\n
\n
Want to find out more about the pull requests on a particular repository? Selecting a repository shows a full summary of each pull request, including all of the requested reviewers and submitted reviews. If you need to action anything, a click will take you directly to the pull request in Github.
\n
\n
You are also shown the five most recently closed pull requests:
\n
\n
Want to change the way that Pullp notifies you of changes? On the settings screen you can toggle a number of different options:
\n
\n
Pullp is an Electron application built with React.
\n
⚡ Getting Started
\n
\n
Download and install the latest release. You'll want the .dmg file for MacOS or the .AppImage file for Linux
\n
Open the app
\n
On MacOS, if your security settings block you from opening the app, right-click it and select Open. You can then click Open on the warning dialogue that opens up.
\n
Follow the on screen instructions to sign in with Github
\n
Select the repositories you want to monitor with Pullp (you are able to choose from all the ones that you watch on Github
\n
Click Monitor to go to the dashboard screen.
\n
Pullp will refresh the dashboard every minute!
\n
\n\n
❔ FAQs
\n
❓ Why does my repository only show a maximum of 50 open pull requests?
\n
\n
💡 Github applies a cost in points to each request Pullp makes for data. Each hour you are permitted to spend 5000 points. By restricting the maximum pull requests to 50, the cost of each request is manageable. This means Pullp can make more frequent requests, giving you a more \"near-time\" experience. Allowing this maximum limit to be configurable by the user could be a feature in the future.
\n
\n
❓ I am seeing an error saying The amount of pull request data for your selected repositories exceeds Github's maximum limit.
\n
\n
💡 Github places a limit on the maximum number of data nodes that can be returned from a single request. This limit may be breached if you have selected a large number of repositories that have many pull requests. The only solution to this currently is to select fewer repositories.
\n
\n
❓ Can I access the console/Chrome dev tools inside the app?
\n
\n
💡 Yes! Just use the normal Chrome shortcut to open them, e.g. cmd + opt + i on Mac. React and Redux dev tools are not available in the production app, but are enabled if you are running the app in the dev environment.
\n
\n
❓ I can't see my repository on the Select screen.
\n
\n
💡 Make sure you are watching the repository in Github, otherwise it won't appear on the select screen.
\n
\n\n
🏁 Developer Instructions 🏁
\n
🚀 Running dev environment - The simplest way
\n
After npm install, run npm start to start the webpack dev server and electron app.
\n
React and Apollo dev tools will be available inside the Chrome dev tools.
\n
✅ Running the tests
\n
\n
Run npm test.
\n
To run the tests without the file watcher, run npm run test:no-watcher
\n
\n
💫 Optional - Running a local oAuth server
\n
Pullp uses an external auth server to complete Github sign in and receive a token for the Github API. You may want to host a local version of this server. Clone it from https://github.com/rkclark/pullp-oauth-gatekeeper, run it on the port of your choosing and then add the server URL to REACT_APP_OAUTH_GATEKEEPER_URL in the /env/.env.development file inside of Pullp.
\n
If you are connecting to a different GitHub domain than github.com, you can set REACT_APP_GITHUB_DOMAIN to that domain such as github.mycompany.com
\n
Your oauth server will need set of Github oAuth app credentials. To make these:
\n
\n
In Github, go to your settings
\n
Go to Developer Settings, select oAuth Apps (usually selected by default)
\n
Click New oAuth App
\n
Give the app a name, this will be seen when/if your app requests access to any organisations that you are a part of. I suggest pullp!
\n
Set the homepage to whatever you like
\n
The authorization callback URL is not actually used by Pullp, I'd suggest just setting it to http://localhost:3001/auth/github/callback
\n
Click to register the app
\n
Make a note of the client ID and client secret that you are shown on the next screen
\n
\n
Once you have the credentials, create a new .env file in the server project root and add them as
\n
OAUTH_CLIENT_ID=xxx\nOAUTH_CLIENT_SECRET=xxx\n
\n
Optional - Stubbing Github
\n
The project includes a server that provides stub responses for all external dependencies:
\n
\n
Github login page
\n
Github oAuth flow
\n
Github GraphQl server
\n
\n
To run the stub server run npm run stub. This will start the server along with the webpack dev server. Then just run npm run electron:start:dev in another terminal window.
\n
This can be used if you want to work offline or have finer control over the data being received by the app.
\n
Limitations:
\n
\n
The GraphQl endpoint is not a real GraphQl implementation! If you change any queries then they will not work without updating the stub endpoint to watch for them.
\n
To have repos appear on the dashboard, do not select any on the Select screen
\n
Images are not currently stubbed so will simply not be loaded
\n
\n
🔮 Other developer scripts
\n
\n
npm run serve: Run a server that hosts the production files
\n
npm run react:build: Build the React/CSS production files
\n
npm run style: Run the linter report
\n
npm run style-fix: Fix all auto-fixable lint errors
\n
npm run precommit: Runs the linter and test suite - used by Husky whenever a git commit is created
\n
npm run electron: Runs electron against the built production files,
\n
npm run pack: Packages distributable for the current OS and leaves unpackaged files available for inspection for debugging
\n
npm run dist: Builds the production files and then packages them into a distributable for the current OS
\n
npm run ship: Builds the production files, packages them for the current OS, and then pushes them to a draft Github release on the Pullp repository. For this to work, you must have the relevant access rights on the Pullp repository. In addition, you must create a personal token on Github and add it as GH_TOKEN=**YOURTOKEN** in a new file electron-builder.env in the project root. See electron-builder.example.env for an example.
\n
npm run install-wsl: Installs linux versions of all packages except for Electron which is installed as the Windows version. For use when developing using Windows Subsystem for Linux (WSL). This is currently the best workaround available.
\n
\n
CI/CD and Releasing
\n
Pullp uses Travis for CI/CD. This is configured so that any branch that is pushed with a name in the format vX.X.X will be automatically packaged for Mac and Linux and uploaded to Github as a draft release.
\n
Any branch name that doesn't match will have the test suite and linter run against it.
\n
e.g.
\n
\n
a branch with a name v1.9.70 will be created as a draft release with both the Mac and Linux installation files attached.
\n
a branch with a name add-new-feature will not be created as a draft release, but will be tested and linted.
\n
\n
Once the draft release is on Github it can have release notes added and then be published! 👌
Puppetry is an open-source cross-platform desktop application that gives non-developers the ability to create, manage, and integrate automated tests for Web
Puppetry offers you an easy-to-use UI where you choose browser methods and assertions from a predefined list, with predefined settings, guided by extensive tips.\nNamely you can do the following:
\n
\n
record user flow
\n
declare element targets as pairs variable = locator, where locator can be either CSS selector or Xpath.
\n
manage your test structure in BDD style (project, suite, test context, test case)
\n
manage page/element methods and assertions
\n
run the tests in Chromium/Chromium/Chrome/Firefox/Edge
\n
export the project as Jest/Puppeteer bundle ready to run in CLI (e.g. by a continuous integration server)
\n
\n
Key Features
\n
\n
Can be used by QA engineers with no programming background
Please adhere the coding style. We have one based on jQuery's JavaScript Style Guide. You can find the validation rules in .eslintrc\nand lint the code by running npm run lint
Puppetry is an open-source cross-platform desktop application that gives non-developers the ability to create, manage, and integrate automated tests for Web
Puppetry offers you an easy-to-use UI where you choose browser methods and assertions from a predefined list, with predefined settings, guided by extensive tips.\nNamely you can do the following:
\n
\n
record user flow
\n
declare element targets as pairs variable = locator, where locator can be either CSS selector or Xpath.
\n
manage your test structure in BDD style (project, suite, test context, test case)
\n
manage page/element methods and assertions
\n
run the tests in Chromium/Chromium/Chrome/Firefox/Edge
\n
export the project as Jest/Puppeteer bundle ready to run in CLI (e.g. by a continuous integration server)
\n
\n
Key Features
\n
\n
Can be used by QA engineers with no programming background
Please adhere the coding style. We have one based on jQuery's JavaScript Style Guide. You can find the validation rules in .eslintrc\nand lint the code by running npm run lint
Current status: 80% parity with previous version (missing dark theme, icons on hover tooltips, mostly)
\n
This project uses Github Projects to plan development — feel free to join in!
\n
Feel free to email me if you are interested in contributing right now, before the foundation is done: navedcoded@gmail.com . Sorry if things are a bit messy, but I recommend checking this repo out a few weeks later!
(The repo uses an automatic postinstall script to patch the npm package electron-update-notification to use a promise .then() instead of callbacks. I haven't been able to test if I set this up correctly, but hopefully it's fine. You can check the installed package files manually, or just message me for help to ensure it's all good.)
\n
Action\n5. Run a local build with electron-dev, has hot-reload\n6. Build a package with dist-[platform] choosing the relevant platform from the scripts available in the package.json
\n
Many thanks to Albert Nye for his svelte electron template!
\n
License
\n.\n\">
Copyright (C) 2020-2021 Naved Islam\n\nThis program is free software: you can redistribute it and/or modify\nit under the terms of the GNU Affero General Public License as published\nby the Free Software Foundation, either version 3 of the License, or\n(at your option) any later version.\n\nThis program is distributed in the hope that it will be useful,\nbut WITHOUT ANY WARRANTY; without even the implied warranty of\nMERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\nGNU Affero General Public License for more details.\n\nYou should have received a copy of the GNU Affero General Public License\nalong with this program. If not, see <https://www.gnu.org/licenses/>.\n
\n",
+ "readmeOriginal": "
Qawl v2
\n
Current status: 80% parity with previous version (missing dark theme, icons on hover tooltips, mostly)
\n
This project uses Github Projects to plan development — feel free to join in!
\n
Feel free to email me if you are interested in contributing right now, before the foundation is done: navedcoded@gmail.com . Sorry if things are a bit messy, but I recommend checking this repo out a few weeks later!
(The repo uses an automatic postinstall script to patch the npm package electron-update-notification to use a promise .then() instead of callbacks. I haven't been able to test if I set this up correctly, but hopefully it's fine. You can check the installed package files manually, or just message me for help to ensure it's all good.)
\n
Action\n5. Run a local build with electron-dev, has hot-reload\n6. Build a package with dist-[platform] choosing the relevant platform from the scripts available in the package.json
\n
Many thanks to Albert Nye for his svelte electron template!
\n
License
\n
Copyright (C) 2020-2021 Naved Islam\n\nThis program is free software: you can redistribute it and/or modify\nit under the terms of the GNU Affero General Public License as published\nby the Free Software Foundation, either version 3 of the License, or\n(at your option) any later version.\n\nThis program is distributed in the hope that it will be useful,\nbut WITHOUT ANY WARRANTY; without even the implied warranty of\nMERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\nGNU Affero General Public License for more details.\n\nYou should have received a copy of the GNU Affero General Public License\nalong with this program. If not, see <https://www.gnu.org/licenses/>.\n
Permission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:
\n
The above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.
\n
THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.
\n
\n
",
+ "readmeOriginal": "
\n \n
\n
\n \n
\n
\n
INTRODUCTION
\n
Meet qikQR. A desktop app that creates QR codes.\n qikQR is multi-platform, open-source, and built entirely on web technology.
Permission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:
\n
The above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.
\n
THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.
QBox is a convenient manage tool for your Qiniu buckets. It is an open-source software and can be used on OS X, Linux and Windows, and it was generated with electron-vue
\n
\n
Screenshots
\n
Bucket Panel
\n
\n
Manage Panel
\n
\n
Upload Panel
\n
\n
Feature
\n
Bucket Panel
\n
\n
Login by setting accessKey and secretKey.
\n
Logout by clearing localStorage (include accessKey and secretKey).
\n
List all buckets (include private).
\n
Manage files in a bucket, that will open a new Manage Panel.
\n
\n
Manage Panel
\n
\n
List all files in a specified bucket.
\n
List all files with pagination.
\n
Sort by file name, file type, file size or modified time.
\n
Preview image and media file.
\n
Delete a existing file.
\n
Delete a batch of files were checked.
\n
Copy the outer link of a file.
\n
Refresh the files in the bucket.
\n
Download a existing file.(this feature will be put in preview modal)
\n
Upload a single file.
\n
Search filter.
\n
\n
TODO
\n
MenuBar
\n
\n
Set default bucket.
\n
Drag to MenuBar icon to upload.
\n
\n
Bucket Panel
\n
\n
Delete a existing bucket.
\n
Create a new bucket.
\n
\n
Manage Panel
\n
\n
Add enter event to search box.
\n
Upload mutiple files.
\n
Download a batch of files were checked.
\n
Rename resouces.
\n
\n
License
\n
\n
Contribute
\n
# install dependencies\nnpm install\n\n# serve with hot reload at localhost:9080\nnpm run dev\n\n# build electron application for production\nnpm run build\n\n# run unit tests (no tests now)\nnpm test\n\n# lint all JS/Vue component files in `src/`\nnpm run lint
QBox is a convenient manage tool for your Qiniu buckets. It is an open-source software and can be used on OS X, Linux and Windows, and it was generated with electron-vue
\n
\n
Screenshots
\n
Bucket Panel
\n
\n
Manage Panel
\n
\n
Upload Panel
\n
\n
Feature
\n
Bucket Panel
\n
\n
Login by setting accessKey and secretKey.
\n
Logout by clearing localStorage (include accessKey and secretKey).
\n
List all buckets (include private).
\n
Manage files in a bucket, that will open a new Manage Panel.
\n
\n
Manage Panel
\n
\n
List all files in a specified bucket.
\n
List all files with pagination.
\n
Sort by file name, file type, file size or modified time.
\n
Preview image and media file.
\n
Delete a existing file.
\n
Delete a batch of files were checked.
\n
Copy the outer link of a file.
\n
Refresh the files in the bucket.
\n
Download a existing file.(this feature will be put in preview modal)
\n
Upload a single file.
\n
Search filter.
\n
\n
TODO
\n
MenuBar
\n
\n
Set default bucket.
\n
Drag to MenuBar icon to upload.
\n
\n
Bucket Panel
\n
\n
Delete a existing bucket.
\n
Create a new bucket.
\n
\n
Manage Panel
\n
\n
Add enter event to search box.
\n
Upload mutiple files.
\n
Download a batch of files were checked.
\n
Rename resouces.
\n
\n
License
\n
\n
Contribute
\n
# install dependencies\nnpm install\n\n# serve with hot reload at localhost:9080\nnpm run dev\n\n# build electron application for production\nnpm run build\n\n# run unit tests (no tests now)\nnpm test\n\n# lint all JS/Vue component files in `src/`\nnpm run lint
Quark is a general purpose software tool specifically designed to help you create projects written in HTML, CSS and JavaScript with native desktop app like capabilities. Quark apps run on Mac, Windows, and Linux from a single codebase.
Projects build with Quark should be easy and quick to setup.
\n
💻 Cross-platform
\n
Projects build with Quark should run on all platforms such as Windows, Linux and Mac, sharing the same code base.
\n
🐱 Simplicity
\n
Quark is built with simplicity in mind, so that creating projects with Quark is enjoyable, easy to learn, and accessible to just about anyone with basic programming skills.
Quark is a general purpose software tool specifically designed to help you create projects written in HTML, CSS and JavaScript with native desktop app like capabilities. Quark apps run on Mac, Windows, and Linux from a single codebase.
Projects build with Quark should be easy and quick to setup.
\n
💻 Cross-platform
\n
Projects build with Quark should run on all platforms such as Windows, Linux and Mac, sharing the same code base.
\n
🐱 Simplicity
\n
Quark is built with simplicity in mind, so that creating projects with Quark is enjoyable, easy to learn, and accessible to just about anyone with basic programming skills.
Quba-Viewer (homepage) is a cross platform open source application to display\nstructured (i.e., XML) and hybrid (Factur-X/ZUGFeRD PDF) electronic invoices.
\n
History
\n\n0.2 10.06.2021\n - Support for XRechnung (UBL)\n - \"dark\" theming\n - possibility to open multiple files at the same time in the same viewer (tabs)\n - print \n \n\n0.1 2021-03-31\n - Initial release\n - Support for XRechnung (UN/CEFACT CII)\n - release for Windows on 2021-03-31, for Linux on 2101-04-16 and for Mac on 2021-04-27\n \n
Architecture
\n
This viewer is a simple electron application (just use npm start to run)\nwhich uses XSLT files to convert XML to HTML.
Use CTRL+B to open the developer console.\nnpm start of course starts the application for local testing.
\n
npm run start\n
\n
should tell you if the software runs
\n
npm run build\n
\n
will build a version, which you can install e.g. with dist\\quba_viewer Setup 0.2.0.exe.\nIf you do not run it from the start menu, but in a shell directly from\n\\Users\\<your user name>\\AppData\\Local\\Programs\\quba_viewer\\quba_viewer.exe\nyou will also see potential error output on the console.
\n
Common issues include listing runtime dependencies as devDepencencies\nor not listing files to be included in the deployment in the build.files.filter\n(both issues can be fixed in the package.json).
\n
Deployment
\n
The final update can then be deployed by Github users who have been granted access\nvia a powershell using
\n
'\nnpm run publish\n\">
$env:GH_TOKEN = '<private github access token>'\nnpm run publish\n
\n
To access the console (not only of the browser windows but also of main.js)\nstart Quba in a shell, e.g.\n%AppData%\\Local\\Programs\\quba_viewer\\quba_viewer.exe
\n
Known issues
\n
\n
the invoice output is german
\n
\n
",
+ "readmeOriginal": "
Quba-Viewer
\n
Quba-Viewer (homepage) is a cross platform open source application to display\nstructured (i.e., XML) and hybrid (Factur-X/ZUGFeRD PDF) electronic invoices.
\n
History
\n\n0.2 10.06.2021\n - Support for XRechnung (UBL)\n - \"dark\" theming\n - possibility to open multiple files at the same time in the same viewer (tabs)\n - print \n \n\n0.1 2021-03-31\n - Initial release\n - Support for XRechnung (UN/CEFACT CII)\n - release for Windows on 2021-03-31, for Linux on 2101-04-16 and for Mac on 2021-04-27\n \n
Architecture
\n
This viewer is a simple electron application (just use npm start to run)\nwhich uses XSLT files to convert XML to HTML.
Use CTRL+B to open the developer console.\nnpm start of course starts the application for local testing.
\n
npm run start\n
\n
should tell you if the software runs
\n
npm run build\n
\n
will build a version, which you can install e.g. with dist\\quba_viewer Setup 0.2.0.exe.\nIf you do not run it from the start menu, but in a shell directly from\n\\Users\\<your user name>\\AppData\\Local\\Programs\\quba_viewer\\quba_viewer.exe\nyou will also see potential error output on the console.
\n
Common issues include listing runtime dependencies as devDepencencies\nor not listing files to be included in the deployment in the build.files.filter\n(both issues can be fixed in the package.json).
\n
Deployment
\n
The final update can then be deployed by Github users who have been granted access\nvia a powershell using
\n
$env:GH_TOKEN = '<private github access token>'\nnpm run publish\n
\n
To access the console (not only of the browser windows but also of main.js)\nstart Quba in a shell, e.g.\n%AppData%\\Local\\Programs\\quba_viewer\\quba_viewer.exe
QuickRedis is a free forever Redis Desktop manager. It supports direct connection, sentinel, and cluster mode, supports multiple languages, supports hundreds of millions of keys, and has an amazing UI. Supports both Windows, Mac OS X and Linux platform.
\n
QuickRedis is an efficiency tool, when others are trying to type commands, and you are already drinking coffee.
\n
(\nQuickRedis 是一款 永久免费 的 Redis 可视化管理工具。它支持直连、哨兵、集群模式,支持亿万数量级的 key,还有令人兴奋的 UI。QuickRedis 支持 Windows 、 Mac OS X 和 Linux 下运行。
QuickRedis is a free forever Redis Desktop manager. It supports direct connection, sentinel, and cluster mode, supports multiple languages, supports hundreds of millions of keys, and has an amazing UI. Supports both Windows, Mac OS X and Linux platform.
\n
QuickRedis is an efficiency tool, when others are trying to type commands, and you are already drinking coffee.
\n
(\nQuickRedis 是一款 永久免费 的 Redis 可视化管理工具。它支持直连、哨兵、集群模式,支持亿万数量级的 key,还有令人兴奋的 UI。QuickRedis 支持 Windows 、 Mac OS X 和 Linux 下运行。
Electron-Firebase is a quickstart framework for building cross-platform cloud-connected desktop\napplications using Electron and Firebase.\nWith a few configuration settings you can include a complete authentication workflow into your app\nthat can use email/password, phone number, google, facebook, or many other identity providers.
\n
Electron-Firebase is unusual in being both an NPM module\nand an example application, and it spans both worlds of the Browser JavaScript environment and the host node.js\nenvironment. As such, it will install several folders and files into the root of the NPM application that form\nthe example application, which you are encouraged to modify for your own purposes.
An authentication workflow within an application context for many identity providers, including phone and email
\n
Authentication persistence, so that a user can launch your app at any time without signing in again
\n
Security and privacy throughout the authentication sign-in and persistence processes
\n
True cross-platform cloud-connected application building across MacOS, Windows, and Linux
\n
Methods for communication between the Electron Browser and Main processes
\n
Authorized user access to database and cloud storage with Firebase security rules
\n
API access to Firebase Cloud Storage, which is not supported in node.js
\n
Firebase Cloud Storage listing and searching capability
\n
Persistence of window positions on the screen automagically when the user changes them
\n
An example application for a quick start in writing your own application
\n
Please, please, please modify the splash page (/pages/splashpage.html) before releasing your own application
\n
\n
Opinionated
\n
The design of Electron-Firebase is specifically opinionated in a few key areas:
\n
\n
The integration between Electron and Firebase should be sufficiently complete that a developer can\ninstall this framework and quickly get started writing an application
\n
The Electron Main Process\nis where most Firebase access should happen since that has access to all of the node.js APIs and operating system.\nThe exception being the firebaseui authentication workflow\nwhich has to execute in the Browser (Electron \"Renderer\" process).
\n
Access to the Firebase database and storage should enforce authorization so that your app can only\nperform operations in the context of the signed-in user and application.
\n
Communication between the Browser and Main processes must be secured when the Browser content contains\nforeign content or private information, such as the firebaseui workflow.
\n
\n
NOT opinionated
\n
Electron-Firebase is specifically not opinionated in these areas:
\n
\n
There is no application build and packaging process since there are multiple ways to accomplish this.
\n
There is no preferred UI framework. The example app uses Bootstrap in a minimal way.
\n
The Firebase API and capability set continues to expand, such as crash analytics, performance\nmonitoring, and so on. Electron-Firebase does not integrate Firebase any further than the application foundation\nof authentication, database, and storage.
\n
\n
Platform support
\n
Electron-Firebase has been tested on:
\n
\n
Ubuntu Linux 20.04.2 LTS (Focal Fossa)
\n
Apple Mac OS 11.3 (Big Sur)
\n
Microsoft Windows 10 Home 20H2
\n
\n
Installation Process Overview
\n
Although Electron-Firebase is an NPM module, there is some preparation to complete before it can be installed.\nThis process may appear complicated because it involes setting up a Cloud service (Firebase) and establishing\ntrust relationships with various identity providers. This is work that needs to be done for any kind of cloud\nconnected application, but once configured, Electron-Firebase automates much of the rest. The sequence of\noperations is important, and no steps are optional. The process should be identical for any platform that you\nare using, excepting the text editor and terminal that you use.
From the Project Overview, make sure that you have the Blaze Plan selected
\n
\n
Enable Firebase Custom Tokens
\n
Electron-Firebase uses Custom Tokens to help manage\nthe authentication process, where\nthe Service Account ID\nmethod will be used. To enable this capability, you must grant the \"Service Account Token Creator\" IAM role to\nyour project's service account as follows.
\ncd \nnpm init\n\n# install the electron-firebase framework and example application\nnpm install electron-firebase\n\">
# initialize your project\nmkdir <your-project>\ncd <your-project>\nnpm init\n\n# install the electron-firebase framework and example application\nnpm install electron-firebase\n
\n
Edit firebase-config.json parameters
\n
It is highly recommended that you add firebase-config.json to your .gitignore file. It contains project-specific\ninformation that you do not want to check in with the app, nor should it be packaged when building your app.
\n
\n
Edit ./config/firebase-config.json using your favorite text editor, preferably one based on Electron
Be very careful when cutting/pasting values, as things will certainly not work if there are any errors\nor JSON syntax violation.
\n
Firebase project settings
\n
\n
Click on the configuration gear next to Project Overview and select Project Settings
\n
Scroll down to Firebase SDK snippet and select Config
\n
Cut and paste the following fields carefully into the ./config/firebase-config.json file:\n
\n
\"apiKey\"
\n
\"authDomain\"
\n
\"databaseURL\"
\n
\"projectId\"
\n
\"storageBucket\"
\n
\"messagingSenderId\"
\n
\"appId\"
\n
\n
\n
\n
Firebase hosting URL
\n
\n
Select Develop 🠊 Hosting
\n
Under your project Domain, right click on the firebaseapp.com link, else create your Custom Domain
\n
Paste the hosting URL to\n
\n
\"hostingUrl\"
\n
\n
\n
\n
Service account
\n
\n
Select Project Settings 🠊 Service accounts
\n
Under Firebase service account, copy the entire string ending with gserviceaccount.com
\n
Paste the service account to:\n
\n
\"serviceAccountId\"
\n
\n
\n
Save your changes to the ./config/firebase-config.json file.
\n
\n
Deploy security rules and cloud functions
\n
The following command will deploy Firebase rules and cloud functions to the Firebase Cloud.\nThese are critical for authentication and authorization to function properly. The deploy process\nneeds to run only once for your project, or subsequently if the security rules or cloud functions\nare ever modified. These files are administrative and should not bundled with your application.
Firebase Authentication uses industry standards like OAuth 2.0 and OpenID Connect\nto support popular federated identity providers like Google, Facebook, Twitter, and many more. In order for your app to have\nauthentication options such as \"Sign in with Facebook\", each identity provider needs to know about your app, and your\napp needs to know something about each identity provider that you would like to support. The following instructions use\nFacebook as an example. The other identity providers will have very similar processes but will differ in some details.
Paste the redirect URI under Valid OAuth Redirect URIs
\n
Click Save Changes
\n
\n
Modify app-config.json \"providers\"
\n
\n
Open the ./config/app-config.json file with your favorite text editor
\n
Add \"facebook.com\" to the providers list
\n
Repeat the entire setup process for any other identity providers that you wish to support
\n
Possible values are\n
\n
password
\n
phone
\n
google.com
\n
facebook.com
\n
twitter.com
\n
github.com
\n
apple.com
\n
microsoft.com
\n
yahoo.com
\n
\n
\n
\n
Configuration files
\n
config/firebase-config.json
\n
\n
IMPORTANT: These file parameters must be changed to support your unique firebase project.\nFor details, see section: Edit firebase-config.json parameters
\n
\n
config/content-security-policy.json
\n
\n
IMPORTANT: If you add new identify providers, you will probably need to add their web asset URLs to this file.\nThe web pages in electron-firebase define Content Security Policy\nso they may securely be used with foreign scripts and pages, which is a critical component of the signin process.\nManaging complex Content Security Policy strings can be challenging, so electron-firebase provides this configuration file\nso that you can list all of the elements individually. Note that there are several style-src 'unsafe-hash' entries which\nare compensating for the firebasui web page having a few inline style elements.
\n
\n
config/app-config.json
\n
A number of parameters may be modified in the ./config/app-config.json file. Changing some of them could\ncause your application to stop working if they are not coordinated with application code changes.
\n
debugMode
\n
Set this value to true to enable debug mode: some log messages will be visible, network calls with be logged,\nand Browser (renderer) windows will be opened in developer/debug mode.
\n
webapp
\n
These keys describe some critical operating parameters like the localhost port. Most of the filenames and paths are\nshared information between the main process and renderer. \"persistentUser\" enables the renderer (Browser) process\nto securely store a token that persists the firebase user identity between sessions, which makes sense for an app\nthat stays resident on a private computer. If your app is intended to be used in a public or shared context, you may\nwant to set \"persistentUser\" to false which will force a login every time the app is started.
\n
webFolders
\n
Electron-Firebase operates a TLS web server within the Main node.js process that hosts APIs that the Browser\ncan access. This is \"static\" web content, meaning that referencing one of these pages will not run a dynamic\nscript on the web server.
\n
apis
\n
These entries are localhost URLs that the Browser uses to make API requests to the Main process. You shouldn't\nmodify these, but it's a way to keep consistent API definitions between the Browser and Main processes. You can\nuse this mechanism if you would like to add custom Main process apis that can be accessed by the Browser, or in fact\nby any other application with access to localhost.
\n
logout
\n
There are really two levels of sign-in and two levels of sign-out - the Firebase application, and the identity\nprovider. The Firebase signout process does not handle the identity provider level, so these URLs are provided\nas a way to perform a \"deep logout\".
\n
providers
\n
This list determines which choices for identity provider will be presented to the user. So this list must be\nmodified to match the set of identity providers to be supported by your application.
\n
The example application
\n
The npm install process copies an example application to your project folder. This application\ngenerates some data sets based on the user's authentication profile, and allows the user to view that\ninformation in the Firestore database or Firebase Cloud Storage.
\n
Start the example application
\n
To run the example application:
\n
npm start\n
\n
Example application files and structure
\n
The example application installs the following folders and files, which you are free to modify. When performing\na subsequent npm install, any modified example application files will not be overwritten, so if you want to get the\nnewest version before an update you should change the names of the modified files.
\n
\n
/config - configuration files for your application
\n
/functions - functions to be deployed to the Firebase Cloud
\n
/pages - top-level web server folder for HTML pages accessible to the Browser
\n
/scripts - top-level web server folder for JavaScript modules to the Browser
\n
main.js - the example application main file and overall program structure
\n
answerBrowser.js - app support file, functions that export APIs used by the Browser
\n
setupApp.js - app support file that generates example data sets on startup
Electron-Firebase is a quickstart framework for building cross-platform cloud-connected desktop\napplications using Electron and Firebase.\nWith a few configuration settings you can include a complete authentication workflow into your app\nthat can use email/password, phone number, google, facebook, or many other identity providers.
\n
Electron-Firebase is unusual in being both an NPM module\nand an example application, and it spans both worlds of the Browser JavaScript environment and the host node.js\nenvironment. As such, it will install several folders and files into the root of the NPM application that form\nthe example application, which you are encouraged to modify for your own purposes.
An authentication workflow within an application context for many identity providers, including phone and email
\n
Authentication persistence, so that a user can launch your app at any time without signing in again
\n
Security and privacy throughout the authentication sign-in and persistence processes
\n
True cross-platform cloud-connected application building across MacOS, Windows, and Linux
\n
Methods for communication between the Electron Browser and Main processes
\n
Authorized user access to database and cloud storage with Firebase security rules
\n
API access to Firebase Cloud Storage, which is not supported in node.js
\n
Firebase Cloud Storage listing and searching capability
\n
Persistence of window positions on the screen automagically when the user changes them
\n
An example application for a quick start in writing your own application
\n
Please, please, please modify the splash page (/pages/splashpage.html) before releasing your own application
\n
\n
Opinionated
\n
The design of Electron-Firebase is specifically opinionated in a few key areas:
\n
\n
The integration between Electron and Firebase should be sufficiently complete that a developer can\ninstall this framework and quickly get started writing an application
\n
The Electron Main Process\nis where most Firebase access should happen since that has access to all of the node.js APIs and operating system.\nThe exception being the firebaseui authentication workflow\nwhich has to execute in the Browser (Electron \"Renderer\" process).
\n
Access to the Firebase database and storage should enforce authorization so that your app can only\nperform operations in the context of the signed-in user and application.
\n
Communication between the Browser and Main processes must be secured when the Browser content contains\nforeign content or private information, such as the firebaseui workflow.
\n
\n
NOT opinionated
\n
Electron-Firebase is specifically not opinionated in these areas:
\n
\n
There is no application build and packaging process since there are multiple ways to accomplish this.
\n
There is no preferred UI framework. The example app uses Bootstrap in a minimal way.
\n
The Firebase API and capability set continues to expand, such as crash analytics, performance\nmonitoring, and so on. Electron-Firebase does not integrate Firebase any further than the application foundation\nof authentication, database, and storage.
\n
\n
Platform support
\n
Electron-Firebase has been tested on:
\n
\n
Ubuntu Linux 20.04.2 LTS (Focal Fossa)
\n
Apple Mac OS 11.3 (Big Sur)
\n
Microsoft Windows 10 Home 20H2
\n
\n
Installation Process Overview
\n
Although Electron-Firebase is an NPM module, there is some preparation to complete before it can be installed.\nThis process may appear complicated because it involes setting up a Cloud service (Firebase) and establishing\ntrust relationships with various identity providers. This is work that needs to be done for any kind of cloud\nconnected application, but once configured, Electron-Firebase automates much of the rest. The sequence of\noperations is important, and no steps are optional. The process should be identical for any platform that you\nare using, excepting the text editor and terminal that you use.
From the Project Overview, make sure that you have the Blaze Plan selected
\n
\n
Enable Firebase Custom Tokens
\n
Electron-Firebase uses Custom Tokens to help manage\nthe authentication process, where\nthe Service Account ID\nmethod will be used. To enable this capability, you must grant the \"Service Account Token Creator\" IAM role to\nyour project's service account as follows.
# initialize your project\nmkdir <your-project>\ncd <your-project>\nnpm init\n\n# install the electron-firebase framework and example application\nnpm install electron-firebase\n
\n
Edit firebase-config.json parameters
\n
It is highly recommended that you add firebase-config.json to your .gitignore file. It contains project-specific\ninformation that you do not want to check in with the app, nor should it be packaged when building your app.
\n
\n
Edit ./config/firebase-config.json using your favorite text editor, preferably one based on Electron
Be very careful when cutting/pasting values, as things will certainly not work if there are any errors\nor JSON syntax violation.
\n
Firebase project settings
\n
\n
Click on the configuration gear next to Project Overview and select Project Settings
\n
Scroll down to Firebase SDK snippet and select Config
\n
Cut and paste the following fields carefully into the ./config/firebase-config.json file:\n
\n
\"apiKey\"
\n
\"authDomain\"
\n
\"databaseURL\"
\n
\"projectId\"
\n
\"storageBucket\"
\n
\"messagingSenderId\"
\n
\"appId\"
\n
\n
\n
\n
Firebase hosting URL
\n
\n
Select Develop 🠊 Hosting
\n
Under your project Domain, right click on the firebaseapp.com link, else create your Custom Domain
\n
Paste the hosting URL to\n
\n
\"hostingUrl\"
\n
\n
\n
\n
Service account
\n
\n
Select Project Settings 🠊 Service accounts
\n
Under Firebase service account, copy the entire string ending with gserviceaccount.com
\n
Paste the service account to:\n
\n
\"serviceAccountId\"
\n
\n
\n
Save your changes to the ./config/firebase-config.json file.
\n
\n
Deploy security rules and cloud functions
\n
The following command will deploy Firebase rules and cloud functions to the Firebase Cloud.\nThese are critical for authentication and authorization to function properly. The deploy process\nneeds to run only once for your project, or subsequently if the security rules or cloud functions\nare ever modified. These files are administrative and should not bundled with your application.
Firebase Authentication uses industry standards like OAuth 2.0 and OpenID Connect\nto support popular federated identity providers like Google, Facebook, Twitter, and many more. In order for your app to have\nauthentication options such as \"Sign in with Facebook\", each identity provider needs to know about your app, and your\napp needs to know something about each identity provider that you would like to support. The following instructions use\nFacebook as an example. The other identity providers will have very similar processes but will differ in some details.
Paste the redirect URI under Valid OAuth Redirect URIs
\n
Click Save Changes
\n
\n
Modify app-config.json \"providers\"
\n
\n
Open the ./config/app-config.json file with your favorite text editor
\n
Add \"facebook.com\" to the providers list
\n
Repeat the entire setup process for any other identity providers that you wish to support
\n
Possible values are\n
\n
password
\n
phone
\n
google.com
\n
facebook.com
\n
twitter.com
\n
github.com
\n
apple.com
\n
microsoft.com
\n
yahoo.com
\n
\n
\n
\n
Configuration files
\n
config/firebase-config.json
\n
\n
IMPORTANT: These file parameters must be changed to support your unique firebase project.\nFor details, see section: Edit firebase-config.json parameters
\n
\n
config/content-security-policy.json
\n
\n
IMPORTANT: If you add new identify providers, you will probably need to add their web asset URLs to this file.\nThe web pages in electron-firebase define Content Security Policy\nso they may securely be used with foreign scripts and pages, which is a critical component of the signin process.\nManaging complex Content Security Policy strings can be challenging, so electron-firebase provides this configuration file\nso that you can list all of the elements individually. Note that there are several style-src 'unsafe-hash' entries which\nare compensating for the firebasui web page having a few inline style elements.
\n
\n
config/app-config.json
\n
A number of parameters may be modified in the ./config/app-config.json file. Changing some of them could\ncause your application to stop working if they are not coordinated with application code changes.
\n
debugMode
\n
Set this value to true to enable debug mode: some log messages will be visible, network calls with be logged,\nand Browser (renderer) windows will be opened in developer/debug mode.
\n
webapp
\n
These keys describe some critical operating parameters like the localhost port. Most of the filenames and paths are\nshared information between the main process and renderer. \"persistentUser\" enables the renderer (Browser) process\nto securely store a token that persists the firebase user identity between sessions, which makes sense for an app\nthat stays resident on a private computer. If your app is intended to be used in a public or shared context, you may\nwant to set \"persistentUser\" to false which will force a login every time the app is started.
\n
webFolders
\n
Electron-Firebase operates a TLS web server within the Main node.js process that hosts APIs that the Browser\ncan access. This is \"static\" web content, meaning that referencing one of these pages will not run a dynamic\nscript on the web server.
\n
apis
\n
These entries are localhost URLs that the Browser uses to make API requests to the Main process. You shouldn't\nmodify these, but it's a way to keep consistent API definitions between the Browser and Main processes. You can\nuse this mechanism if you would like to add custom Main process apis that can be accessed by the Browser, or in fact\nby any other application with access to localhost.
\n
logout
\n
There are really two levels of sign-in and two levels of sign-out - the Firebase application, and the identity\nprovider. The Firebase signout process does not handle the identity provider level, so these URLs are provided\nas a way to perform a \"deep logout\".
\n
providers
\n
This list determines which choices for identity provider will be presented to the user. So this list must be\nmodified to match the set of identity providers to be supported by your application.
\n
The example application
\n
The npm install process copies an example application to your project folder. This application\ngenerates some data sets based on the user's authentication profile, and allows the user to view that\ninformation in the Firestore database or Firebase Cloud Storage.
\n
Start the example application
\n
To run the example application:
\n
npm start\n
\n
Example application files and structure
\n
The example application installs the following folders and files, which you are free to modify. When performing\na subsequent npm install, any modified example application files will not be overwritten, so if you want to get the\nnewest version before an update you should change the names of the modified files.
\n
\n
/config - configuration files for your application
\n
/functions - functions to be deployed to the Firebase Cloud
\n
/pages - top-level web server folder for HTML pages accessible to the Browser
\n
/scripts - top-level web server folder for JavaScript modules to the Browser
\n
main.js - the example application main file and overall program structure
\n
answerBrowser.js - app support file, functions that export APIs used by the Browser
\n
setupApp.js - app support file that generates example data sets on startup
Quickwords is a productivity app, to get on with your work quicker. It helps you substitute common words, phrases and paragraphs with just few key strokes. It is available on MacOS (other systems coming very soon).\nYou can check out the website and full documentation for more information.
\n
\n
Installation
\n
MacOS
\n
Download the latest release, unzip and drag Quickwords.app to your Applications folder.
\n
Linux & Windows
\n
Linux and Windows versions of the app are coming soon. In the meantime all PRs are very welcome.
\n
Privacy and Security
\n
Quickwords registers all global keyboard events, so it has an access to everything you type on the system. No data is saved on the system, and only 20 last keystrokes are remembered in the memory of the app. All your data should be secure.
\n
If you discover a security vulnerability within Quickwords, please DM @quickwordsapp. All security vulnerabilities will be promptly addressed.
\n
Contribution
\n
Contributions are very welcome. If you want, just drop a PR with any feature you'd like to see. If you want to help with the development of the app, you could buy us a coffee.
\n
FAQ
\n
Replacements do not work after installation
\n
Please make sure you gave the accessibility access in your system preferences. If it still does not work, try restarting the app. On newer versions of macOS (including Mojave and Catalina), computer restart may be required. It seems like a bug with macOS not registering granted accessibility permission.
\n
It appears that sometimes in Mojave and Catalina the app stops working when you open the computer after a longer period of time (like after the night). Simply go to the Login screen (ctrl+cmd+q) and log back in. The issue should be resolved. If it is not, please file an issue. If you know how to fix this or the cause of the issue, we would like to know :)
Quickwords is a productivity app, to get on with your work quicker. It helps you substitute common words, phrases and paragraphs with just few key strokes. It is available on MacOS (other systems coming very soon).\nYou can check out the website and full documentation for more information.
\n
\n
Installation
\n
MacOS
\n
Download the latest release, unzip and drag Quickwords.app to your Applications folder.
\n
Linux & Windows
\n
Linux and Windows versions of the app are coming soon. In the meantime all PRs are very welcome.
\n
Privacy and Security
\n
Quickwords registers all global keyboard events, so it has an access to everything you type on the system. No data is saved on the system, and only 20 last keystrokes are remembered in the memory of the app. All your data should be secure.
\n
If you discover a security vulnerability within Quickwords, please DM @quickwordsapp. All security vulnerabilities will be promptly addressed.
\n
Contribution
\n
Contributions are very welcome. If you want, just drop a PR with any feature you'd like to see. If you want to help with the development of the app, you could buy us a coffee.
\n
FAQ
\n
Replacements do not work after installation
\n
Please make sure you gave the accessibility access in your system preferences. If it still does not work, try restarting the app. On newer versions of macOS (including Mojave and Catalina), computer restart may be required. It seems like a bug with macOS not registering granted accessibility permission.
\n
It appears that sometimes in Mojave and Catalina the app stops working when you open the computer after a longer period of time (like after the night). Simply go to the Login screen (ctrl+cmd+q) and log back in. The issue should be resolved. If it is not, please file an issue. If you know how to fix this or the cause of the issue, we would like to know :)
Go to the project directory and install dependencies:
\n
\n
cd r2e-todoworks && npm install\n
\n
$ npm run dev\n
\n
Generate the binary:
\n
\n
For Linux
\n
\n
$ npm run package-linux\n
\n
Maybe you will install some depends packages.
\n
\n
For Mac
\n
\n
$ npm run package-mac\n
\n
After that, you will see the binary in ./release folder
\n
2. How to use it ?
\n
\n\n
\n
Icon
\n
Description
\n
\n\n\n
\n
Check
\n
Click when todo done
\n
\n
\n
Fire
\n
Todo in status warning, and move on top
\n
\n
\n
Rocket
\n
Click when you want change status todo normal to warning
\n
\n
\n
Like
\n
Todo in status done and move down in list todo done
\n
\n
\n
Close
\n
Remove todo
\n
\n\n
\n
3. Contributing
\n
So you want to contribute? Fun! I love seeing new PRs for r2e-todoworks.\nIf you are thinking about working on something, feel free to make an issue beforehand so that you can make sure it'll be worth your time!
\n
4. License
\n
MIT License
\n
",
+ "readmeOriginal": "
r2e-todoworks
\n
todoworks for desktop use React, Electron and Mobx
Go to the project directory and install dependencies:
\n
\n
cd r2e-todoworks && npm install\n
\n
$ npm run dev\n
\n
Generate the binary:
\n
\n
For Linux
\n
\n
$ npm run package-linux\n
\n
Maybe you will install some depends packages.
\n
\n
For Mac
\n
\n
$ npm run package-mac\n
\n
After that, you will see the binary in ./release folder
\n
2. How to use it ?
\n
\n\n
\n
Icon
\n
Description
\n
\n\n\n
\n
Check
\n
Click when todo done
\n
\n
\n
Fire
\n
Todo in status warning, and move on top
\n
\n
\n
Rocket
\n
Click when you want change status todo normal to warning
\n
\n
\n
Like
\n
Todo in status done and move down in list todo done
\n
\n
\n
Close
\n
Remove todo
\n
\n\n
\n
3. Contributing
\n
So you want to contribute? Fun! I love seeing new PRs for r2e-todoworks.\nIf you are thinking about working on something, feel free to make an issue beforehand so that you can make sure it'll be worth your time!
The R6RC | R6 Rank Calculator takes a user's current MMR (Match Making Rating) and ELO (Points per match) to display how many matches the user has to win or lose to reach their goal.
Solve for custom goal (anywhere between 1,100 & 10,000)
\n
Calculate how many games you have to win to reach your rank goal
\n
Calculate how many games you have to lose to reach your rank goal
\n
Switch between solving for preset and custom values
\n
Automatic updates
\n
Clean UI
\n
\n
Platforms
\n
\n
This app is currently only supported on all Windows platforms
\n
\n
Pictures
\n
\n
\n
Affiliation
\n
\n
The R6RC | R6 Rank Calculator is in no way shape or form affiliated with Ubisoft and its partners. Any \"Rainbow Six: Siege\" name, logos and/or images are registered trademarks of Ubisoft.
The R6RC | R6 Rank Calculator takes a user's current MMR (Match Making Rating) and ELO (Points per match) to display how many matches the user has to win or lose to reach their goal.
Solve for custom goal (anywhere between 1,100 & 10,000)
\n
Calculate how many games you have to win to reach your rank goal
\n
Calculate how many games you have to lose to reach your rank goal
\n
Switch between solving for preset and custom values
\n
Automatic updates
\n
Clean UI
\n
\n
Platforms
\n
\n
This app is currently only supported on all Windows platforms
\n
\n
Pictures
\n
\n
\n
Affiliation
\n
\n
The R6RC | R6 Rank Calculator is in no way shape or form affiliated with Ubisoft and its partners. Any \"Rainbow Six: Siege\" name, logos and/or images are registered trademarks of Ubisoft.
Mac & Linux are on the roadmap. Kindly support the project if you would like to see more platforms and features added in the future.
\n
Features
\n
\n
\n
Clean Minimal Design
\n
\n
\n
Raider is simple, clean and easy to use.
\n
\n
\n
Download from Private Accounts
\n
\n
\n
Login with your Instagram credentials and download photos from private accounts that you follow.
\n
\n
\n
Multiple Accounts Support
\n
\n
\n
Raider allows you to add multiple accounts and switches between them seamlessly when downloading from private accounts.
\n
\n
\n
Subscribe to Accounts
\n
\n
\n
Every time you download an account using Raider, we add it to your subscribed accounts section. You can update a single account or all of them anytime.
\n
\n
\n
Edit/Delete Subscribed Accounts
\n
\n
\n
Want to change the username of a subscribed account? Maybe rename the folder name? Raider allows you to easily do so.
\n
Just long click on any account to enter Edit Mode.
\n
Support the Project
\n
Despite taking weeks to research, design and code, Raider does not contain a single ad, any trackers or in app purchases. It is completely free to use.
\n
If you would like to see more features added in the future and keep the app free, kindly support the author on Patreon.
Mac & Linux are on the roadmap. Kindly support the project if you would like to see more platforms and features added in the future.
\n
Features
\n
\n
\n
Clean Minimal Design
\n
\n
\n
Raider is simple, clean and easy to use.
\n
\n
\n
Download from Private Accounts
\n
\n
\n
Login with your Instagram credentials and download photos from private accounts that you follow.
\n
\n
\n
Multiple Accounts Support
\n
\n
\n
Raider allows you to add multiple accounts and switches between them seamlessly when downloading from private accounts.
\n
\n
\n
Subscribe to Accounts
\n
\n
\n
Every time you download an account using Raider, we add it to your subscribed accounts section. You can update a single account or all of them anytime.
\n
\n
\n
Edit/Delete Subscribed Accounts
\n
\n
\n
Want to change the username of a subscribed account? Maybe rename the folder name? Raider allows you to easily do so.
\n
Just long click on any account to enter Edit Mode.
\n
Support the Project
\n
Despite taking weeks to research, design and code, Raider does not contain a single ad, any trackers or in app purchases. It is completely free to use.
\n
If you would like to see more features added in the future and keep the app free, kindly support the author on Patreon.
This code is in no way affiliated with, authorised, maintained, sponsored or endorsed by Instagram or any of its affiliates or subsidiaries. This is an independent and unofficial Instagram app. Use it at your own risk.
\n
",
+ "readmeOriginal": "
\n \n
Ramme
\n
Unofficial Instagram Desktop App
\n
\n \n
\n
\n \n \n \n
\n\n
\n
OBS Ramme is no longer being maintained.
\n
\n
Download
\n
The latest version of Ramme for macOS, Linux and Windows is available here.
This code is in no way affiliated with, authorised, maintained, sponsored or endorsed by Instagram or any of its affiliates or subsidiaries. This is an independent and unofficial Instagram app. Use it at your own risk.
# install dependencies\nyarn install\n\n# serve with hot reload at localhost:9080\nyarn electron:serve\n\n# build electron application for production\nyarn electron:build\n\n\n# lint all JS/Vue component files in `src/`\nyarn run lint\n
# install dependencies\nyarn install\n\n# serve with hot reload at localhost:9080\nyarn electron:serve\n\n# build electron application for production\nyarn electron:build\n\n\n# lint all JS/Vue component files in `src/`\nyarn run lint\n
\nRay is a desktop HTML-powered text editor with advanced features.\n \nCreate, style, organize your personal notes!\n
\n
\n
\n
⚡ Overview
\n
Ray is a rich text editor which saves your documents in HTML format.
\n
It's intended for creating and organizing small and medium text documents like notes, thoughts, ideas and so on. Actually any text you want to save. Ray can work on any platform - macOS, Windows or Linux.
\n
You can use it as a replacement for simple text editors (e.g. supplied in your OS) and note taking apps. You get such benefits as advanced styling (thanks to HTML format) and file organizing features to have quick access to all your files.
\n
In some cases you can also consider using Ray instead of \"big\" word processing apps like Google Docs or MS Word. They have more formatting and other options than Ray but may be too heavy and less handy for medium/small text documents or those documents that don't require complex text formatting.
\n
Ray is constantly improving and more new features are added in each release!
\n
🏄 Platforms
\n
Ray is based on Electron platform and can be run on Windows, macOS and Linux.\nAt this moment you can download distributives for Windows (tested on Windows 10) and macOS (tested on macOS Sierra/High Sierra).
\nRay is a desktop HTML-powered text editor with advanced features.\n \nCreate, style, organize your personal notes!\n
\n
\n
\n
⚡ Overview
\n
Ray is a rich text editor which saves your documents in HTML format.
\n
It's intended for creating and organizing small and medium text documents like notes, thoughts, ideas and so on. Actually any text you want to save. Ray can work on any platform - macOS, Windows or Linux.
\n
You can use it as a replacement for simple text editors (e.g. supplied in your OS) and note taking apps. You get such benefits as advanced styling (thanks to HTML format) and file organizing features to have quick access to all your files.
\n
In some cases you can also consider using Ray instead of \"big\" word processing apps like Google Docs or MS Word. They have more formatting and other options than Ray but may be too heavy and less handy for medium/small text documents or those documents that don't require complex text formatting.
\n
Ray is constantly improving and more new features are added in each release!
\n
🏄 Platforms
\n
Ray is based on Electron platform and can be run on Windows, macOS and Linux.\nAt this moment you can download distributives for Windows (tested on Windows 10) and macOS (tested on macOS Sierra/High Sierra).
Rebaslight Terms, Conditions, and License Agreement
\n
Rebaslight is a product of Very Small Helm LLC, Copyright (c) 2008-2019.
\n
Rebaslight's codebase is open source and adopts the GNU AGPLv3 license.
\n
Open source does not always mean free as in gratis.\nRebaslight is free (no cost) to use as long as the \"Made with Rebaslight\" watermark appears on the output video/image.\nHowever, if you make a one-time payment of $25 USD you may remove this watermark.\nOnce paid, you personally may use Rebaslight without watermarks forever.
Rebaslight Terms, Conditions, and License Agreement
\n
Rebaslight is a product of Very Small Helm LLC, Copyright (c) 2008-2019.
\n
Rebaslight's codebase is open source and adopts the GNU AGPLv3 license.
\n
Open source does not always mean free as in gratis.\nRebaslight is free (no cost) to use as long as the \"Made with Rebaslight\" watermark appears on the output video/image.\nHowever, if you make a one-time payment of $25 USD you may remove this watermark.\nOnce paid, you personally may use Rebaslight without watermarks forever.
Visit our website https://rambox.app/#apps and select the \"Community-Edition\" filter to see all the apps available.
\n
Features
\n
\n
Multi-language.
\n
Sync your configuration between multiple computers.
\n
Master Password.
\n
Lock Rambox if you will be away for a period of time.
\n
Don't disturb mode.
\n
Reorder applications in the tab bar.
\n
Notification badge in the tab.
\n
Minimize to tray.
\n
Mute audio to specific service.
\n
Separate tabs floating to the right.
\n
Disable a service instead of remove it.
\n
Start automatically on system startup.
\n
Custom Code Injection.
\n
Keyboard Shortcuts.
\n
Proxy.
\n
Switch from horizontal to vertical tab bar.
\n
\n
Privacy
\n
No personal information will be saved
\n
Sessions will persist using the partition:persist attribute for Webviews.\nSo every time you open Rambox, your sessions will keep alive until you remove the service.
\n
Sync feature use Auth0 for Single Sign On & Token Based Authentication and to store the services that user is using (and the configuration for each service).\nYou are always welcome to check the code! ;)
Visit our website https://rambox.app/#apps and select the \"Community-Edition\" filter to see all the apps available.
\n
Features
\n
\n
Multi-language.
\n
Sync your configuration between multiple computers.
\n
Master Password.
\n
Lock Rambox if you will be away for a period of time.
\n
Don't disturb mode.
\n
Reorder applications in the tab bar.
\n
Notification badge in the tab.
\n
Minimize to tray.
\n
Mute audio to specific service.
\n
Separate tabs floating to the right.
\n
Disable a service instead of remove it.
\n
Start automatically on system startup.
\n
Custom Code Injection.
\n
Keyboard Shortcuts.
\n
Proxy.
\n
Switch from horizontal to vertical tab bar.
\n
\n
Privacy
\n
No personal information will be saved
\n
Sessions will persist using the partition:persist attribute for Webviews.\nSo every time you open Rambox, your sessions will keep alive until you remove the service.
\n
Sync feature use Auth0 for Single Sign On & Token Based Authentication and to store the services that user is using (and the configuration for each service).\nYou are always welcome to check the code! ;)
Feel free to clone it and make any changes you'd like, but I am no longer working on this project, and I'm sure several things don't work. I made this as my first realy project with AngularJS so the code is absolutely atrocious! Continue at your own risk.
\n
Reach Podcast Player
\n
\n
\n
Small Demo
\n
\n
Reach Podcast Player is a RSS-based podcast player, meaning that in order to listen to your favorite podcasts, all you have to do is copy and paste the RSS feed from the podcast.
\n
Who Is This For?
\n
This application is for all podcast listeners. Itunes, Spotify, and whereever you get your podcasts, have a ton of available podcast but every once in a while you will hear about a new podcast and search for it on your favorite podcast provider and they won't have it! with Reach, all you need is the RSS feed and you're good to go. No need to listen to podcasts accross different programs.
\n
What's Under The Hood?
\n
This was made with electron and angularjs. This is my first time using both of these items so some parts of the program are not perfectly optomized, but I plan on continuing to work on both the program itself, and my angular and electron skills in order to fuilly optimize the program.
\n
TODO:
\n
\n
Make listening queue
\n
Scale better\n
\n
With generic window sizes the program looks fine, but at smaller than average sizes, things get bad
\n
\n
\n
Redo podcast-view UI\n
\n
When a user clicks a podcast, the current UI is for the old theme, and needs to be updated
\n
\n
\n
Have the podcasts actually get the latest episodes when the user opens up the app
\n
Make a wiki page, or release distributions\n
\n
If I can figure out how, I'd like to be able to give the users notifications when a new update is available
\n
\n
\n
The Play/Pause button is very dodgy at the moment in terms of click detection, so I gotta fix that
\n
Put that data structure and algorithm class to good use
\n
Add comments everywhere
\n
\n
",
+ "readmeOriginal": "
This Project Has Been Abandoned
\n
Feel free to clone it and make any changes you'd like, but I am no longer working on this project, and I'm sure several things don't work. I made this as my first realy project with AngularJS so the code is absolutely atrocious! Continue at your own risk.
\n
Reach Podcast Player
\n
\n
\n
Small Demo
\n
\n
Reach Podcast Player is a RSS-based podcast player, meaning that in order to listen to your favorite podcasts, all you have to do is copy and paste the RSS feed from the podcast.
\n
Who Is This For?
\n
This application is for all podcast listeners. Itunes, Spotify, and whereever you get your podcasts, have a ton of available podcast but every once in a while you will hear about a new podcast and search for it on your favorite podcast provider and they won't have it! with Reach, all you need is the RSS feed and you're good to go. No need to listen to podcasts accross different programs.
\n
What's Under The Hood?
\n
This was made with electron and angularjs. This is my first time using both of these items so some parts of the program are not perfectly optomized, but I plan on continuing to work on both the program itself, and my angular and electron skills in order to fuilly optimize the program.
\n
TODO:
\n
\n
Make listening queue
\n
Scale better\n
\n
With generic window sizes the program looks fine, but at smaller than average sizes, things get bad
\n
\n
\n
Redo podcast-view UI\n
\n
When a user clicks a podcast, the current UI is for the old theme, and needs to be updated
\n
\n
\n
Have the podcasts actually get the latest episodes when the user opens up the app
\n
Make a wiki page, or release distributions\n
\n
If I can figure out how, I'd like to be able to give the users notifications when a new update is available
\n
\n
\n
The Play/Pause button is very dodgy at the moment in terms of click detection, so I gotta fix that
\n
Put that data structure and algorithm class to good use
Simple and user-friendly application for download YouTube videos.
\n\n
About
\n
Rekord is an application for download YouTube videos and convert them to MP3.\nThe latter is running on electron and Angular
\n
Features
\n
\n
Detect a YouTube link automatically in the clipboard
\n
Convert video to MP3
\n
\n
Roadmap
\n
📝 Future plans for enhancements and development:
\n
\n
Possibility to choose between download video or audio only
\n
Make the app even more fun
\n
\n
Download
\n
Rekord is available for Windows 32/64, Mac OSX and Debian/Ubuntu flavored Linux.
\n
Download the latest version from the releases page.
\n
Use
\n
Launch the app and copy any Youtube link with the right mouse button or with the combination [Ctrl] + c on Windows and Linux, [cmd] + c on Mac.
\n
\n \n
\n
\n \n
\n
No need to past Youtube link into the application. This automatically captures all youtube links validating copy in the clipboard. When this is the case, it displays the video information. Just click on the red 'save' button.
\n
\n \n
\n
A 'Rekord Download' folder is created at yout Document root.
\n
Technical
\n
Rekord is built with Electron and Angular
\n
Install
\n
To clone and run this repository, you'll need Git and Node.js (which comes with npm) installed on your computer. From your command line:
\n
# Clone this repository\ngit clone https://github.com/barbhackk/rekord.git\n# Go into the repository\ncd rekord\n# install dependencies\nnpm i
\n
Development mode
\n
This app works with a local environment variable system. This config is in .env file.\nFor development, set variables like this:
\n
PACKAGE=false\nHOST=http://localhost:4200/\n
\n
Run in first terminal npm run start for a dev server. In second terminal run npm run electron.
\n
The app will automatically reload if you change any of the source files.
\n
Production mode
\n
Set variables like this:
\n
PACKAGE=true\nHOST=http://localhost:4200/\n
\n
Run npm run electron-build.\nThe build artifacts will be stored in the dist/ directory with a production build.
\n
Build
\n
For MacOS\nRun npm run package-mac.
\n
For Windows 32/64\nRun npm run package-win.
\n
For Linux\nRun npm run package-linux.
\n
Warning :
\n
\n
This app is not a hacking tool. In case you are tempted to use Rekord to download nonfree music, you have an original copy at home. In addition, I created this application to show what I can do in application development using Angular. I therefore release myself from all responsabilities in case of improper use of this application 👍
Simple and user-friendly application for download YouTube videos.
\n\n
About
\n
Rekord is an application for download YouTube videos and convert them to MP3.\nThe latter is running on electron and Angular
\n
Features
\n
\n
Detect a YouTube link automatically in the clipboard
\n
Convert video to MP3
\n
\n
Roadmap
\n
📝 Future plans for enhancements and development:
\n
\n
Possibility to choose between download video or audio only
\n
Make the app even more fun
\n
\n
Download
\n
Rekord is available for Windows 32/64, Mac OSX and Debian/Ubuntu flavored Linux.
\n
Download the latest version from the releases page.
\n
Use
\n
Launch the app and copy any Youtube link with the right mouse button or with the combination [Ctrl] + c on Windows and Linux, [cmd] + c on Mac.
\n
\n \n
\n
\n \n
\n
No need to past Youtube link into the application. This automatically captures all youtube links validating copy in the clipboard. When this is the case, it displays the video information. Just click on the red 'save' button.
\n
\n \n
\n
A 'Rekord Download' folder is created at yout Document root.
\n
Technical
\n
Rekord is built with Electron and Angular
\n
Install
\n
To clone and run this repository, you'll need Git and Node.js (which comes with npm) installed on your computer. From your command line:
\n
# Clone this repository\ngit clone https://github.com/barbhackk/rekord.git\n# Go into the repository\ncd rekord\n# install dependencies\nnpm i
\n
Development mode
\n
This app works with a local environment variable system. This config is in .env file.\nFor development, set variables like this:
\n
PACKAGE=false\nHOST=http://localhost:4200/\n
\n
Run in first terminal npm run start for a dev server. In second terminal run npm run electron.
\n
The app will automatically reload if you change any of the source files.
\n
Production mode
\n
Set variables like this:
\n
PACKAGE=true\nHOST=http://localhost:4200/\n
\n
Run npm run electron-build.\nThe build artifacts will be stored in the dist/ directory with a production build.
\n
Build
\n
For MacOS\nRun npm run package-mac.
\n
For Windows 32/64\nRun npm run package-win.
\n
For Linux\nRun npm run package-linux.
\n
Warning :
\n
\n
This app is not a hacking tool. In case you are tempted to use Rekord to download nonfree music, you have an original copy at home. In addition, I created this application to show what I can do in application development using Angular. I therefore release myself from all responsabilities in case of improper use of this application 👍
Responsivize is an open-source, cross-platform, desktop app that is used to develop responsive websites!
\n
\n
How does it work?
\n
With Responsivize, you can test your web apps on popular devices like iPhones, Android phones, iPads, MacBooks, and you can even set custom dimension devices, that you set the dimensions for! \nThis gives you the ability to test your apps on everything from widescreen monitors to smart fridge screens!
\n
\n
This is what the Home Page looks like
\n
\n
\n
\n
Responsivize Home Page 👆
\n
\n
\n
\n
Responsivize Mobile View 👆
\n
\n
\n
\n
Responsivize Tablet View 👆
\n
\n
\n
\n
Responsivize Tablet View 👆
\n
\n
\n
\n
Responsivize Laptop View 👆
\n
\n
\n
Apart from the devices available, you can also enter the dimensions (or simply the drag webview) for any other device you want to test on in the Custom Size View!
Responsivize is an open-source, cross-platform, desktop app that is used to develop responsive websites!
\n
\n
How does it work?
\n
With Responsivize, you can test your web apps on popular devices like iPhones, Android phones, iPads, MacBooks, and you can even set custom dimension devices, that you set the dimensions for! \nThis gives you the ability to test your apps on everything from widescreen monitors to smart fridge screens!
\n
\n
This is what the Home Page looks like
\n
\n
\n
\n
Responsivize Home Page 👆
\n
\n
\n
\n
Responsivize Mobile View 👆
\n
\n
\n
\n
Responsivize Tablet View 👆
\n
\n
\n
\n
Responsivize Tablet View 👆
\n
\n
\n
\n
Responsivize Laptop View 👆
\n
\n
\n
Apart from the devices available, you can also enter the dimensions (or simply the drag webview) for any other device you want to test on in the Custom Size View!
Run npm i and npm i -g electron if you haven't already installed electron globally.
\n
If you are on windows I recommend using command prompt, as that can launch electron apps fine, while Windows Linux Subsystem has troubles launching electron apps.
\n
If you are on a mac using the mac terminal, download brew and ffmpeg-mac/ by following the instructions below.
\n
Download and setup ffmpeg-mac/ folder (instructions below).
\n
Run electron . to start the program.
\n
\n
How to install ffmpeg locally for mac (ffmpeg-mac/)
\n
\n
If you are on mac; run sh buildffmpeg.sh to create the ffmpeg-mac/ folder and statically build a version of ffmpeg that can be sandboxed and distributed to the mac apple store (mas).
\n
Verify your local ffmpeg-mac/ folder has no dynamic libraries by running this command:\notool -L ffmpeg-mac/ffmpeg | grep /usr/local
\n
If any files show up after running this command, delete or move those files, redownload the ffmpeg-mac/ folder, then run the 'otool' command again to verify there are no dynamic libraries in your local ffmpeg-mac/ folder.
\n
\n
Releasing a new version:
\n
\n
Change version number in package.json (this is the bare minimum to change).
\n
Make sure you have local vars set for GH_TOKEN, APPLEID, and APPLEIDPASS.
\n
Mac:\n
\n
Download and setup ffmpeg-mac/ folder.
\n
Mac Apple Store: Change package.json mac build targets to only contain \"mas\", verify the paths in signmasscript.sh are correct, then build & sign by running the command npm run build-mas. Upload the outputted RenderTune.pkg file to App Store Connect using Transporter, then create a new Mac Apple Store submission for review.
\n
Mac .dmg Installer (auto-updates): Change package.json build targets to contain \"dmg\", \"zip\", remove the RenderTune.pkg file we crated for MAS in the above step if it exists since we don't want to package that inside our build. Build & publish by running the command npm run build-mac-publish.
Windows Installer (auto-updates), Windows Portable, and Windows Store .appx: On Windows, make sure env vars are set by running echo %GH_TOKEN% in command prompt terminal, build nsis-web/portable/appx targets with the command npm run build-win-publish. To sign the Windows Store Build, make sure you are on a computer with the powershell electron-windows-store requirements, and then run the following powershell command to generate a signed .appx file that you can upload to the Microsoft Store review system:
Login to snap store from terminal: $ snapcraft login. Build & publish linux builds for snap and AppImage: $ npm run build-linux-publish. This will output a .snap file in the dist/ folder that you can upload using the command: $ snapcraft upload --release=stable dist/rendertune_0.3.23_amd64.snap (make sure your .snap filename is correct).
\n
\n
\n
Once all of the following steps have been followed, there should be a new RenderTune version drafted on GitHub with files uploaded for Mac, Windows, and Linux.
\n
\n
Roadmap:
\n
This list is of future updates / improvements I plan to make for RenderTune (If you can think of any features you would like, contact me and I will include them in the roadmap)
\n
\n
UI Improvements: Better render status options, more efficent code.
\n
Add API to electron app so you can trigger renders using POST route.
\n
New Feature: Append/Prepend video file to video we are rendering (Add MP4 intro/outro, add MP3 intro/outro)
\n
New Feautre: Record, split, export and tag audio files.
\n
New Feature: Upload files to YouTube / tag
\n
\n
",
+ "readmeOriginal": "
RenderTune
\n \nRenderTune is a free open-source program for mac/win/linux to combine audio + image file(s) into video files that can be uploaded to YouTube.\n
\n
Tutorial Video (Click To Watch):
\n
\n
Download
\n
RenderTune is available for free on the Mac Apple Store, Windows Store, and Linux Snap Store. Click any of the below badges to view the store page.
\n
\n\n
\n
If you want to download RenderTune without using the above stores, you can download RenderTune from the most recent Github Release.
Run npm i and npm i -g electron if you haven't already installed electron globally.
\n
If you are on windows I recommend using command prompt, as that can launch electron apps fine, while Windows Linux Subsystem has troubles launching electron apps.
\n
If you are on a mac using the mac terminal, download brew and ffmpeg-mac/ by following the instructions below.
\n
Download and setup ffmpeg-mac/ folder (instructions below).
\n
Run electron . to start the program.
\n
\n
How to install ffmpeg locally for mac (ffmpeg-mac/)
\n
\n
If you are on mac; run sh buildffmpeg.sh to create the ffmpeg-mac/ folder and statically build a version of ffmpeg that can be sandboxed and distributed to the mac apple store (mas).
\n
Verify your local ffmpeg-mac/ folder has no dynamic libraries by running this command:\notool -L ffmpeg-mac/ffmpeg | grep /usr/local
\n
If any files show up after running this command, delete or move those files, redownload the ffmpeg-mac/ folder, then run the 'otool' command again to verify there are no dynamic libraries in your local ffmpeg-mac/ folder.
\n
\n
Releasing a new version:
\n
\n
Change version number in package.json (this is the bare minimum to change).
\n
Make sure you have local vars set for GH_TOKEN, APPLEID, and APPLEIDPASS.
\n
Mac:\n
\n
Download and setup ffmpeg-mac/ folder.
\n
Mac Apple Store: Change package.json mac build targets to only contain \"mas\", verify the paths in signmasscript.sh are correct, then build & sign by running the command npm run build-mas. Upload the outputted RenderTune.pkg file to App Store Connect using Transporter, then create a new Mac Apple Store submission for review.
\n
Mac .dmg Installer (auto-updates): Change package.json build targets to contain \"dmg\", \"zip\", remove the RenderTune.pkg file we crated for MAS in the above step if it exists since we don't want to package that inside our build. Build & publish by running the command npm run build-mac-publish.
Windows Installer (auto-updates), Windows Portable, and Windows Store .appx: On Windows, make sure env vars are set by running echo %GH_TOKEN% in command prompt terminal, build nsis-web/portable/appx targets with the command npm run build-win-publish. To sign the Windows Store Build, make sure you are on a computer with the powershell electron-windows-store requirements, and then run the following powershell command to generate a signed .appx file that you can upload to the Microsoft Store review system:
Login to snap store from terminal: $ snapcraft login. Build & publish linux builds for snap and AppImage: $ npm run build-linux-publish. This will output a .snap file in the dist/ folder that you can upload using the command: $ snapcraft upload --release=stable dist/rendertune_0.3.23_amd64.snap (make sure your .snap filename is correct).
\n
\n
\n
Once all of the following steps have been followed, there should be a new RenderTune version drafted on GitHub with files uploaded for Mac, Windows, and Linux.
\n
\n
Roadmap:
\n
This list is of future updates / improvements I plan to make for RenderTune (If you can think of any features you would like, contact me and I will include them in the roadmap)
\n
\n
UI Improvements: Better render status options, more efficent code.
\n
Add API to electron app so you can trigger renders using POST route.
\n
New Feature: Append/Prepend video file to video we are rendering (Add MP4 intro/outro, add MP3 intro/outro)
\n
New Feautre: Record, split, export and tag audio files.
Element Desktop is a Matrix client for desktop platforms with Element Web at its core.
\n
First Steps
\n
Before you do anything else, fetch the dependencies:
\n
yarn install\n
\n
Fetching Element
\n
Since this package is just the Electron wrapper for Element Web, it doesn't contain any of the Element Web code,\nso the first step is to get a working copy of Element Web. There are a few ways of doing this:
\n
# Fetch the prebuilt release Element package from the element-web GitHub releases page. The version\n# fetched will be the same as the local element-desktop package.\n# We're explicitly asking for no config, so the packaged Element will have no config.json.\nyarn run fetch --noverify --cfgdir \"\"\n
\n
...or if you'd like to use GPG to verify the downloaded package:
\n
# Fetch the Element public key from the element.io web server over a secure connection and import\n# it into your local GPG keychain (you'll need GPG installed). You only need to to do this\n# once.\nyarn run fetch --importkey\n# Fetch the package and verify the signature\nyarn run fetch --cfgdir \"\"\n
\n
...or either of the above, but fetching a specific version of Element:
\n
# Fetch the prebuilt release Element package from the element-web GitHub releases page. The version\n# fetched will be the same as the local element-desktop package.\nyarn run fetch --noverify --cfgdir \"\" v1.5.6\n
\n
If you only want to run the app locally and don't need to build packages, you can\nprovide the webapp directory directly:
\n
# Assuming you've checked out and built a copy of element-web in ../element-web\nln -s ../element-web/webapp ./\n
\n
[TODO: add support for fetching develop builds, arbitrary URLs and arbitrary paths]
\n
Building
\n
Now you have a copy of Element, you're ready to build packages. If you'd just like to\nrun Element locally, skip to the next section.
\n
If you'd like to build the native modules (for searching in encrypted rooms and\nsecure storage), do this first. This will take 10 minutes or so, and will\nrequire a number of native tools to be installed, depending on your OS (eg.\nrust, tcl, make/nmake).
\n
You'll also to need to make sure you've built the native modules for the same\narchitecture as your package, so for anything more advanced than just building\nthe modules and app for the host architecture see 'Other Architectures'.
\n
If you don't need these features, you can skip this step.
\n
To just build these for your native architecture:
\n
yarn run build:native\n
\n
Now you can build the package:
\n
yarn run build\n
\n
This will do a couple of things:
\n
\n
Run the setversion script to set the local package version to match whatever\nversion of Element you installed above.
\n
Run electron-builder to build a package. The package built will match the operating system\nyou're running the build process on.
\n
\n
This build step will not build any native modules.
\n
You can also build using docker, which will always produce the linux package:
\n
# Run this once to make the docker image\nyarn run docker:setup\n\nyarn run docker:install\n# if you want to build the native modules (this will take a while)\nyarn run docker:build:native\nyarn run docker:build\n
\n
After running, the packages should be in dist/.
\n
Starting
\n
If you'd just like to run the electron app locally for development:
\n
# Install electron - we don't normally need electron itself as it's provided\n# by electron-builder when building packages\nyarn add electron\nyarn start\n
\n
Other Architectures
\n
Building the native modules will build for the host architecture (and only the\nhost architecture) by default. On Windows, this will automatically determine\nthe architecture to build for based on the environment. Make sure that you have\nall the tools required to perform the native modules build
\n
On macOS, you can build universal native modules too:
\n
yarn run build:native:universal\n
\n
...or you can build for a specific architecture:
\n
yarn run build:native --target x86_64-apple-darwin\n
\n
or
\n
yarn run build:native --target aarch64-apple-darwin\n
\n
You'll then need to create a built bundle with the same architecture.\nTo bundle a universal build for macOS, run:
\n
yarn run build:universal\n
\n
If you're on Windows, you can choose to build specifically for 32 or 64 bit:
\n
yarn run build:32\n
\n
or
\n
yarn run build:64\n
\n
Note that the native module build system keeps the different architectures\nseparate, so you can keep native modules for several architectures at the same\ntime and switch which are active using a yarn run hak copy command, passing\nthe appropriate architectures. This will error if you haven't yet built those\narchitectures. eg:
\n
yarn run build:native --target x86_64-apple-darwin\n# We've now built & linked into place native modules for Intel\nyarn run build:native --target aarch64-apple-darwin\n# We've now built Apple Silicon modules too, and linked them into place as the active ones\n\nyarn run hak copy --target x86_64-apple-darwin\n# We've now switched back to our Intel modules\nyarn run hak copy --target x86_64-apple-darwin --target aarch64-apple-darwin\n# Now our native modules are universal x86_64+aarch64 binaries\n
\n
The current set of native modules are stored in .hak/hakModules,\nso you can use this to check what architecture is currently in place, eg:
\n
$ lipo -info .hak/hakModules/keytar/build/Release/keytar.node \nArchitectures in the fat file: .hak/hakModules/keytar/build/Release/keytar.node are: x86_64 arm64 \n
\n
Config
\n
If you'd like the packaged Element to have a configuration file, you can create a\nconfig directory and place config.json in there, then specify this directory\nwith the --cfgdir option to yarn run fetch, eg:
\n
mkdir myconfig\ncp /path/to/my/config.json myconfig/\nyarn run fetch --cfgdir myconfig\n
\n
The config dir for the official Element app is in element.io. If you use this,\nyour app will auto-update itself using builds from element.io.
\n
Profiles
\n
To run multiple instances of the desktop app for different accounts, you can\nlaunch the executable with the --profile argument followed by a unique\nidentifier, e.g element-desktop --profile Work for it to run a separate profile and\nnot interfere with the default one.
\n
Alternatively, a custom location for the profile data can be specified using the\n--profile-dir flag followed by the desired path.
\n
User-specified config.json
\n
\n
%APPDATA%\\$NAME\\config.json on Windows
\n
$XDG_CONFIG_HOME\\$NAME\\config.json or ~/.config/$NAME/config.json on Linux
\n
~/Library/Application Support/$NAME/config.json on macOS
\n
\n
In the paths above, $NAME is typically Element, unless you use --profile $PROFILE in which case it becomes Element-$PROFILE, or it is using one of\nthe above created by a pre-1.7 install, in which case it will be Riot or\nRiot-$PROFILE.
If you run into any bugs or have feedback you'd like to share, please let us know on GitHub.
\n
To help avoid duplicate issues, please view existing issues first (and add a +1) or create a new issue if you can't find it. Please note that this issue tracker is associated with the element-web repo, but is also applied to the code in this repo as well.
\n
",
+ "readmeOriginal": "
Element Desktop
\n
Element Desktop is a Matrix client for desktop platforms with Element Web at its core.
\n
First Steps
\n
Before you do anything else, fetch the dependencies:
\n
yarn install\n
\n
Fetching Element
\n
Since this package is just the Electron wrapper for Element Web, it doesn't contain any of the Element Web code,\nso the first step is to get a working copy of Element Web. There are a few ways of doing this:
\n
# Fetch the prebuilt release Element package from the element-web GitHub releases page. The version\n# fetched will be the same as the local element-desktop package.\n# We're explicitly asking for no config, so the packaged Element will have no config.json.\nyarn run fetch --noverify --cfgdir \"\"\n
\n
...or if you'd like to use GPG to verify the downloaded package:
\n
# Fetch the Element public key from the element.io web server over a secure connection and import\n# it into your local GPG keychain (you'll need GPG installed). You only need to to do this\n# once.\nyarn run fetch --importkey\n# Fetch the package and verify the signature\nyarn run fetch --cfgdir \"\"\n
\n
...or either of the above, but fetching a specific version of Element:
\n
# Fetch the prebuilt release Element package from the element-web GitHub releases page. The version\n# fetched will be the same as the local element-desktop package.\nyarn run fetch --noverify --cfgdir \"\" v1.5.6\n
\n
If you only want to run the app locally and don't need to build packages, you can\nprovide the webapp directory directly:
\n
# Assuming you've checked out and built a copy of element-web in ../element-web\nln -s ../element-web/webapp ./\n
\n
[TODO: add support for fetching develop builds, arbitrary URLs and arbitrary paths]
\n
Building
\n
Now you have a copy of Element, you're ready to build packages. If you'd just like to\nrun Element locally, skip to the next section.
\n
If you'd like to build the native modules (for searching in encrypted rooms and\nsecure storage), do this first. This will take 10 minutes or so, and will\nrequire a number of native tools to be installed, depending on your OS (eg.\nrust, tcl, make/nmake).
\n
You'll also to need to make sure you've built the native modules for the same\narchitecture as your package, so for anything more advanced than just building\nthe modules and app for the host architecture see 'Other Architectures'.
\n
If you don't need these features, you can skip this step.
\n
To just build these for your native architecture:
\n
yarn run build:native\n
\n
Now you can build the package:
\n
yarn run build\n
\n
This will do a couple of things:
\n
\n
Run the setversion script to set the local package version to match whatever\nversion of Element you installed above.
\n
Run electron-builder to build a package. The package built will match the operating system\nyou're running the build process on.
\n
\n
This build step will not build any native modules.
\n
You can also build using docker, which will always produce the linux package:
\n
# Run this once to make the docker image\nyarn run docker:setup\n\nyarn run docker:install\n# if you want to build the native modules (this will take a while)\nyarn run docker:build:native\nyarn run docker:build\n
\n
After running, the packages should be in dist/.
\n
Starting
\n
If you'd just like to run the electron app locally for development:
\n
# Install electron - we don't normally need electron itself as it's provided\n# by electron-builder when building packages\nyarn add electron\nyarn start\n
\n
Other Architectures
\n
Building the native modules will build for the host architecture (and only the\nhost architecture) by default. On Windows, this will automatically determine\nthe architecture to build for based on the environment. Make sure that you have\nall the tools required to perform the native modules build
\n
On macOS, you can build universal native modules too:
\n
yarn run build:native:universal\n
\n
...or you can build for a specific architecture:
\n
yarn run build:native --target x86_64-apple-darwin\n
\n
or
\n
yarn run build:native --target aarch64-apple-darwin\n
\n
You'll then need to create a built bundle with the same architecture.\nTo bundle a universal build for macOS, run:
\n
yarn run build:universal\n
\n
If you're on Windows, you can choose to build specifically for 32 or 64 bit:
\n
yarn run build:32\n
\n
or
\n
yarn run build:64\n
\n
Note that the native module build system keeps the different architectures\nseparate, so you can keep native modules for several architectures at the same\ntime and switch which are active using a yarn run hak copy command, passing\nthe appropriate architectures. This will error if you haven't yet built those\narchitectures. eg:
\n
yarn run build:native --target x86_64-apple-darwin\n# We've now built & linked into place native modules for Intel\nyarn run build:native --target aarch64-apple-darwin\n# We've now built Apple Silicon modules too, and linked them into place as the active ones\n\nyarn run hak copy --target x86_64-apple-darwin\n# We've now switched back to our Intel modules\nyarn run hak copy --target x86_64-apple-darwin --target aarch64-apple-darwin\n# Now our native modules are universal x86_64+aarch64 binaries\n
\n
The current set of native modules are stored in .hak/hakModules,\nso you can use this to check what architecture is currently in place, eg:
\n
$ lipo -info .hak/hakModules/keytar/build/Release/keytar.node \nArchitectures in the fat file: .hak/hakModules/keytar/build/Release/keytar.node are: x86_64 arm64 \n
\n
Config
\n
If you'd like the packaged Element to have a configuration file, you can create a\nconfig directory and place config.json in there, then specify this directory\nwith the --cfgdir option to yarn run fetch, eg:
\n
mkdir myconfig\ncp /path/to/my/config.json myconfig/\nyarn run fetch --cfgdir myconfig\n
\n
The config dir for the official Element app is in element.io. If you use this,\nyour app will auto-update itself using builds from element.io.
\n
Profiles
\n
To run multiple instances of the desktop app for different accounts, you can\nlaunch the executable with the --profile argument followed by a unique\nidentifier, e.g element-desktop --profile Work for it to run a separate profile and\nnot interfere with the default one.
\n
Alternatively, a custom location for the profile data can be specified using the\n--profile-dir flag followed by the desired path.
\n
User-specified config.json
\n
\n
%APPDATA%\\$NAME\\config.json on Windows
\n
$XDG_CONFIG_HOME\\$NAME\\config.json or ~/.config/$NAME/config.json on Linux
\n
~/Library/Application Support/$NAME/config.json on macOS
\n
\n
In the paths above, $NAME is typically Element, unless you use --profile $PROFILE in which case it becomes Element-$PROFILE, or it is using one of\nthe above created by a pre-1.7 install, in which case it will be Riot or\nRiot-$PROFILE.
If you run into any bugs or have feedback you'd like to share, please let us know on GitHub.
\n
To help avoid duplicate issues, please view existing issues first (and add a +1) or create a new issue if you can't find it. Please note that this issue tracker is associated with the element-web repo, but is also applied to the code in this repo as well.
# install dependencies\nnpm install\n\n# serve with hot reload at localhost:9080\nnpm run dev\n\n# build electron application for production\nnpm run build\n\n
\n\n
This project was generated with electron-vue using vue-cli. Documentation about the original structure can be found here.
# install dependencies\nnpm install\n\n# serve with hot reload at localhost:9080\nnpm run dev\n\n# build electron application for production\nnpm run build\n\n
\n\n
This project was generated with electron-vue using vue-cli. Documentation about the original structure can be found here.
Runlet is a cloud-based job manager that offers device synchronization and reliable message delivery in a network of connected devices even after connectivity issues. This repository is where new releases are published, bugs are reported, and features are requested.
\n
Download
\n
All available distributions and versions can be found at releases.
\n
Contributing
\n
There are a couple of ways in which you can contribute to the app, for example:
Runlet is a cloud-based job manager that offers device synchronization and reliable message delivery in a network of connected devices even after connectivity issues. This repository is where new releases are published, bugs are reported, and features are requested.
\n
Download
\n
All available distributions and versions can be found at releases.
\n
Contributing
\n
There are a couple of ways in which you can contribute to the app, for example:
A desktop client for JioSaavn, based on the official JioSaavn web app. Built with Electron.
\n
\n
This is NOT an official product. This project does not attempt to reverse engineer the JioSaavn API or attempt to reimplement any part of the JioSaavn client. Any communication between the user and JioSaavn servers is handled by official JioSaavn Web itself; this is just a native wrapper for JioSaavn Web, like a browser.
\n
Features
\n
\n
\n
Cross platform. (OSX, Windows, Linux)
\n
\n
\n
Native notifications.
\n
\n
\n
Media Shortcuts/ Keybindings for music player
\n
\n
leftArrow for Next song
\n
rightArrow for Previous song
\n
Space for pause/play
\n
\n
\n
\n
A couple of things can be configured:
\n
\n
Proxy settings connect to JioSaavn web
\n
\n
Not working:
\n
\n
Login
\n
\n
\n
\n
Planned features:
\n
\n
Auto-launch on OS startup.
\n
\n
Installation
\n
Download and run the Saavn file from the latest release.
\n
Note: Windows and Linux versions are test release.
\n
How to use in Linux
\n
In order to execute the program in Linux, first you should give it permission to the App:
\n
sudo chmod u+x Saadhn \n./Saadhn
\n
Contributions
\n
Contributions are welcome! For feature requests and bug reports please submit an issue.
\n
Build
\n
To build from the source, run the following commands:
\n
npm install \nnpm run build
\n
## Building Windows build from non-Windows platforms
\n
Wine needs to be installed. On OS X, it is installable via Homebrew: \nbrew install wine
A desktop client for JioSaavn, based on the official JioSaavn web app. Built with Electron.
\n
\n
This is NOT an official product. This project does not attempt to reverse engineer the JioSaavn API or attempt to reimplement any part of the JioSaavn client. Any communication between the user and JioSaavn servers is handled by official JioSaavn Web itself; this is just a native wrapper for JioSaavn Web, like a browser.
\n
Features
\n
\n
\n
Cross platform. (OSX, Windows, Linux)
\n
\n
\n
Native notifications.
\n
\n
\n
Media Shortcuts/ Keybindings for music player
\n
\n
leftArrow for Next song
\n
rightArrow for Previous song
\n
Space for pause/play
\n
\n
\n
\n
A couple of things can be configured:
\n
\n
Proxy settings connect to JioSaavn web
\n
\n
Not working:
\n
\n
Login
\n
\n
\n
\n
Planned features:
\n
\n
Auto-launch on OS startup.
\n
\n
Installation
\n
Download and run the Saavn file from the latest release.
\n
Note: Windows and Linux versions are test release.
\n
How to use in Linux
\n
In order to execute the program in Linux, first you should give it permission to the App:
\n
sudo chmod u+x Saadhn \n./Saadhn
\n
Contributions
\n
Contributions are welcome! For feature requests and bug reports please submit an issue.
\n
Build
\n
To build from the source, run the following commands:
\n
npm install \nnpm run build
\n
## Building Windows build from non-Windows platforms
\n
Wine needs to be installed. On OS X, it is installable via Homebrew: \nbrew install wine
ScanCode Workbench provides an advanced visual UI to help you quickly evaluate\nlicense and other notices identified by\nScanCode and record your conclusion\nabout the effective license(s) for a component.\nScanCode detects licenses, copyrights\nand other interesting information in your code. ScanCode Workbench allows you to take the\nscan results from ScanCode and create conclusions. By creating these conclusions\nwithin your codebase, you are creating a software inventory of your product.\nThe conclusions (Concluded License, Concluded Owner, etc.) you make when\ncreating your conclusion can be exported as a JSON file or saved as SQLite file.
\n
ScanCode Workbench is based on\nElectron and will be the primary desktop/GUI tool\nfor using nexB’s AboutCode tools. This app\nworks on Windows, OS X and Linux operating systems.
\n
\n
Using
\n
\n
You can download the latest release\nfor your operating system or build it yourself (see below). Once downloaded, you\ncan find ScanCode-Workbench under dist/ScanCode-Workbench-<os>-x64-<version>.
We have provided a set of sample scans that you can quickly review in\nScanCode Workbench in order to get a sense of its functionality and the types of\ninformation captured by a scan. The samples are located at\nhttps://github.com/nexB/scancode-workbench/tree/develop/samples.
\n
Import a ScanCode JSON file, and see what components are in your software! See\nthe documentation for more\ninformation on how to use ScanCode Workbench.
\n
\n
\n
Building
\n
You'll need Node.js (which comes with npm)\ninstalled on your computer in order to build this app. For a list of platform\nspecific requirements, see the Building section of the documentation.\nThen, from your command line:
\n
.\\node_modules\\.bin\\electron-rebuild.cmd\n\n# Run the app\n$ npm start\n\">
# Clone this repository\n$ git clone https://github.com/nexB/scancode-workbench.git\n\n# Go into the repository\n$ cd scancode-workbench\n\n# Install dependencies and run the app\n$ npm install\n\n# Rebuild native Node.js modules against the app version of Node.js\n# MacOS, Linux and Git Bash on Windows\n$ $(npm bin)/electron-rebuild\n# Windows except for Git Bash\n> .\\node_modules\\.bin\\electron-rebuild.cmd\n\n# Run the app\n$ npm start
\n
Release Instructions
\n
You can build a dist directory containing executables for any one of three\ntarget platforms by running:
\n
$ python build.py
\n
After building is done, you can find ScanCode-Workbench under\ndist/ScanCode-Workbench-<os>-x64-<version>. Archives (tar.gz and .zip) are\nalso built.
\n
Note: A build for any of the three target platforms must be executed on the\ntargeted platform.
\n
Testing
\n
Test ABCM functionality using:
\n
$ npm test
\n
License
\n
\n
Apache-2.0
\n
Multiple licenses (LGPL, MIT, BSD, etc.) for third-party components.
\n
\n
See the NOTICE file for more details.
\n
Support
\n
If you have a question, a suggestion or find a bug, enter an issue.
ScanCode Workbench provides an advanced visual UI to help you quickly evaluate\nlicense and other notices identified by\nScanCode and record your conclusion\nabout the effective license(s) for a component.\nScanCode detects licenses, copyrights\nand other interesting information in your code. ScanCode Workbench allows you to take the\nscan results from ScanCode and create conclusions. By creating these conclusions\nwithin your codebase, you are creating a software inventory of your product.\nThe conclusions (Concluded License, Concluded Owner, etc.) you make when\ncreating your conclusion can be exported as a JSON file or saved as SQLite file.
\n
ScanCode Workbench is based on\nElectron and will be the primary desktop/GUI tool\nfor using nexB’s AboutCode tools. This app\nworks on Windows, OS X and Linux operating systems.
\n
\n
Using
\n
\n
You can download the latest release\nfor your operating system or build it yourself (see below). Once downloaded, you\ncan find ScanCode-Workbench under dist/ScanCode-Workbench-<os>-x64-<version>.
We have provided a set of sample scans that you can quickly review in\nScanCode Workbench in order to get a sense of its functionality and the types of\ninformation captured by a scan. The samples are located at\nhttps://github.com/nexB/scancode-workbench/tree/develop/samples.
\n
Import a ScanCode JSON file, and see what components are in your software! See\nthe documentation for more\ninformation on how to use ScanCode Workbench.
\n
\n
\n
Building
\n
You'll need Node.js (which comes with npm)\ninstalled on your computer in order to build this app. For a list of platform\nspecific requirements, see the Building section of the documentation.\nThen, from your command line:
\n
# Clone this repository\n$ git clone https://github.com/nexB/scancode-workbench.git\n\n# Go into the repository\n$ cd scancode-workbench\n\n# Install dependencies and run the app\n$ npm install\n\n# Rebuild native Node.js modules against the app version of Node.js\n# MacOS, Linux and Git Bash on Windows\n$ $(npm bin)/electron-rebuild\n# Windows except for Git Bash\n> .\\node_modules\\.bin\\electron-rebuild.cmd\n\n# Run the app\n$ npm start
\n
Release Instructions
\n
You can build a dist directory containing executables for any one of three\ntarget platforms by running:
\n
$ python build.py
\n
After building is done, you can find ScanCode-Workbench under\ndist/ScanCode-Workbench-<os>-x64-<version>. Archives (tar.gz and .zip) are\nalso built.
\n
Note: A build for any of the three target platforms must be executed on the\ntargeted platform.
\n
Testing
\n
Test ABCM functionality using:
\n
$ npm test
\n
License
\n
\n
Apache-2.0
\n
Multiple licenses (LGPL, MIT, BSD, etc.) for third-party components.
\n
\n
See the NOTICE file for more details.
\n
Support
\n
If you have a question, a suggestion or find a bug, enter an issue.
We wanted to make a really simple, but useful application to manage your lessons/activities, so we made it.
\n
🆕 New features
\n
\n
New, responsive UI
\n
Export / import timetables
\n
You can set images as background and even add multiple images for slideshow
\n
\n
📝Current features
\n
\n
Add, edit, delete lessons/activities. You can set a unique color for each lessosn/activity, you can use your own colors, but for the best experience we recommend to use flatuicolors.com
\n
You can even add multiple weeks, so you can change the week that you want to see
\n
You can set the background for static colors and multiple images with changeable transition time\n
We wanted to make a really simple, but useful application to manage your lessons/activities, so we made it.
\n
🆕 New features
\n
\n
New, responsive UI
\n
Export / import timetables
\n
You can set images as background and even add multiple images for slideshow
\n
\n
📝Current features
\n
\n
Add, edit, delete lessons/activities. You can set a unique color for each lessosn/activity, you can use your own colors, but for the best experience we recommend to use flatuicolors.com
\n
You can even add multiple weeks, so you can change the week that you want to see
\n
You can set the background for static colors and multiple images with changeable transition time\n
Invoices are renamed by date and timestamp. E.g. Jan-30-2018-9am.PDF
\n
Option to filter invoices by a specific month(s) or year(s)
\n
Supported on Windows & Mac
\n
Lyft Integration
\n
Expenditure stat of your trip depending on your filter you choose
\n
Categorizes Uber and Uber Eats receipts
\n
Outlook integration for Lyft
\n
\n
Why
\n
Ride Receipts is essential for anyone who relies on Uber/Lyft for business travel. Whether you’re self-employed or get reimbursed by your employer for travel, you’ll likely need proper tax invoices for accounting purposes.
\n
This was a major pain point for us every year around tax season. Since the current Uber website does not allow you to download all of your receipts for the year at once, you have to manually download, rename, and organize each of your invoices. So you’re either doing it one by one, or if you have a business profile, you still have to download them one month at a time. Uber’s monthly business travel report is great for keeping track of your trips, but these aren’t actual receipts.
\n
We created Ride Receipts to address this painfully inefficient process, and now we’re sharing it with everyone who could benefit from this time-saving tool.
\n
Solution
\n
Automation! Ride Receipts is an open-source desktop app that automates the process of downloading, renaming, and organizing your Uber/Lyft receipts. Rather than logging into your Uber account to scan through each of your trips and manually download each receipt, Ride Receipts will automatically do it for you.
\n
Your invoices will be named according to the date and time of your trip, and organized by user account, year and month, in neat and tidy folders on your computer.
\n
Requirements
\n
For Uber and Lyft we utilize Gmail API to scan your email only for receipts.\nMake sure your system has latest Chrome Browser installed (v69 or above).
\n
Ride Receipts works on both Mac and PC.
\n
Security
\n
Ride Receipts does not store your login credentials, personal information or any other data. This application operates without a database. It only scans email for receipts with read-only access.
\n
Developer Notes
\n
Build Setup
\n
# install dependencies\nnpm install\n\n# Navigate to renderer directory and copy config example to config.js and set Google Client Id and Outlook Id\ncp config.example.js config.js\n\n# serve with hot reload at localhost:9080\nnpm run dev\n\n# build electron application for production\nnpm run build\n\n# build electron application for cross platform\nnpm run build -mwl (i.e m - macos , w - windows & l - Linux)\n\n\n# lint all JS/Vue component files in `src/`\nnpm run lint\n
Please feel free to give us suggestions or report a bug by creating a new issue via Github or messaging on Twitter: @ridereceipts. You can also email us at hello@ridereceipts.io.
\n
License
\n
License by default is LGPLv3. After purchase please refer COMM-LICENSE is applied
Invoices are renamed by date and timestamp. E.g. Jan-30-2018-9am.PDF
\n
Option to filter invoices by a specific month(s) or year(s)
\n
Supported on Windows & Mac
\n
Lyft Integration
\n
Expenditure stat of your trip depending on your filter you choose
\n
Categorizes Uber and Uber Eats receipts
\n
Outlook integration for Lyft
\n
\n
Why
\n
Ride Receipts is essential for anyone who relies on Uber/Lyft for business travel. Whether you’re self-employed or get reimbursed by your employer for travel, you’ll likely need proper tax invoices for accounting purposes.
\n
This was a major pain point for us every year around tax season. Since the current Uber website does not allow you to download all of your receipts for the year at once, you have to manually download, rename, and organize each of your invoices. So you’re either doing it one by one, or if you have a business profile, you still have to download them one month at a time. Uber’s monthly business travel report is great for keeping track of your trips, but these aren’t actual receipts.
\n
We created Ride Receipts to address this painfully inefficient process, and now we’re sharing it with everyone who could benefit from this time-saving tool.
\n
Solution
\n
Automation! Ride Receipts is an open-source desktop app that automates the process of downloading, renaming, and organizing your Uber/Lyft receipts. Rather than logging into your Uber account to scan through each of your trips and manually download each receipt, Ride Receipts will automatically do it for you.
\n
Your invoices will be named according to the date and time of your trip, and organized by user account, year and month, in neat and tidy folders on your computer.
\n
Requirements
\n
For Uber and Lyft we utilize Gmail API to scan your email only for receipts.\nMake sure your system has latest Chrome Browser installed (v69 or above).
\n
Ride Receipts works on both Mac and PC.
\n
Security
\n
Ride Receipts does not store your login credentials, personal information or any other data. This application operates without a database. It only scans email for receipts with read-only access.
\n
Developer Notes
\n
Build Setup
\n
# install dependencies\nnpm install\n\n# Navigate to renderer directory and copy config example to config.js and set Google Client Id and Outlook Id\ncp config.example.js config.js\n\n# serve with hot reload at localhost:9080\nnpm run dev\n\n# build electron application for production\nnpm run build\n\n# build electron application for cross platform\nnpm run build -mwl (i.e m - macos , w - windows & l - Linux)\n\n\n# lint all JS/Vue component files in `src/`\nnpm run lint\n
Please feel free to give us suggestions or report a bug by creating a new issue via Github or messaging on Twitter: @ridereceipts. You can also email us at hello@ridereceipts.io.
\n
License
\n
License by default is LGPLv3. After purchase please refer COMM-LICENSE is applied
ScreenTray is a macOS application for capturing, annotating and sharing screenshots. Quickly add comments, highlight what matters or blur any sensitive content. Upload screenshots to Google Drive or Dropbox. Copy screenshots to the clipboard and paste them directly into Slack, WhatsApp, Facebook, Twitter, Gmail, Jira, Trello and lots of other apps.
ScreenTray is a macOS application for capturing, annotating and sharing screenshots. Quickly add comments, highlight what matters or blur any sensitive content. Upload screenshots to Google Drive or Dropbox. Copy screenshots to the clipboard and paste them directly into Slack, WhatsApp, Facebook, Twitter, Gmail, Jira, Trello and lots of other apps.
ScreenCat is an open source screen sharing + remote collaboration application. You can share your desktop with someone else while letting them share your mouse and keyboard remotely. Right now it is not as good as commercial alternatives, mostly because this is a hobby project and not a for-profit project. The big difference is that you can send PRs to make ScreenCat better!
\n
\n
ScreenCat is named after cats, but also for the idea of 'catting' a screen (as in unix cat). It has two C/C++ dependencies, Electron (which includes node.js) and robotjs for creating mouse + keyboard events.
\n
ScreenCat is currently ALPHA STATUS and is intended for developers/early adopters. Check out the Issues to get involved. ScreenCat is a volunteer run project, your contributions and improvements are welcome!
\n
To download the latest build visit the releases page. Builds for your OS may not be available and you may have to build it yourself, sorry.
\n
\n
\n
\n
How it works
\n
The app itself is written in JS, HTML and CSS. The CSS is from tachyons. The app is wrapped up in an electron application using the menubar module.
\n
One really cool feature of ScreenCat is the ability to screenshare with a normal browser. Using our remote control page you can send your invite code to a web user and they can remote control your computer. Currently Google Chrome is recommended. You can also screenshare between 2 ScreenCat.app users.
\n
\n
The screensharing takes advantage of an experimental feature built in to Chromium's WebRTC implementation called chromeMediaSource: 'screen'. This lets you share the host computers entire desktop over a WebRTC video channel. On the remote end, you can render the data in a <video> element.
\n
To initiate the WebRTC connection both peers must swap sdp connection information payloads. After compression, you can get the payloads down to about 1K. This is technically small enough to copy/paste through e.g. SMS, but it's on the larger side. Also you have to do a full round trip, where user A sends their code to user B, and vice versa before a connection can be established.
\n
To simplify the connection process the app uses cat-lobby, a minimal lobby server using HTTP and Server-Sent Events. This simply lets users swap SDP payloads without having to copy/paste large text blocks back and forth.
\n
To hook up the mouse and keyboard, the remote end uses standard mousedown and keydown events and sends them over a WebRTC data channel to the host. On the host side the app must synthesize mouse and keyboard events on the host OS. This is the tricky part, and the only part where a custom native node addon (C++) is required. Luckily I found the robotjs project which while still being relatively new and rough around the edges still got the job done after some modifications.
\n
Currently the app works best between Macs, mostly because that is what the original author used. However, you can build it for Linux or Windows too.
\n
The motivation for making ScreenCat came from a lack of open source + easily hackable screen sharing tools. I collaborate with many remote open source developers and being able to customize the software we use to work together is important to me. ScreenCat will remain free and BSD licensed, and your contributions are welcome! Check out the issues, especially those marked as help wanted.
\n
Building the app
\n
For mac/linux:
\n
npm install # installs electron and all the deps\nnpm start # runs the app in the electron wrapper\nnpm run build # builds the mac app
\n
For windows:
\n
You will need Visual studio C++ installed so you can build the native modules. Here are instructions for cmd.exe:
the electron app UI and main code are app.html, app.js and screen.js
\n
the remote web viewer UI and core are remote.js and remote.html
\n
peer.js and connect.js are used by both the electron app and the web viewer
\n
\n
",
+ "readmeOriginal": "
ScreenCat
\n
\n
ScreenCat is an open source screen sharing + remote collaboration application. You can share your desktop with someone else while letting them share your mouse and keyboard remotely. Right now it is not as good as commercial alternatives, mostly because this is a hobby project and not a for-profit project. The big difference is that you can send PRs to make ScreenCat better!
\n
\n
ScreenCat is named after cats, but also for the idea of 'catting' a screen (as in unix cat). It has two C/C++ dependencies, Electron (which includes node.js) and robotjs for creating mouse + keyboard events.
\n
ScreenCat is currently ALPHA STATUS and is intended for developers/early adopters. Check out the Issues to get involved. ScreenCat is a volunteer run project, your contributions and improvements are welcome!
\n
To download the latest build visit the releases page. Builds for your OS may not be available and you may have to build it yourself, sorry.
\n
\n
\n
\n
How it works
\n
The app itself is written in JS, HTML and CSS. The CSS is from tachyons. The app is wrapped up in an electron application using the menubar module.
\n
One really cool feature of ScreenCat is the ability to screenshare with a normal browser. Using our remote control page you can send your invite code to a web user and they can remote control your computer. Currently Google Chrome is recommended. You can also screenshare between 2 ScreenCat.app users.
\n
\n
The screensharing takes advantage of an experimental feature built in to Chromium's WebRTC implementation called chromeMediaSource: 'screen'. This lets you share the host computers entire desktop over a WebRTC video channel. On the remote end, you can render the data in a <video> element.
\n
To initiate the WebRTC connection both peers must swap sdp connection information payloads. After compression, you can get the payloads down to about 1K. This is technically small enough to copy/paste through e.g. SMS, but it's on the larger side. Also you have to do a full round trip, where user A sends their code to user B, and vice versa before a connection can be established.
\n
To simplify the connection process the app uses cat-lobby, a minimal lobby server using HTTP and Server-Sent Events. This simply lets users swap SDP payloads without having to copy/paste large text blocks back and forth.
\n
To hook up the mouse and keyboard, the remote end uses standard mousedown and keydown events and sends them over a WebRTC data channel to the host. On the host side the app must synthesize mouse and keyboard events on the host OS. This is the tricky part, and the only part where a custom native node addon (C++) is required. Luckily I found the robotjs project which while still being relatively new and rough around the edges still got the job done after some modifications.
\n
Currently the app works best between Macs, mostly because that is what the original author used. However, you can build it for Linux or Windows too.
\n
The motivation for making ScreenCat came from a lack of open source + easily hackable screen sharing tools. I collaborate with many remote open source developers and being able to customize the software we use to work together is important to me. ScreenCat will remain free and BSD licensed, and your contributions are welcome! Check out the issues, especially those marked as help wanted.
\n
Building the app
\n
For mac/linux:
\n
npm install # installs electron and all the deps\nnpm start # runs the app in the electron wrapper\nnpm run build # builds the mac app
\n
For windows:
\n
You will need Visual studio C++ installed so you can build the native modules. Here are instructions for cmd.exe:
Welcome to SeeQL (beta): An easy-to-use desktop application that helps you visualize your database tables (including all foreign and primary key relationships), to quickly generate complex queries.
Note: For now, you might need to go to your security settings to allow the app run on your system to allow the application to run.
\n
Or from the terminal, run:
\n
git clone https://github.com/oslabs-beta/seeql.git\ncd seeql\nyarn\nyarn run build\nyarn start\n\n
\n
Features
\n
Logging In
\n
You have the option to log in with a postgres:// URI connection string, or enter your database credentials individually.
\n
\n
Viewing Database Information
\n
After logging in, you'll see three sections - the side panel, the input box, and the database tables section. In the tables section, when you hover over a primary key in a table, any references to this primary key in other tables will be highlighted. Similarly, if you hover over a foreign key in a table, its related primary key will be highlighted.
\n
Click on any table's info icon to view its information in the side panel.
\n
Choose the Search option above the input box to filter which tables will be displayed. You can pin tables to the top of the page for your convinience by clicking on any table's pin icon.
\n
\n
Generating SQL queries & Viewing the results
\n
You can write a SQL SELECT query in the SQL input box, or automatically generate a query by clicking on the rows of a table. Once your query is complete, click execute query. If your query has any errors, an error message will display telling you exactly where the error occured.
\n
\n
After clicking execute, you'll be able to see your results in the Results section. Clicking on a column name will sort your table data accordingly.\nYou can filter which rows are visible by clicking the search icon next to each column name.
Welcome to SeeQL (beta): An easy-to-use desktop application that helps you visualize your database tables (including all foreign and primary key relationships), to quickly generate complex queries.
Note: For now, you might need to go to your security settings to allow the app run on your system to allow the application to run.
\n
Or from the terminal, run:
\n
git clone https://github.com/oslabs-beta/seeql.git\ncd seeql\nyarn\nyarn run build\nyarn start\n\n
\n
Features
\n
Logging In
\n
You have the option to log in with a postgres:// URI connection string, or enter your database credentials individually.
\n
\n
Viewing Database Information
\n
After logging in, you'll see three sections - the side panel, the input box, and the database tables section. In the tables section, when you hover over a primary key in a table, any references to this primary key in other tables will be highlighted. Similarly, if you hover over a foreign key in a table, its related primary key will be highlighted.
\n
Click on any table's info icon to view its information in the side panel.
\n
Choose the Search option above the input box to filter which tables will be displayed. You can pin tables to the top of the page for your convinience by clicking on any table's pin icon.
\n
\n
Generating SQL queries & Viewing the results
\n
You can write a SQL SELECT query in the SQL input box, or automatically generate a query by clicking on the rows of a table. Once your query is complete, click execute query. If your query has any errors, an error message will display telling you exactly where the error occured.
\n
\n
After clicking execute, you'll be able to see your results in the Results section. Clicking on a column name will sort your table data accordingly.\nYou can filter which rows are visible by clicking the search icon next to each column name.
SEOBrowse allows you to conduct accurate international SERP audits in our unique custom-built browser interface. SEOBrowse provides you with a guaranteed clean search environment to research, analysis and report on all aspects of the search results.
\n
Key features include:
\n
\n
Search results for any city, state or country in the world.
\n
True search results guaranteed by a built-in global VPN and a clean search session.
\n
Support for all major search engines (Google, Youtube, Bing, DuckDuckGo, Baidu and Yandex).
\n
Helpful search history, screenshot history and SERP export tooling.
\n
Available for both Windows and Mac.
\n
\n
Google SERP checker
\n
SEOBrowse is a browser build around keyword research. Every search query is clean, proxied through a geo-specific VPN, and runs in a clean browser session giving you trustworthy accurate search results. This matches with what the majority of users see and what automatic rank checkers (ahrefs, semrush, moz) report. Every search has easy access to your specific city, state, country, language and device.
SEOBrowse allows you to conduct accurate international SERP audits in our unique custom-built browser interface. SEOBrowse provides you with a guaranteed clean search environment to research, analysis and report on all aspects of the search results.
\n
Key features include:
\n
\n
Search results for any city, state or country in the world.
\n
True search results guaranteed by a built-in global VPN and a clean search session.
\n
Support for all major search engines (Google, Youtube, Bing, DuckDuckGo, Baidu and Yandex).
\n
Helpful search history, screenshot history and SERP export tooling.
\n
Available for both Windows and Mac.
\n
\n
Google SERP checker
\n
SEOBrowse is a browser build around keyword research. Every search query is clean, proxied through a geo-specific VPN, and runs in a clean browser session giving you trustworthy accurate search results. This matches with what the majority of users see and what automatic rank checkers (ahrefs, semrush, moz) report. Every search has easy access to your specific city, state, country, language and device.
Serina can be downloaded here. Available versions for Linux, Windows (64bits) and Mac OS.
\n
To use, unzip in the desired location and execute Serina.
\n
If you need a different version, please follow the development instructions to make your own build from the source code
\n
📖 Usage
\n
Serina allows you to create translations for each language, you can access the different languages by clicking on their map in the languages list.
\n
Create translation for a language
\n
This page displays the list of languages and allows you to add a new language via a form using the ISO 639-1 language code. Example:\"FR\" or \"EN\".
\n
The display of the languages is available in two versions (card list or list) that can be set on the parameter page. The number of elements in a language is displayed under the name of the language.
\n
Edit translation
\n
This page displays the groups and translations of the first level of the translation and then recursively displays the sub-levels via access to a group allowing access to its content.
\n
Adding a group is done via a modal that allows you to enter the group name. The modification will also be done via a modal which will ask for the new name of the group. Deleting a group will ask for confirmation before deleting.
\n
The addition of a translation is done via a card added to the list of translations. The recording and deletion is done directly with the icons on the map.
\n
Changing a translation triggers a key or value change detection system to know whether to display the save button in order to have a good interface.
\n
Search
\n
A search bar represented by a magnifying glass is integrated in the toolbar. The research focuses on the \"keys\" of translations.\nThe first corresponding element will be selected to highlight it. And if several items match the search, a navigation between the corresponding items is displayed next to the search bar.
\n
Search is close if you navigate or delete a translation.
\n
Parallel edition of two languages
\n
Parallel entry of two languages is done via the \"swap\" (on the right-hand side of the groups and translations of the first level) comprising:\nthe main language (the one selected in the list of languages)\nthe second language that can be chosen from the other available languages.
\n
Then it is enough to validate and the second language is automatically added below each value of the main language. Parallel editing works exactly like simple language editing.
\n
Parameters
\n
The settings allow you to modify the app according to your preferences. A \"About\" section is also present to get details about the application.
\n
Basic parameters
\n
\n
The format of the language list (in card list or list)
\n
The language of the application (EN, ES or FR for the moment)
\n
\n
Advanced parameters
\n
\n
Custom location of translation files (Available in version 0.3)
\n
\n
Others parameters
\n
\n
The theme of the application
\n
Keyboard shortcuts
\n
\n
⁉️ FAQ
\n
Your language is not available in the app ?
\n
You can translate the application and submit your translation in PR. Or create issue.
\n
Your language doesn't have its flag displayed ?
\n
You can open a issue to explain your problem with a screenshot if possible.
\n
🔨 Development
\n
If you want to contribute to Serina, create a new different version of Serina, or compile it from source code, follow these instructions.
\n
Clone/download source code from the github repo. Make sure you have node, npm, yarn, bower already installed in your system:
\n\n
yarn to install all the dependencies.
\n
yarn start to start API on localhost:7777.
\n
grunt serve to start Serina on localhost:9000.
\n
yarn run package to build serina for linux (build will be placed in packages folder).\n
\n
grunt package to make builds for windows, linux and mac os.
\n
grunt package:win32 to make build for windows (64bits).
\n
grunt package:linux to make build for linux.
\n
grunt package:macos to make build for mac os (64bits).
\n
\n
\n
grunt test to run the automated tests.\n
\n
Please, ensure the tests are passing before creating a pull requests. Add tests for your changes.
\n
\n
\n\n
👏Acknowledgments
\n
\n
Electron framework was used for the app development.
Serina can be downloaded here. Available versions for Linux, Windows (64bits) and Mac OS.
\n
To use, unzip in the desired location and execute Serina.
\n
If you need a different version, please follow the development instructions to make your own build from the source code
\n
📖 Usage
\n
Serina allows you to create translations for each language, you can access the different languages by clicking on their map in the languages list.
\n
Create translation for a language
\n
This page displays the list of languages and allows you to add a new language via a form using the ISO 639-1 language code. Example:\"FR\" or \"EN\".
\n
The display of the languages is available in two versions (card list or list) that can be set on the parameter page. The number of elements in a language is displayed under the name of the language.
\n
Edit translation
\n
This page displays the groups and translations of the first level of the translation and then recursively displays the sub-levels via access to a group allowing access to its content.
\n
Adding a group is done via a modal that allows you to enter the group name. The modification will also be done via a modal which will ask for the new name of the group. Deleting a group will ask for confirmation before deleting.
\n
The addition of a translation is done via a card added to the list of translations. The recording and deletion is done directly with the icons on the map.
\n
Changing a translation triggers a key or value change detection system to know whether to display the save button in order to have a good interface.
\n
Search
\n
A search bar represented by a magnifying glass is integrated in the toolbar. The research focuses on the \"keys\" of translations.\nThe first corresponding element will be selected to highlight it. And if several items match the search, a navigation between the corresponding items is displayed next to the search bar.
\n
Search is close if you navigate or delete a translation.
\n
Parallel edition of two languages
\n
Parallel entry of two languages is done via the \"swap\" (on the right-hand side of the groups and translations of the first level) comprising:\nthe main language (the one selected in the list of languages)\nthe second language that can be chosen from the other available languages.
\n
Then it is enough to validate and the second language is automatically added below each value of the main language. Parallel editing works exactly like simple language editing.
\n
Parameters
\n
The settings allow you to modify the app according to your preferences. A \"About\" section is also present to get details about the application.
\n
Basic parameters
\n
\n
The format of the language list (in card list or list)
\n
The language of the application (EN, ES or FR for the moment)
\n
\n
Advanced parameters
\n
\n
Custom location of translation files (Available in version 0.3)
\n
\n
Others parameters
\n
\n
The theme of the application
\n
Keyboard shortcuts
\n
\n
⁉️ FAQ
\n
Your language is not available in the app ?
\n
You can translate the application and submit your translation in PR. Or create issue.
\n
Your language doesn't have its flag displayed ?
\n
You can open a issue to explain your problem with a screenshot if possible.
\n
🔨 Development
\n
If you want to contribute to Serina, create a new different version of Serina, or compile it from source code, follow these instructions.
\n
Clone/download source code from the github repo. Make sure you have node, npm, yarn, bower already installed in your system:
\n\n
yarn to install all the dependencies.
\n
yarn start to start API on localhost:7777.
\n
grunt serve to start Serina on localhost:9000.
\n
yarn run package to build serina for linux (build will be placed in packages folder).\n
\n
grunt package to make builds for windows, linux and mac os.
\n
grunt package:win32 to make build for windows (64bits).
\n
grunt package:linux to make build for linux.
\n
grunt package:macos to make build for mac os (64bits).
\n
\n
\n
grunt test to run the automated tests.\n
\n
Please, ensure the tests are passing before creating a pull requests. Add tests for your changes.
\n
\n
\n\n
👏Acknowledgments
\n
\n
Electron framework was used for the app development.
Seton is a tool for Github issue tracking across repositories so far.\nFor example you can track bug issues of libraries used in your project without visiting each repository. Or let say you want to track only a certain level issues of libraries, you can.
\n
Naming & Goal
\n
From E. T. Seton's quote \"there is no animal that cannot be tracked\" Seton is supposed to track issues.
\n
ScreenShots
\n
\n\n\n\n
\n
Demo
\n
I picked up some repositories with easy labeled issue like good first issue, Level: stater in this demo\n
\n
Based
\n
\n
\n
Electron: generally handle main process
\n
React: mainly handle rendering things(Redux isn't integrated in Apollo yet in this App)
\n
Apollo: handle requests and responses for the Github API
# Install dependencies\n yarn\n\n # start with hot reload\n yarn start\n
\n
License
\n
This software is released under the MIT License, see LICENSE
\n
",
+ "readmeOriginal": "
Seton
\n
Seton
\n
Seton is a tool for Github issue tracking across repositories so far.\nFor example you can track bug issues of libraries used in your project without visiting each repository. Or let say you want to track only a certain level issues of libraries, you can.
\n
Naming & Goal
\n
From E. T. Seton's quote \"there is no animal that cannot be tracked\" Seton is supposed to track issues.
\n
ScreenShots
\n
\n\n\n\n
\n
Demo
\n
I picked up some repositories with easy labeled issue like good first issue, Level: stater in this demo\n
\n
Based
\n
\n
\n
Electron: generally handle main process
\n
React: mainly handle rendering things(Redux isn't integrated in Apollo yet in this App)
\n
Apollo: handle requests and responses for the Github API
Download the latest version from the releases page.
\n
Technical
\n
ServPane is built using HTML, CSS, and JavaScript. It's also built using Electron.
\n
Build Setup
\n
# install dependencies\nnpm install\n\n# build electron application for development\nnpm start\n\n# pack electron application for production\nnpm run dist\n
Bug reports and pull requests are welcome on GitHub at https://github.com/aderyabin/ServPane. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.
\n
License
\n
The gem is available as open source under the terms of the MIT License.
\n
Code of Conduct
\n
Everyone interacting in the Localer project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.
Download the latest version from the releases page.
\n
Technical
\n
ServPane is built using HTML, CSS, and JavaScript. It's also built using Electron.
\n
Build Setup
\n
# install dependencies\nnpm install\n\n# build electron application for development\nnpm start\n\n# pack electron application for production\nnpm run dist\n
Bug reports and pull requests are welcome on GitHub at https://github.com/aderyabin/ServPane. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.
\n
License
\n
The gem is available as open source under the terms of the MIT License.
\n
Code of Conduct
\n
Everyone interacting in the Localer project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.
Shiba is a rich live markdown preview app with linter. It watches markdown files in specific directory and automatically shows the preview and result of lint.\nShiba is built on Electron and Polymer.
\n
\n
Isolated app. You need not prepare Chrome and can use favorite editor
Copyright (c) 2015 rhysd\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies\nof the Software, and to permit persons to whom the Software is furnished to do so,\nsubject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,\nINCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR\nPURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE\nLIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,\nTORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR\nTHE USE OR OTHER DEALINGS IN THE SOFTWARE.\n
\n
In packaged app, Electron part is licensed with below notice:
\n
\n
Copyright (c) 2014 GitHub Inc.
\n
\n
Emojis were brought from gemoji project:
\n
\n
octocat, squirrel, shipit\nCopyright (c) 2013 GitHub Inc. All rights reserved.
\n
bowtie, neckbeard, fu\nCopyright (c) 2013 37signals, LLC. All rights reserved.
\n
feelsgood, finnadie, goberserk, godmode, hurtrealbad, rage 1-4, suspect\nCopyright (c) 2013 id Software. All rights reserved.
\n
trollface\nCopyright (c) 2013 whynne@deviantart. All rights reserved.
\n
Source code:
\n
Copyright (c) 2013 GitHub, Inc.
\n
\n
",
+ "readmeOriginal": "
\n
\n\n
\n
Shiba is a rich live markdown preview app with linter. It watches markdown files in specific directory and automatically shows the preview and result of lint.\nShiba is built on Electron and Polymer.
\n
\n
Isolated app. You need not prepare Chrome and can use favorite editor
Copyright (c) 2015 rhysd\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies\nof the Software, and to permit persons to whom the Software is furnished to do so,\nsubject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,\nINCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR\nPURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE\nLIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,\nTORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR\nTHE USE OR OTHER DEALINGS IN THE SOFTWARE.\n
\n
In packaged app, Electron part is licensed with below notice:
\n
\n
Copyright (c) 2014 GitHub Inc.
\n
\n
Emojis were brought from gemoji project:
\n
\n
octocat, squirrel, shipit\nCopyright (c) 2013 GitHub Inc. All rights reserved.
\n
bowtie, neckbeard, fu\nCopyright (c) 2013 37signals, LLC. All rights reserved.
\n
feelsgood, finnadie, goberserk, godmode, hurtrealbad, rage 1-4, suspect\nCopyright (c) 2013 id Software. All rights reserved.
\n
trollface\nCopyright (c) 2013 whynne@deviantart. All rights reserved.
This application is a basic function of file finder. The purpose of this application is to see the basic functions and possibilities of Electron through a relatively simple project.
\n
I hope many people can learn the function of Electron easily through the source of this project.
\n
\n
Functions and Features
\n
Top feature: Local System File Explorer (Windows 10 only)
This application is a basic function of file finder. The purpose of this application is to see the basic functions and possibilities of Electron through a relatively simple project.
\n
I hope many people can learn the function of Electron easily through the source of this project.
\n
\n
Functions and Features
\n
Top feature: Local System File Explorer (Windows 10 only)
This distribution includes cryptographic software. The country in which you currently reside may have restrictions on the import, possession, use, and/or re-export to another country, of encryption software.\nBEFORE using any encryption software, please check your country's laws, regulations and policies concerning the import, possession, or use, and re-export of encryption software, to see if this is permitted.\nSee http://www.wassenaar.org/ for more information.
\n
The U.S. Government Department of Commerce, Bureau of Industry and Security (BIS), has classified this software as Export Commodity Control Number (ECCN) 5D002.C.1, which includes information security software using or performing cryptographic functions with asymmetric algorithms.\nThe form and manner of this distribution makes it eligible for export under the License Exception ENC Technology Software Unrestricted (TSU) exception (see the BIS Export Administration Regulations, Section 740.13) for both object code and source code.
This distribution includes cryptographic software. The country in which you currently reside may have restrictions on the import, possession, use, and/or re-export to another country, of encryption software.\nBEFORE using any encryption software, please check your country's laws, regulations and policies concerning the import, possession, or use, and re-export of encryption software, to see if this is permitted.\nSee http://www.wassenaar.org/ for more information.
\n
The U.S. Government Department of Commerce, Bureau of Industry and Security (BIS), has classified this software as Export Commodity Control Number (ECCN) 5D002.C.1, which includes information security software using or performing cryptographic functions with asymmetric algorithms.\nThe form and manner of this distribution makes it eligible for export under the License Exception ENC Technology Software Unrestricted (TSU) exception (see the BIS Export Administration Regulations, Section 740.13) for both object code and source code.
Use a robot to attract more followers. Now as a simple desktop app!
\n
\n
How does it work?
\n
It runs as a desktop application on your computer and will every day follow up to 150 users (configurable). You choose a list of instagram users whose market you want to target. The bot navigates to each of these, finds the last people to have followed them and then follows each of them. Then after 5 days (also configurable), it will unfollow the users. Simple and effective.
\n
The bot will remember every user it has followed, so if you quit the app and open it later, it will still clean up by unfollowing users that it previously followed.
\n
You can find logs and data in your the \"App Data\" folder. See userData. For example on Mac OS:
No viruses or fishy business, guaranteed to not store your password! (See the code for yourself)
\n
Simple, easy to use
\n
Effective: Follow/unfollow is proven very effective. By only doing follow/unfollow, the bot avoids all those awkward situations where a bot comments \"Awesome!\" on a post depicting a tragic events.
\n
Secure: Never stores your username an password
\n
Safe: Runs on your own computer, to reduce the risk of being banned. Instagram is known to crack down on paid Instagram bot services and cloud and VPN IPs
\n
Automatic rate limiting
\n
Uses a normal browser to mimic the behavior of a normal user (does not use private APIs easily detectable by Instagram)
\n
Randomized timed behavior
\n
Simulates human behavior of sleeping at night, and usage in the day time
\n
Change browser signature to avoid being identified
NOTE: After installing you may need to bypass \"Untrusted app\" dialogs. This is because Microsoft requires a costly certificate to remove this dialog (I'm not going to pay for that.) Alternatively try to google windows run untrusted app.
\n
A word of warning
\n
Many people are getting Action Blocked message these days with this bot as well as other bots (it seems even people just manually following using the app) Instagram is tightening their rules by not allowing promiscuous behavior like following and liking strangers' photos as much as before, and imposing temp blocks when they think you crossed the limit.
\n
You use this app at your own risk! I have had great success with this app but I am not responsible for any consequences it may have for your Instagram account.
\n
Tips to avoid ban
\n
I advise you to follow these guidelines:
\n
\n
Run the bot on the same internet connection (e.g. WiFi) as you normally use your phone with the Instagram mobile app. It will reduce the chance of being flagged
\n
Use conservative parameters (max follows/unfollows per day 150 and max 20 per hour, maybe even start out lower, and work your way up)
\n
\n
How to run on Raspberry PI
\n
# SSH into your PI\nssh pi@ip.of.pi\n\n# Download the Raspberry Pi binary\nwget https://github.com/mifi/SimpleInstaBot/releases/latest/download/SimpleInstaBot-linux-armv7l.tar.bz2\n\n# Extract it\ntar xvf SimpleInstaBot-linux-armv7l.tar.bz2\ncd SimpleInstaBot-linux-armv7l\n\n# run it\nDISPLAY=:0 ./simpleinstabot\n\n# or:\nDISPLAY=:0 ./simpleinstabot --no-sandbox
\n
Troubleshooting
\n
\n
Follow button not found: switch your instagram account into English as stated in the instauto troobleshooting page
\n
\n
FAQ
\n
\n
Q: Can I run it on multiple accounts at the same time?
\n
A: No, currently you would need multiple PC's or multiple VMs for that. See #27
\n
Q: Can I run it on multiple accounts (but not at the same time)?
\n
A: Yes, just log out, and then log in to your other account instead. Followed/liked etc will be remembered.
\n
\n
Donate 🙈
\n
This project is maintained by me alone. The project will always remain free and open source, but if it's useful for you, consider supporting me. :) It will give me extra motivation to improve it.
Use a robot to attract more followers. Now as a simple desktop app!
\n
\n
How does it work?
\n
It runs as a desktop application on your computer and will every day follow up to 150 users (configurable). You choose a list of instagram users whose market you want to target. The bot navigates to each of these, finds the last people to have followed them and then follows each of them. Then after 5 days (also configurable), it will unfollow the users. Simple and effective.
\n
The bot will remember every user it has followed, so if you quit the app and open it later, it will still clean up by unfollowing users that it previously followed.
\n
You can find logs and data in your the \"App Data\" folder. See userData. For example on Mac OS:
No viruses or fishy business, guaranteed to not store your password! (See the code for yourself)
\n
Simple, easy to use
\n
Effective: Follow/unfollow is proven very effective. By only doing follow/unfollow, the bot avoids all those awkward situations where a bot comments \"Awesome!\" on a post depicting a tragic events.
\n
Secure: Never stores your username an password
\n
Safe: Runs on your own computer, to reduce the risk of being banned. Instagram is known to crack down on paid Instagram bot services and cloud and VPN IPs
\n
Automatic rate limiting
\n
Uses a normal browser to mimic the behavior of a normal user (does not use private APIs easily detectable by Instagram)
\n
Randomized timed behavior
\n
Simulates human behavior of sleeping at night, and usage in the day time
\n
Change browser signature to avoid being identified
NOTE: After installing you may need to bypass \"Untrusted app\" dialogs. This is because Microsoft requires a costly certificate to remove this dialog (I'm not going to pay for that.) Alternatively try to google windows run untrusted app.
\n
A word of warning
\n
Many people are getting Action Blocked message these days with this bot as well as other bots (it seems even people just manually following using the app) Instagram is tightening their rules by not allowing promiscuous behavior like following and liking strangers' photos as much as before, and imposing temp blocks when they think you crossed the limit.
\n
You use this app at your own risk! I have had great success with this app but I am not responsible for any consequences it may have for your Instagram account.
\n
Tips to avoid ban
\n
I advise you to follow these guidelines:
\n
\n
Run the bot on the same internet connection (e.g. WiFi) as you normally use your phone with the Instagram mobile app. It will reduce the chance of being flagged
\n
Use conservative parameters (max follows/unfollows per day 150 and max 20 per hour, maybe even start out lower, and work your way up)
\n
\n
How to run on Raspberry PI
\n
# SSH into your PI\nssh pi@ip.of.pi\n\n# Download the Raspberry Pi binary\nwget https://github.com/mifi/SimpleInstaBot/releases/latest/download/SimpleInstaBot-linux-armv7l.tar.bz2\n\n# Extract it\ntar xvf SimpleInstaBot-linux-armv7l.tar.bz2\ncd SimpleInstaBot-linux-armv7l\n\n# run it\nDISPLAY=:0 ./simpleinstabot\n\n# or:\nDISPLAY=:0 ./simpleinstabot --no-sandbox
\n
Troubleshooting
\n
\n
Follow button not found: switch your instagram account into English as stated in the instauto troobleshooting page
\n
\n
FAQ
\n
\n
Q: Can I run it on multiple accounts at the same time?
\n
A: No, currently you would need multiple PC's or multiple VMs for that. See #27
\n
Q: Can I run it on multiple accounts (but not at the same time)?
\n
A: Yes, just log out, and then log in to your other account instead. Followed/liked etc will be remembered.
\n
\n
Donate 🙈
\n
This project is maintained by me alone. The project will always remain free and open source, but if it's useful for you, consider supporting me. :) It will give me extra motivation to improve it.
Working on Microsoft Windows (7+), GNU/Linux Debian (Xfce and Mate) and MacOS (1.9+).\nNot deployed on MacOS
\n
Using git
\n
# clone the repository\n$ git clone https://github.com/ShuttleBrowser/Shuttle.git\n\n# change the working directory to shuttle\n$ cd Shuttle\n\n# install the requirements\n$ npm install\n
On Windows, Shuttle can be launched by clicking on its shortcut which can be found directly on the desktop or from the Start menu.\nThe program should then start in the notification center. Its icon can be found in the system tray, at the bottom right of the screen. Clicking on its icon will show Shuttle's main window.
\n
In order to add a new website (we refer to them as \"bookmarks\") just click on the \"plus\" (+) button. A dialog will open to ask you for the URL of the website you want to add. Enter it and validate to see a new icon being added to the bookmarks bar. You can now click on this icon at any time to display the website.
\n
A bookmark can be deleted by right-clicking on its icon.
\n
The settings can be edited by clicking on the gear. They make possible to manage your preferences by offering, for instance, to launch Shuttle on boot or to force Shuttle to stay opened.
\n
All updates are automatic and new versions are checked at the launch of the application. You can also search for updates by clicking on the arrows below the settings.\nIf you need help to setup or use Shuttle, or you want to report a bug, please contact us at support@shuttleapp.io.
Working on Microsoft Windows (7+), GNU/Linux Debian (Xfce and Mate) and MacOS (1.9+).\nNot deployed on MacOS
\n
Using git
\n
# clone the repository\n$ git clone https://github.com/ShuttleBrowser/Shuttle.git\n\n# change the working directory to shuttle\n$ cd Shuttle\n\n# install the requirements\n$ npm install\n
On Windows, Shuttle can be launched by clicking on its shortcut which can be found directly on the desktop or from the Start menu.\nThe program should then start in the notification center. Its icon can be found in the system tray, at the bottom right of the screen. Clicking on its icon will show Shuttle's main window.
\n
In order to add a new website (we refer to them as \"bookmarks\") just click on the \"plus\" (+) button. A dialog will open to ask you for the URL of the website you want to add. Enter it and validate to see a new icon being added to the bookmarks bar. You can now click on this icon at any time to display the website.
\n
A bookmark can be deleted by right-clicking on its icon.
\n
The settings can be edited by clicking on the gear. They make possible to manage your preferences by offering, for instance, to launch Shuttle on boot or to force Shuttle to stay opened.
\n
All updates are automatic and new versions are checked at the launch of the application. You can also search for updates by clicking on the arrows below the settings.\nIf you need help to setup or use Shuttle, or you want to report a bug, please contact us at support@shuttleapp.io.
This powers the Neutron (Electron)-based apps you install from WebCatalog.
\n\n
Development
\n
This repository only contains the source code of the Neutron - the core that powers the apps created with WebCatalog. If you'd like to contribute to the WebCatalog app, check out https://github.com/webcatalog/webcatalog-app.
\n
# clone the project:\ngit clone https://github.com/webcatalog/neutron.git\ncd neutron
\n
For the app to be fully functional, set these environment variables:
# install the dependencies\nyarn\n\n# Run development mode\nyarn electron-dev\n\n# Package template app as zip file\nyarn dist
\n
",
+ "readmeOriginal": "
Neutron
\n
\n\n
\n
macOS (x64)
\n
Linux (x64)
\n
Windows (x64)
\n
\n\n\n
\n
\n
\n
\n
\n\n
\n
\n\n
\n
macOS (arm64)
\n
Linux (arm64)
\n
Windows (arm64)
\n
\n\n\n
\n
\n
\n
\n
\n\n
\n
This powers the Neutron (Electron)-based apps you install from WebCatalog.
\n\n
Development
\n
This repository only contains the source code of the Neutron - the core that powers the apps created with WebCatalog. If you'd like to contribute to the WebCatalog app, check out https://github.com/webcatalog/webcatalog-app.
\n
# clone the project:\ngit clone https://github.com/webcatalog/neutron.git\ncd neutron
\n
For the app to be fully functional, set these environment variables:
sleek is an open-source todo app that makes use of the todo.txt format. sleeks GUI is modern and simple but still offers a decent set of functions which help users getting things done. sleek is available as a client for Windows, MacOS and Linux.
\n
Users can add contexts, projects, priorities, due dates, recurrences or threshold dates to their todos. These todo.txt attributes can then be used in full-text search, as filters or to group and sort the todo list.
\n
sleek manages and watches multiple todo.txt files continuously for changes, which makes it easy to integrate sleek with other todo.txt apps. Also users can switch to dark mode and choose from multiple languages.
\n
Todos with due date or repeating todos will trigger notifications and completed todos can be hidden or archived into separate done.txt files. If users have tons of todos, a compact view can come in handy.
sleek is an open-source todo app that makes use of the todo.txt format. sleeks GUI is modern and simple but still offers a decent set of functions which help users getting things done. sleek is available as a client for Windows, MacOS and Linux.
\n
Users can add contexts, projects, priorities, due dates, recurrences or threshold dates to their todos. These todo.txt attributes can then be used in full-text search, as filters or to group and sort the todo list.
\n
sleek manages and watches multiple todo.txt files continuously for changes, which makes it easy to integrate sleek with other todo.txt apps. Also users can switch to dark mode and choose from multiple languages.
\n
Todos with due date or repeating todos will trigger notifications and completed todos can be hidden or archived into separate done.txt files. If users have tons of todos, a compact view can come in handy.
Clone the repo: git clone https://github.com/Automattic/simplenote-electron.git
\n
cd simplenote-electron
\n
npm install
\n
npm run dev
\n
The dev server will start on http://localhost:4000, and the Electron app will launch automatically.
\n
For all logging from Electron to be printed to the terminal (e.g. console.log statements within app.js), you might need to set env ELECTRON_ENABLE_LOGGING=1.
\n
Sign up for a new account within the app. Use the account for testing purposes only as all note data will be periodically cleared out on the server.
\n\n
Note: Simplenote API features such as sharing and publishing will not work with development builds. Due to a limitation of make installation paths used for build cannot have spaces.
\n
Building
\n
\n
make package-osx
\n
make package-win32
\n
make package-linux
\n
\n
Testing
\n
Unit tests are run with npm test.
\n
End-to-end tests are run with npm run test-e2e.\nNote that the Spectron version corresponds with the version of Electron we are using.\nUse the corresponding API docs for webdriver-io which correspond to the Spectron version.\nAt the time of writing you will want to refer to the webdriver-io v4.13 API docs.
\n
Coding Guidelines
\n
Please adhere to the same guidelines as found in wp-calypso.
Clone the repo: git clone https://github.com/Automattic/simplenote-electron.git
\n
cd simplenote-electron
\n
npm install
\n
npm run dev
\n
The dev server will start on http://localhost:4000, and the Electron app will launch automatically.
\n
For all logging from Electron to be printed to the terminal (e.g. console.log statements within app.js), you might need to set env ELECTRON_ENABLE_LOGGING=1.
\n
Sign up for a new account within the app. Use the account for testing purposes only as all note data will be periodically cleared out on the server.
\n\n
Note: Simplenote API features such as sharing and publishing will not work with development builds. Due to a limitation of make installation paths used for build cannot have spaces.
\n
Building
\n
\n
make package-osx
\n
make package-win32
\n
make package-linux
\n
\n
Testing
\n
Unit tests are run with npm test.
\n
End-to-end tests are run with npm run test-e2e.\nNote that the Spectron version corresponds with the version of Electron we are using.\nUse the corresponding API docs for webdriver-io which correspond to the Spectron version.\nAt the time of writing you will want to refer to the webdriver-io v4.13 API docs.
\n
Coding Guidelines
\n
Please adhere to the same guidelines as found in wp-calypso.
A note taking app focused on simplicity and privacy using PGP to encrypt all your notes.
\n
From school to your office, Skrifa is the word processor for everyone.
\n
With a minimal, distraction free, simple and yet powerful interface, it's focused on what you really care, your content. It is so versatile that you'll have no problem using it for any scenario, as a power user or just as a simple quick note taking app.
\n
From text styling to videos and images, and there are also features for more specific things like writing code, math and data tables
\n
Writing Math
\n
Having a suitable notebook for any ocation is something we all need, Skrifa has Mathjax capabilities so that you can write math formulas and some LaTeX code, ideal for students and people who work with math! Doing it is as simple as just typing your formula like this:\n$x + y = z$
\n
Writing Code
\n
Thanks to Prism.js Skrifa also has code highlightning for you!
\n
How Skrifa Protects Your Privacy
\n
With a Skrifa account
\n
If you don't want all the work of creating, mantaining and storing a PGP key, you can let Skrifa do it for you! When registering for a Skrifa account you'll be asked for an email address and password. Once you've downloaded the app you'll create a new PGP key which will be used to encrypt all your notes, this key will be created using a new passphrase you'll set up, using that passphrase your key will be encrypted and saved locally, an encrypted version of your key is also uploaded to the server so that you won't have to manage it manually. This behavior is fairly similar to the one used by ProtonMail.
\n
With a PGP key
\n
If you don't want to use an Skrifa acccount and rely your key to a server, you can also use a PGP key you already own or create a new one, while this may be more secure, it also comes with great responsibility since you'll have to backup your key, remember that key is the only way to access your notes! This means that Skrifa is now a lot more compatible with other PGP software since you can import a key created by an external application as well as use your Skrifa generated local key in them.
\n
On a daily basis
\n
No matter what PGP key method you've chosen, every time you start skrifa you'll be asked to enter your key's passphrase in order to decrypt it and decrypt your notes, every note and notebook you create is encrypted using that key and only you will be able to read it after decrypting them. They will never be stored unencrypted unless you export them in such a manner. The passphrase is never uploaded anywhere so you can be sure you are the only one who can decrypt your key and notes.
\n
No Ads, No Track
\n
Skrifa will never used Ads and will never track you in any way, the only data that will ever be uploaded is the following and only if you choose to have a Skrifa account:
\n
\n
Username
\n
Password (Properly hashed and stored)
\n
Public Key
\n
Private Key (Properly encrypted with your passphrase)
\n
\n
If you've chosen to use a local key then absolutely no information is uploaded! The only network connections Skrifa will ever have are under the following situations:
\n
\n
Log In
\n
Create a new Key for your Skrifa account
\n
Get an image from an URL
\n
Load an embedded video
\n
Check for updates
\n
Download another user's public key for note sharing
\n
\n
Sharing Notes
\n
Sharing notes is incredibly easy, if you are sharing the note with a registered Skrifa user, all you'll need is his/her username and a Skfira Note will be created for you to share it.\nIf you are sharing the note with a Skrifa user who uses an offline key, then you'll need his public key, a dialog will appear asking you to select the public key you want to share the note with.\nYou can also share your note in a plaintext PGP Message so someone who is not using Skrifa at all will be able to read it with any other PGP software!
\n
Contributing
\n
There are several ways you can contribute to the development of Skrifa
\n
Creating a new Theme
\n
Creating a new CSS theme is incredibly easy! All you have to do is copy the theme-template.css file into a file with your theme's name inside the themes directory.\nThis file already has a lot of the common elements you'll need to style in order to create a functional theme, once you've copied the file, the next step is to rename the theme class to your theme's name, using a find and replace all utility is pretty useful!
\n
To load your theme, you'll need to add the stylesheet link in the index.html file as well as adding the option in the select element inside the settings view, remember the value of the select must match the class name of your theme!
\n
Adding functionality
\n
Skrifa is very extensible and you can add all kinds of functionality, from utilities for the editor to new export formats or encryption features. You may know Skrifa is divided in views or screens, each view has a javascript file that contains all it's functionality.
\n
If you want to add a new view, you'll need to create it inside the index.html file and add a javascript file for it's functionality.
\n
Reporting a Bug
\n
If you've found an error please report it so it can be fixed, describe the error and what you were doing while it happened.
\n
Buying Skrifa
\n
Skrifa is a pay-what-you-want software, every time someone pays for skrifa, the payment will be dividad 50/50 between the developers and donations for the projects Skrifa uses.
\n
Supporting via Patreon
\n
You can support me via Patreon, by supporting me via patreon you are not only contributing to this project but also all my other projects and contributions!
\n
Fixing a Bug
\n
If you've found a bug and you are willing to fix it, just clone this repository, fix the bug and make a Pull Request, your code will be evaluated and then merged to the main branch, it really is simple to contribute!
A note taking app focused on simplicity and privacy using PGP to encrypt all your notes.
\n
From school to your office, Skrifa is the word processor for everyone.
\n
With a minimal, distraction free, simple and yet powerful interface, it's focused on what you really care, your content. It is so versatile that you'll have no problem using it for any scenario, as a power user or just as a simple quick note taking app.
\n
From text styling to videos and images, and there are also features for more specific things like writing code, math and data tables
\n
Writing Math
\n
Having a suitable notebook for any ocation is something we all need, Skrifa has Mathjax capabilities so that you can write math formulas and some LaTeX code, ideal for students and people who work with math! Doing it is as simple as just typing your formula like this:\n$x + y = z$
\n
Writing Code
\n
Thanks to Prism.js Skrifa also has code highlightning for you!
\n
How Skrifa Protects Your Privacy
\n
With a Skrifa account
\n
If you don't want all the work of creating, mantaining and storing a PGP key, you can let Skrifa do it for you! When registering for a Skrifa account you'll be asked for an email address and password. Once you've downloaded the app you'll create a new PGP key which will be used to encrypt all your notes, this key will be created using a new passphrase you'll set up, using that passphrase your key will be encrypted and saved locally, an encrypted version of your key is also uploaded to the server so that you won't have to manage it manually. This behavior is fairly similar to the one used by ProtonMail.
\n
With a PGP key
\n
If you don't want to use an Skrifa acccount and rely your key to a server, you can also use a PGP key you already own or create a new one, while this may be more secure, it also comes with great responsibility since you'll have to backup your key, remember that key is the only way to access your notes! This means that Skrifa is now a lot more compatible with other PGP software since you can import a key created by an external application as well as use your Skrifa generated local key in them.
\n
On a daily basis
\n
No matter what PGP key method you've chosen, every time you start skrifa you'll be asked to enter your key's passphrase in order to decrypt it and decrypt your notes, every note and notebook you create is encrypted using that key and only you will be able to read it after decrypting them. They will never be stored unencrypted unless you export them in such a manner. The passphrase is never uploaded anywhere so you can be sure you are the only one who can decrypt your key and notes.
\n
No Ads, No Track
\n
Skrifa will never used Ads and will never track you in any way, the only data that will ever be uploaded is the following and only if you choose to have a Skrifa account:
\n
\n
Username
\n
Password (Properly hashed and stored)
\n
Public Key
\n
Private Key (Properly encrypted with your passphrase)
\n
\n
If you've chosen to use a local key then absolutely no information is uploaded! The only network connections Skrifa will ever have are under the following situations:
\n
\n
Log In
\n
Create a new Key for your Skrifa account
\n
Get an image from an URL
\n
Load an embedded video
\n
Check for updates
\n
Download another user's public key for note sharing
\n
\n
Sharing Notes
\n
Sharing notes is incredibly easy, if you are sharing the note with a registered Skrifa user, all you'll need is his/her username and a Skfira Note will be created for you to share it.\nIf you are sharing the note with a Skrifa user who uses an offline key, then you'll need his public key, a dialog will appear asking you to select the public key you want to share the note with.\nYou can also share your note in a plaintext PGP Message so someone who is not using Skrifa at all will be able to read it with any other PGP software!
\n
Contributing
\n
There are several ways you can contribute to the development of Skrifa
\n
Creating a new Theme
\n
Creating a new CSS theme is incredibly easy! All you have to do is copy the theme-template.css file into a file with your theme's name inside the themes directory.\nThis file already has a lot of the common elements you'll need to style in order to create a functional theme, once you've copied the file, the next step is to rename the theme class to your theme's name, using a find and replace all utility is pretty useful!
\n
To load your theme, you'll need to add the stylesheet link in the index.html file as well as adding the option in the select element inside the settings view, remember the value of the select must match the class name of your theme!
\n
Adding functionality
\n
Skrifa is very extensible and you can add all kinds of functionality, from utilities for the editor to new export formats or encryption features. You may know Skrifa is divided in views or screens, each view has a javascript file that contains all it's functionality.
\n
If you want to add a new view, you'll need to create it inside the index.html file and add a javascript file for it's functionality.
\n
Reporting a Bug
\n
If you've found an error please report it so it can be fixed, describe the error and what you were doing while it happened.
\n
Buying Skrifa
\n
Skrifa is a pay-what-you-want software, every time someone pays for skrifa, the payment will be dividad 50/50 between the developers and donations for the projects Skrifa uses.
\n
Supporting via Patreon
\n
You can support me via Patreon, by supporting me via patreon you are not only contributing to this project but also all my other projects and contributions!
\n
Fixing a Bug
\n
If you've found a bug and you are willing to fix it, just clone this repository, fix the bug and make a Pull Request, your code will be evaluated and then merged to the main branch, it really is simple to contribute!
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
\n
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
\n
THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
\n
IMPORTANT NOTE
\n
THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN\nTHE SOFTWARE.\n
\n
",
+ "readmeOriginal": "
Smartholdem Desktop Wallet
\n
\n
For dev
\n
\n
npm install
\n
\n
\n
npm start
\n
\n
Licenses
\n
The MIT License (MIT)
\n
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
\n
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
\n
THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
\n
IMPORTANT NOTE
\n
THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN\nTHE SOFTWARE.\n
I made it myself, so not too rich in functions/futures, but i thinked maybe can help other(s) too if i publish it.
\n
This app help you tracking your smoking habits and reduce the dose greatly and prepare you to the \"freedom day\" (quitting).\nHow?\nThe app is a game pack in the game also.
\n
The motivation/distraction system is add to you more help to push out the breaktime (time between two smoke) more and more.
\n
If you fulfill the setted breaktime, you got expirence points (xp) and levelup like an RPG game. In the 'Rewards' menu open 1 flash game for each earned level.\nThe max level is 50.\nWhen you overfulfill the time got bonus xp, but if you underperforming then you lose xp.
\n
Tips
\n
First of all try still your dose with lighter cigaretes. If you smoke 20 normal cigarettes per day, change to light and stay on 20 dialy.
\n
When you can hold the dose with light, start lower the dose. Use the timer to push out the next times when you smoke.
\n
Try lower your dose to minimum 8-10 or better 5-6 light cigarette per day while you reach level 50.
\n
The lowered dose makes easier for you the finaly free from the smoking. The day when you left over the smoking is the freedom day.
\n
If you fall back more the 1-2 cigarette per day, you can restart the procedure with your lower dose. Use the \"Reset profile\" menu.
\n
You can delete game saves also with the \"Reset games\" menu button.
\n
Features
\n
Start with system.
\n
Choose the cigarette type (strong, normal, light, extralight).
\n
Set the target time between two smoke (in minutes and the min. 30).
\n
Dialy, monthly, total counters (handle 1, 3/4, 1/2, 1/4 cigarette doses) and charts.
\n
Countup non smoked times. Red background under target breaktime, green after reach.
\n
Micro RPG system (50 level).
\n
50 build in flash games (Not requires internet connection).
\n
Made with love.
\n
Screenshots
\n
\n
\n
Licence
\n
Copyright (c) 2018, Krisztián Kis - Phresh-IT. All rights reserved.
Clone or download the repo and navigate in console to the program's root folder.
\n
Install
\n
npm install\n
\n
Run
\n
npm start\n
\n
Packaging (win32 is x86, others x64)
\n
App need flashplayer plugin from chrome broswer for flashgames.\nFor Windows, I built in (pepflashplayer.dll),\nbut for Mac (PepperFlashPlayer.plugin) somewhere in Users/{username}/Library/Application Support/Google/Chrome/Default/Extensions/.\nand Linux (libpepflashplayer.so) /home/{username}/.config/google-chrome/default/Extensions/\nnot. The files or contributions are welcome
\n
npm run pack-win32\n\nnpm run pack-win\n\nnpm run pack-lin\n\nnpm run pack-mac\n
\n
Packaged zips not requires installion, just unzip and run the executeable file.
\n
Support
\n
If you like my work(s), please buy me a coffee or support/donate me. Contributions, issues(problems, ideas) and donates are welcome.
\n
Thank you, Have a nice day!
\n
",
+ "readmeOriginal": "
SmokerStopper
\n
I made it myself, so not too rich in functions/futures, but i thinked maybe can help other(s) too if i publish it.
\n
This app help you tracking your smoking habits and reduce the dose greatly and prepare you to the \"freedom day\" (quitting).\nHow?\nThe app is a game pack in the game also.
\n
The motivation/distraction system is add to you more help to push out the breaktime (time between two smoke) more and more.
\n
If you fulfill the setted breaktime, you got expirence points (xp) and levelup like an RPG game. In the 'Rewards' menu open 1 flash game for each earned level.\nThe max level is 50.\nWhen you overfulfill the time got bonus xp, but if you underperforming then you lose xp.
\n
Tips
\n
First of all try still your dose with lighter cigaretes. If you smoke 20 normal cigarettes per day, change to light and stay on 20 dialy.
\n
When you can hold the dose with light, start lower the dose. Use the timer to push out the next times when you smoke.
\n
Try lower your dose to minimum 8-10 or better 5-6 light cigarette per day while you reach level 50.
\n
The lowered dose makes easier for you the finaly free from the smoking. The day when you left over the smoking is the freedom day.
\n
If you fall back more the 1-2 cigarette per day, you can restart the procedure with your lower dose. Use the \"Reset profile\" menu.
\n
You can delete game saves also with the \"Reset games\" menu button.
\n
Features
\n
Start with system.
\n
Choose the cigarette type (strong, normal, light, extralight).
\n
Set the target time between two smoke (in minutes and the min. 30).
\n
Dialy, monthly, total counters (handle 1, 3/4, 1/2, 1/4 cigarette doses) and charts.
\n
Countup non smoked times. Red background under target breaktime, green after reach.
\n
Micro RPG system (50 level).
\n
50 build in flash games (Not requires internet connection).
\n
Made with love.
\n
Screenshots
\n
\n
\n
Licence
\n
Copyright (c) 2018, Krisztián Kis - Phresh-IT. All rights reserved.
Clone or download the repo and navigate in console to the program's root folder.
\n
Install
\n
npm install\n
\n
Run
\n
npm start\n
\n
Packaging (win32 is x86, others x64)
\n
App need flashplayer plugin from chrome broswer for flashgames.\nFor Windows, I built in (pepflashplayer.dll),\nbut for Mac (PepperFlashPlayer.plugin) somewhere in Users/{username}/Library/Application Support/Google/Chrome/Default/Extensions/.\nand Linux (libpepflashplayer.so) /home/{username}/.config/google-chrome/default/Extensions/\nnot. The files or contributions are welcome
\n
npm run pack-win32\n\nnpm run pack-win\n\nnpm run pack-lin\n\nnpm run pack-mac\n
\n
Packaged zips not requires installion, just unzip and run the executeable file.
\n
Support
\n
If you like my work(s), please buy me a coffee or support/donate me. Contributions, issues(problems, ideas) and donates are welcome.
SnippetStore is an application for developers to store their snippets and quickly retrieve them when needed. SnippetStore mainly focus on storing code therefor its interface is small and simple, perfect for busy developers who doesn't care about small details.
\n
Donate
\n
There are many requests for macOS support and I'm sure many of you guys who are mac users will want\nSnippetStore to be available in homebrew and able to run on macOS too. But in order to do that, I need help from you guys to afford a mac to test & build this project and many more other projects in the future. It would be a huge help if you can buy me a coffee 😄
SnippetStore is an application for developers to store their snippets and quickly retrieve them when needed. SnippetStore mainly focus on storing code therefor its interface is small and simple, perfect for busy developers who doesn't care about small details.
\n
Donate
\n
There are many requests for macOS support and I'm sure many of you guys who are mac users will want\nSnippetStore to be available in homebrew and able to run on macOS too. But in order to do that, I need help from you guys to afford a mac to test & build this project and many more other projects in the future. It would be a huge help if you can buy me a coffee 😄
A free and open source command snippets manager for organize and copy fast.
\n
\n \n
\n
\n \n \n
\n
\n \n
\n
\n Built with Electron & React \n Built for Windows, macOS and Linux\n
\n
Overview
\n
\n \n
\n
It helps you create, organize and store your commands (Excel formulas, Sql Queries, Terminal commands, etc.) with dynamic parameters for quick copy to it. Describe your commands with dynamic parameters also support documentation about your snippets. You can select or specify your dynamic values using with selectbox/inputbox for ready to paste the workspace. You can organize with tags.
\n
Features
\n
\n
ORGANIZE WITH TAGS & FAVOURITES You can organize all commands with tags & favourites system.
\n
DESCRIBE DYNAMIC PARAMETERS You can describe dynamic parameters. Supporting input & selectbox for choosing parameter value.
\n
DOCUMENTATION FOR COMMAND You can describe documentation text for each commands with Markdown Editor.
\n
SEARCH You can quick access your commands
\n
AUTOSAVE Automatically saves any changes you make during work, so you don't have to worry about losing changes.
\n
SYNC You can use any service that provides cloud synchronization, such as iCloud Drive, Google Drive, Dropbox or other similar.
\n
DATABASE We are using Lowdb - Powered by Lodash to store your data. The database files are on your local computer.
\n
LIGHT/DARK THEME We are supporting 2 themes.
\n
And more...
\n
\n
Contribution
\n
Contribution are always welcome and recommended! Here is how:
A free and open source command snippets manager for organize and copy fast.
\n
\n \n
\n
\n \n \n
\n
\n \n
\n
\n Built with Electron & React \n Built for Windows, macOS and Linux\n
\n
Overview
\n
\n \n
\n
It helps you create, organize and store your commands (Excel formulas, Sql Queries, Terminal commands, etc.) with dynamic parameters for quick copy to it. Describe your commands with dynamic parameters also support documentation about your snippets. You can select or specify your dynamic values using with selectbox/inputbox for ready to paste the workspace. You can organize with tags.
\n
Features
\n
\n
ORGANIZE WITH TAGS & FAVOURITES You can organize all commands with tags & favourites system.
\n
DESCRIBE DYNAMIC PARAMETERS You can describe dynamic parameters. Supporting input & selectbox for choosing parameter value.
\n
DOCUMENTATION FOR COMMAND You can describe documentation text for each commands with Markdown Editor.
\n
SEARCH You can quick access your commands
\n
AUTOSAVE Automatically saves any changes you make during work, so you don't have to worry about losing changes.
\n
SYNC You can use any service that provides cloud synchronization, such as iCloud Drive, Google Drive, Dropbox or other similar.
\n
DATABASE We are using Lowdb - Powered by Lodash to store your data. The database files are on your local computer.
\n
LIGHT/DARK THEME We are supporting 2 themes.
\n
And more...
\n
\n
Contribution
\n
Contribution are always welcome and recommended! Here is how:
Socially is an application which combines all of your social media DM's and chats into one single window. The aim of this app is to increase productivity and reduce the need for having multiple browser tabs open.
If you are going to develop this project, change line 6 in the package.json to:
\n
\"main\": \"src/electron.js\",
\n
and in the src/electron.js file, make sure that you set isDev to true (I will be fixing this to use the environment rather than manually):
\n
letisDev=true;
\n
To run this project, you need to run the React server in one terminal:
\n
npm start
\n
And then run the electron app:
\n
npm run electron
\n
This repo contains two scripts (these scripts have been used on MacOS but should work on Linux):
\n
The build script executed by:
\n
./build.sh
\n
will build the React project then copy the src/electron.js and src/preload.js files over into the build folder. From there, electron-builder is ran to compile for all platforms (this may error out on Linux due to MacOS apps not being able to be signed).
\n
Building for MacOS may be problematic as the code was signed by me using a Provisioning profile. You may need to delete some parts of the electron-builder.json file in order to build it properly. (Possibly the provisionProfile field)
\n
The cleanup script executed by:
\n
./cleanup.sh
\n\n
Releases
\n
See the releases page for all releases and to download the binaries.
\n\n
Roadmap
\n
See the open issues for a list of proposed features (and known issues).
\n\n
Contributing
\n
Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.
\n\n
Fork the Project
\n
Create your Feature Branch (git checkout -b feature/AmazingFeature)
\n
Commit your Changes (git commit -m 'Add some AmazingFeature')
\n
Push to the Branch (git push origin feature/AmazingFeature)
\n
Open a Pull Request
\n\n\n
License
\n
Distributed under the GNU General Public License v3.0 License. See LICENSE for more information.
Socially is an application which combines all of your social media DM's and chats into one single window. The aim of this app is to increase productivity and reduce the need for having multiple browser tabs open.
If you are going to develop this project, change line 6 in the package.json to:
\n
\"main\": \"src/electron.js\",
\n
and in the src/electron.js file, make sure that you set isDev to true (I will be fixing this to use the environment rather than manually):
\n
letisDev=true;
\n
To run this project, you need to run the React server in one terminal:
\n
npm start
\n
And then run the electron app:
\n
npm run electron
\n
This repo contains two scripts (these scripts have been used on MacOS but should work on Linux):
\n
The build script executed by:
\n
./build.sh
\n
will build the React project then copy the src/electron.js and src/preload.js files over into the build folder. From there, electron-builder is ran to compile for all platforms (this may error out on Linux due to MacOS apps not being able to be signed).
\n
Building for MacOS may be problematic as the code was signed by me using a Provisioning profile. You may need to delete some parts of the electron-builder.json file in order to build it properly. (Possibly the provisionProfile field)
\n
The cleanup script executed by:
\n
./cleanup.sh
\n\n
Releases
\n
See the releases page for all releases and to download the binaries.
\n\n
Roadmap
\n
See the open issues for a list of proposed features (and known issues).
\n\n
Contributing
\n
Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.
\n\n
Fork the Project
\n
Create your Feature Branch (git checkout -b feature/AmazingFeature)
\n
Commit your Changes (git commit -m 'Add some AmazingFeature')
\n
Push to the Branch (git push origin feature/AmazingFeature)
\n
Open a Pull Request
\n\n\n
License
\n
Distributed under the GNU General Public License v3.0 License. See LICENSE for more information.
Social Amnesia aims to make your social media (twitter/reddit) only exist within a time period that you choose. For many people, there is no reason they want to have years old tweets or reddit comments publicly accessible. With Social Amnesia, set the time period you want to keep, whitelist posts and items you want to preserve indefinitely, and let Social Amnesia wipe the rest out of existence.
\n
\n
Sponsor the development of Social Amnesia
\n
You can sponsor me on GitHub to fund the continued development of Social Amnesia!\nYou can also make a one-time donation directly via:
Send Bitcoin to 36Bq7F2JZdYEWLyB8jPWB1XuLCBCCkLvHn
\n
\n
\n
And please follow me on Twitter to receive updates on the development of Social Amnesia!
\n
How to build/run Social Amnesia
\n
Executables
\n
This is the simplest option. Bundled and easily usable files for Mac, Windows and Linux are available on the releases page.
\n
How to run Social Amnesia from the command line
\n
First, clone this repo.
\n
In order to run Social Amnesia, you will need to set up Reddit and Twitter APIs.
\n
For Reddit, you will want to create an installed app using https://www.reddit.com/prefs/apps. Set your redirect url to be https://google.com. Then you will need to create a redditSecrets.ts file in the src/ directory:
For Twitter, create an app using https://developer.twitter.com/en/apps, enable Sign in with Twitter, set the Callback URL to be https://google.com, and then create a twitterSecrets.ts file in the src/ directory:
Then you can run yarn run electron:serve and start developing!
\n
How to build the executables for Social Amnesia
\n
Simply run yarn run electron:serve once you have completed the steps above. Output is sent to the dist_electron folder.
\n
Sites and Features
\n
Reddit
\n
\n
Delete comments and posts, individually or en masse.
\n
Edits your posts before deleting them. According to the reddit admins this is an effective way to remove content from reddit.
\n
Keep a time range of comments and submissions.
\n
Keep comments or submissions that reach a certain amount of upvotes.
\n
Whitelist specific posts and comments you want to save.
\n
Schedule deletions daily.
\n
\n
Twitter
\n
\n
Delete tweets, retweets, replies and remove \"favorites\" (aka ❤️'s), individually or en masse.
\n
Keep a time range of tweets, retweets, replies and favorites.\n
\n
In the case of favorites, this is done by the time the favorited item was created, NOT the time it was favorited at.
\n
\n
\n
Keep tweets that have reached a certain amount of retweets or favorites.\n
\n
This option ignores retweets, these will be removed no matter what if they are out of the time range.
\n
\n
\n
Whitelist specific tweets and favorites you want to save.
\n
Schedule deletions daily.
\n
\n
Contributing
\n
Contributions are not only welcomed but greatly appreciated. If you have any idea for a new feature, or find a bug, you can open up a new issue and report it. Better yet, fork this project, write up some code, and submit a new pull request.
\n
Don't feel comfortable coding? That's okay! There are plenty of other ways to contribute to this project:
\n
\n
The easiest is to just share it. Post it (ironically?) on your social media. Tell your friends and family. Launch t-shirts at bewildered pedestrians. Drop pamphlets out of air planes. Get creative!
\n
UX people are needed to help make mockups to improve the design of the application.
\n
Do you have a social media account with lots of posts you would like to donate to the cause? Accounts like these can be used to help us bug hunt. Open an issue or tweet @NickGottschlich.
\n
Be a user tester! Just record your experience using this the first time using screen recording software and upload it as an issue. Better yet if you can record yourself talking through your thoughts as you try out the software for the first time!
\n
\n
Limitations
\n
\n
Reddit\n
\n
reddit API currently only indexes ~1k most recent items back (confirmed for comments, not submissions)
\n
\n
\n
Twitter\n
\n
twitter API currently only indexes ~3200 tweets and favorites back
\n
\n
\n
\n
Tech talks / Blog Posts
\n
Note: These talks and posts may be using the user interface from Social Media 1.0, which looks significantly different from the new version!
\n
@NickGottschlich spoke about Social Amnesia at the Austin Python Monthly Meetup on April 10th, 2019.
Social Amnesia aims to make your social media (twitter/reddit) only exist within a time period that you choose. For many people, there is no reason they want to have years old tweets or reddit comments publicly accessible. With Social Amnesia, set the time period you want to keep, whitelist posts and items you want to preserve indefinitely, and let Social Amnesia wipe the rest out of existence.
\n
\n
Sponsor the development of Social Amnesia
\n
You can sponsor me on GitHub to fund the continued development of Social Amnesia!\nYou can also make a one-time donation directly via:
Send Bitcoin to 36Bq7F2JZdYEWLyB8jPWB1XuLCBCCkLvHn
\n
\n
\n
And please follow me on Twitter to receive updates on the development of Social Amnesia!
\n
How to build/run Social Amnesia
\n
Executables
\n
This is the simplest option. Bundled and easily usable files for Mac, Windows and Linux are available on the releases page.
\n
How to run Social Amnesia from the command line
\n
First, clone this repo.
\n
In order to run Social Amnesia, you will need to set up Reddit and Twitter APIs.
\n
For Reddit, you will want to create an installed app using https://www.reddit.com/prefs/apps. Set your redirect url to be https://google.com. Then you will need to create a redditSecrets.ts file in the src/ directory:
For Twitter, create an app using https://developer.twitter.com/en/apps, enable Sign in with Twitter, set the Callback URL to be https://google.com, and then create a twitterSecrets.ts file in the src/ directory:
Then you can run yarn run electron:serve and start developing!
\n
How to build the executables for Social Amnesia
\n
Simply run yarn run electron:serve once you have completed the steps above. Output is sent to the dist_electron folder.
\n
Sites and Features
\n
Reddit
\n
\n
Delete comments and posts, individually or en masse.
\n
Edits your posts before deleting them. According to the reddit admins this is an effective way to remove content from reddit.
\n
Keep a time range of comments and submissions.
\n
Keep comments or submissions that reach a certain amount of upvotes.
\n
Whitelist specific posts and comments you want to save.
\n
Schedule deletions daily.
\n
\n
Twitter
\n
\n
Delete tweets, retweets, replies and remove \"favorites\" (aka ❤️'s), individually or en masse.
\n
Keep a time range of tweets, retweets, replies and favorites.\n
\n
In the case of favorites, this is done by the time the favorited item was created, NOT the time it was favorited at.
\n
\n
\n
Keep tweets that have reached a certain amount of retweets or favorites.\n
\n
This option ignores retweets, these will be removed no matter what if they are out of the time range.
\n
\n
\n
Whitelist specific tweets and favorites you want to save.
\n
Schedule deletions daily.
\n
\n
Contributing
\n
Contributions are not only welcomed but greatly appreciated. If you have any idea for a new feature, or find a bug, you can open up a new issue and report it. Better yet, fork this project, write up some code, and submit a new pull request.
\n
Don't feel comfortable coding? That's okay! There are plenty of other ways to contribute to this project:
\n
\n
The easiest is to just share it. Post it (ironically?) on your social media. Tell your friends and family. Launch t-shirts at bewildered pedestrians. Drop pamphlets out of air planes. Get creative!
\n
UX people are needed to help make mockups to improve the design of the application.
\n
Do you have a social media account with lots of posts you would like to donate to the cause? Accounts like these can be used to help us bug hunt. Open an issue or tweet @NickGottschlich.
\n
Be a user tester! Just record your experience using this the first time using screen recording software and upload it as an issue. Better yet if you can record yourself talking through your thoughts as you try out the software for the first time!
\n
\n
Limitations
\n
\n
Reddit\n
\n
reddit API currently only indexes ~1k most recent items back (confirmed for comments, not submissions)
\n
\n
\n
Twitter\n
\n
twitter API currently only indexes ~3200 tweets and favorites back
\n
\n
\n
\n
Tech talks / Blog Posts
\n
Note: These talks and posts may be using the user interface from Social Media 1.0, which looks significantly different from the new version!
\n
@NickGottschlich spoke about Social Amnesia at the Austin Python Monthly Meetup on April 10th, 2019.
Improve Table of contents generation (skip YAML-block, ignore horizontal rules).
\n
Remove codeblock background-color, which caused performance issues.
\n
Fix OpenLinkHandler.
\n
\n
Know issues
\n
OS X binary
\n
Due to this issue with Electron we can't provide a binary for OS X yet. You can still run Abricotine on OS X by building it, or use the previous version binary for OS X.
\n
Contributions are welcome if you want to help fixing this.
\n
For Linux Users
\n
If you encounter issue when running the app on Linux, try running this in the terminal:
\n
sudo sysctl kernel.unprivileged_userns_clone=1\n
\n
An alternative workaround is to run Abricotine with the --no-sandbox parameter.
Dear Antares users we are happy to provide one of the biggest updates ever. The way to 1.0 is shorter every release. \nWith this update we reworked the whole tab system with the goal to boos productivity and application performance. \nNow you can keep open every kind of tab you need in your workspace, not just query tabs.
\n
If you notice some issues consider to report them, helping us to build a more solid Antares. \nTo stay tuned for latest news, ask questions or tell your opinion follow on Twitter @AntaresSQL.
\nThis build will *replace* your old version of the BitShares UI, whether it's a release candidate or production release. If you want a stable version, use only the latest production release\n
Web deployment
\nThis release is available as web deployment at\n
Translation, Integration Bugfixes and Improvements
\nThanks to all integration testers and translators for this release! Release progress is visible in the project https://github.com/bitshares/bitshares-ui/projects/16\n
Automated release from Travis CI with added files from AppVeyor build
\nPlease find the builds in the attached files as well as the checksums. For Linux users it is also available in the snap edge channel here \n
Grey-out backspace and copy buttons when no URL present.
\n
\n
\n
Upgraded to latest Electron Forge (v6-beta.58)
\n
\n
\n
Use the context bridge to communicate between main and renderer processes. This is the future of cross process communication so this was a good task to tick off. Essentially, Browserosaurus should be slightly more secure now.
\n
\n
\n
Use Electron's in-built copy to clipboard functionality, rather than spawning a child process manually. This will be much easier to maintain and avoid security issues.
\n
\n
\n
Refactored permanent storage to use lowdb, from electron-store. Electron Store had a bug (or relies on a dependency that has a bug) which meant I was unable to upgrade to its latest version whilst using npm 7. The new library, LowDB, has less dependencies but meant I had to write a fair amount of logic to gain all the functionality I was using from Electron Store. If you see anything weird with settings not being stored, please file an issue.
Grey-out backspace and copy buttons when no URL present.
\n
\n
\n
Upgraded to latest Electron Forge (v6-beta.58)
\n
\n
\n
Use the context bridge to communicate between main and renderer processes. This is the future of cross process communication so this was a good task to tick off. Essentially, Browserosaurus should be slightly more secure now.
\n
\n
\n
Use Electron's in-built copy to clipboard functionality, rather than spawning a child process manually. This will be much easier to maintain and avoid security issues.
\n
\n
\n
Refactored permanent storage to use lowdb, from electron-store. Electron Store had a bug (or relies on a dependency that has a bug) which meant I was unable to upgrade to its latest version whilst using npm 7. The new library, LowDB, has less dependencies but meant I had to write a fair amount of logic to gain all the functionality I was using from Electron Store. If you see anything weird with settings not being stored, please file an issue.
Fix an issue where invoking a right-click \"Whois\" lookup in a Log Detail window caused a stack dump (#1418)
\n
Windows releases are signed, but you may see a warning popup when you run the installer (unlike our Mac/Linux releases). See Microsoft Windows beta limitations for details.
🍹 This release patches some issues with Dropbox, which was failing to authenticate and failing to create new vaults. An issue where new entries could be created without a parent group was also fixed.
🍹 This release patches some issues with Dropbox, which was failing to authenticate and failing to create new vaults. An issue where new entries could be created without a parent group was also fixed.
fix: fix lint error \nSimplify development and test configuration (#378) \nfix: remove publish \nchore: bumb node version \nfeat: Add transparency to BrowserWindow options (#430) \nfeat: Add config option to hide on blur (#454) \nfix: serif font on systems that do not define a system font (#455) \nfeat: style scrollbars (#422) \nchore: update package.json \nfix: Move event handling to before the 'preventedDefault' property is read (#435) \nfeat: Open cerebro window on Active screen (#416) \nchore: bump electron version \nfeat: add install plugins manually (#518) \nfeat: add env and dotenv (#519) \nAdd extension to .eslintrc (#472) \nMerge pull request #487 from saadmk11/change-theme-readme \nUpdating the README.md to Document how to change Themes
Fixed the timer not working as of v1.1.1 on Linux machines.
\n
\n
The problem was because of the version update of Electron performed in the last patch that introduced new security settings. This meant that, by default, the renderer process can't use the require function. This caused execution of all scripts to halt as a result of require not being defined. The fix was to allow nodeIntegrations for BrowserWindow, therefore allowing use of require. This has no security implications because Chronobreak does not use any libraries, other than Electron itself.
fix: fix lint error \nSimplify development and test configuration (#378) \nfix: remove publish \nchore: bumb node version \nfeat: Add transparency to BrowserWindow options (#430) \nfeat: Add config option to hide on blur (#454) \nfix: serif font on systems that do not define a system font (#455) \nfeat: style scrollbars (#422) \nchore: update package.json \nfix: Move event handling to before the 'preventedDefault' property is read (#435) \nfeat: Open cerebro window on Active screen (#416) \nchore: bump electron version \nfeat: add install plugins manually (#518) \nfeat: add env and dotenv (#519) \nAdd extension to .eslintrc (#472) \nMerge pull request #487 from saadmk11/change-theme-readme \nUpdating the README.md to Document how to change Themes
The client will only trigger one synchronization retry loop when encountering \nan unreachable Cozy error in both the synchronization process and the remote \nwatcher very closely.
\n
New remote documents whose path would be incompatible with the local \nfilesystem will not be ignored anymore.
\n
Local documents who've been moved or renamed remotely to a path that would be \nincompatible with the local filesystem won't be trashed anymore.
\n
Changes that can't be synchronized because the document has an incompatible \nname or path with the local filesystem will now suspend the synchronization \nand an error message will be displayed so you can take action.
\n
Moves for which the destination path is exactly the same as the source path \nwill now be treated as modifications rather than triggering errors.
\n
\n
Improvements for Windows and macOS users:
\n
\n
After the remote Cozy has been found unreachable because of a network error \nsuch as a interface change, the subsequent requests won't fail anymore with \nthe same error once a stable connection is back.
\n
\n
Improvements for Windows users:
\n
\n
The client should not create conflicts anymore when propagating on Windows the \ncombination of the move/renaming and the modification of a Cozy Note (via the \nNotes web application).
\n
It seems that paths on Windows created by the Desktop client can actually \nexceed the 259 characters limit. Therefore we've increased the limit defined \nin the client itself to 32766 characters. \nDocuments that had been previously found incompatible with the local \nfilesystem because of the previous path length limit will be updated to take \nthe new limit into account. Most of them should thus become compatible.
\n
Synchronization error messages displayed in the main window will now only \ncontain the name of the document involved instead of its complete path.
\n
\n
Improvements for macOS users:
\n
\n
Custom folder icons will now be ignored to avoid blocking the synchronization \nas their name contains a character forbidden on remote Cozies.
\n
The app dock icon should now only be visible when an app window other than the \nmain window is open. This should also prevent blocking the computer shutdown.
\n
\n
Improvements for Linux users:
\n
\n
The client won't show a popup error message anymore when automatically \nstarting with the computer.
We've made some updates to ensure a consistent run experience across browsers. \nNow all browsers run via cypress run run headlessly, with a device pixel ratio \nof 1, and a screen size of 1280x720 by default.
\n
Breaking Changes:
\n
Please read our \nMigration Guide which explains the changes \nin more detail and how to change your code to migrate to Cypress 8.0.
\n
\n
When running cypress run previous to 8.0, some browsers would launch headed \nwhile others were launched headless by default. Cypress now runs all browsers \nduring cypress run as headless by default. Addresses \n#16832.
\n
The default screen size when running a headless browser has been reverted back \nto 1280x720 pixels (pre 7.0 behavior). Addresses \n#16853.
\n
When running the --headless Chrome browser via cypress run, the device \npixel ratio will now be 1 by default, matching the behavior of all other \nbrowsers. This behavior can be overridden through the \nbrowser launch API. \nAddresses #17375.
\n
Cypress now enforces version checks for browser launching and will error \nduring cypress run and not allow opening the browser in cypress open when \nattempting to open unsupported browser versions. Cypress supports Chrome >= \n64, Firefox >= 86, and Edge >= 79. Addressed in \n#17355.
\n
Arguments returned from a chained function will no longer incorrectly be of \ntype jQuery and instead have an any type. Fixes \n#16669.
\n
The Cypress.ConfigOptions, Cypress.ResolvedConfigOptions and \nCypress.RuntimeConfigOption types have been updated so that ConfigOptions \nmatch the JSON schema. Addressed in \n#17251.
\n
\n
Features:
\n
\n
You can now configure certificate authority (CA) and client certificates to \nuse within tests on a per-URL basis via a clientCertificates configuration \noption. See Client certificates for \nmore detail.
\n
Setting the environment variable ELECTRON_RUN_AS_NODE now starts Cypress as \na normal Node.js process rather than an Electron process. See \nRunning headless tests without Xvfb \nfor more details. Addresses \n#16505.
\n
\n
Bugfixes:
\n
\n
console.log and console.error called within the \nplugins file \nwill now be captured in the stdout sent to the Cypress Dashboard, making it \nvisible in Output logs in the Dashboard. Fixes \n#7434.
\n
There are several fixes for cy.intercept() \nincluding:\n
\n
The times option now works correctly with req.continue. Fixes \n#16821.
\n
localhost is now accepted as a valid hostname in the RouteMatcher. \nFixes #17015.
\n
delay now works correctly with a statusCode of 204. Fixes \n#15188.
\n
\n
\n
When using the experimental \nCypress Studio, there should be a \nreduced occurrence of \"Studio failed to save commands\" error messages. Fixes \n#14767.
\n
cy.invoke() now retains the proper this context on \nnested object methods. Fixes \n#3871.
\n
We no longer trigger unnecessary snapshot re-renders when hovering over the \nCommand Log. Fixes \n#17257.
We've made some updates to ensure a consistent run experience across browsers. \nNow all browsers run via cypress run run headlessly, with a device pixel ratio \nof 1, and a screen size of 1280x720 by default.
\n
Breaking Changes:
\n
Please read our \nMigration Guide which explains the changes \nin more detail and how to change your code to migrate to Cypress 8.0.
\n
\n
When running cypress run previous to 8.0, some browsers would launch headed \nwhile others were launched headless by default. Cypress now runs all browsers \nduring cypress run as headless by default. Addresses \n#16832.
\n
The default screen size when running a headless browser has been reverted back \nto 1280x720 pixels (pre 7.0 behavior). Addresses \n#16853.
\n
When running the --headless Chrome browser via cypress run, the device \npixel ratio will now be 1 by default, matching the behavior of all other \nbrowsers. This behavior can be overridden through the \nbrowser launch API. \nAddresses #17375.
\n
Cypress now enforces version checks for browser launching and will error \nduring cypress run and not allow opening the browser in cypress open when \nattempting to open unsupported browser versions. Cypress supports Chrome >= \n64, Firefox >= 86, and Edge >= 79. Addressed in \n#17355.
\n
Arguments returned from a chained function will no longer incorrectly be of \ntype jQuery and instead have an any type. Fixes \n#16669.
\n
The Cypress.ConfigOptions, Cypress.ResolvedConfigOptions and \nCypress.RuntimeConfigOption types have been updated so that ConfigOptions \nmatch the JSON schema. Addressed in \n#17251.
\n
\n
Features:
\n
\n
You can now configure certificate authority (CA) and client certificates to \nuse within tests on a per-URL basis via a clientCertificates configuration \noption. See Client certificates for \nmore detail.
\n
Setting the environment variable ELECTRON_RUN_AS_NODE now starts Cypress as \na normal Node.js process rather than an Electron process. See \nRunning headless tests without Xvfb \nfor more details. Addresses \n#16505.
\n
\n
Bugfixes:
\n
\n
console.log and console.error called within the \nplugins file \nwill now be captured in the stdout sent to the Cypress Dashboard, making it \nvisible in Output logs in the Dashboard. Fixes \n#7434.
\n
There are several fixes for cy.intercept() \nincluding:\n
\n
The times option now works correctly with req.continue. Fixes \n#16821.
\n
localhost is now accepted as a valid hostname in the RouteMatcher. \nFixes #17015.
\n
delay now works correctly with a statusCode of 204. Fixes \n#15188.
\n
\n
\n
When using the experimental \nCypress Studio, there should be a \nreduced occurrence of \"Studio failed to save commands\" error messages. Fixes \n#14767.
\n
cy.invoke() now retains the proper this context on \nnested object methods. Fixes \n#3871.
\n
We no longer trigger unnecessary snapshot re-renders when hovering over the \nCommand Log. Fixes \n#17257.
Bug fix release, see milestone 0.1.1 for details on issues fixed.
\n
NOTE \nBefore 0.1.1, DarkJ is not signed so auto update on MacOS would not work. 0.1.1 has been signed with proper certificate so auto update should work properly now.
Added setting for automatic code execution \nCode can now be run automatically when changes are made by selecting the option in the settings panel.
\n
\n
\n
Added image controls and info labels \nCompiled images within the Frame View can now be moved, scaled, and/or reflected using either the mouse/wheel, HUD controls or application's View menu items.
\n
\n
\n
Maintenance:
\n
\n
\n
Updated ./build dependencies \nUpdated all build dependencies to the latest versions (including Electron, Project Foundation and Gulp) and implemented ESM modules to refactor and share constants between the Main and Render processes.
\n
\n
\n
Refactored code \nMoved File logic into its own module and refactored Sass code.
Added setting for automatic code execution \nCode can now be run automatically when changes are made by selecting the option in the settings panel.
\n
\n
\n
Added image controls and info labels \nCompiled images within the Frame View can now be moved, scaled, and/or reflected using either the mouse/wheel, HUD controls or application's View menu items.
\n
\n
\n
Maintenance:
\n
\n
\n
Updated ./build dependencies \nUpdated all build dependencies to the latest versions (including Electron, Project Foundation and Gulp) and implemented ESM modules to refactor and share constants between the Main and Render processes.
\n
\n
\n
Refactored code \nMoved File logic into its own module and refactored Sass code.
Deer has a great changes from its first release and these are improvements introduced in this release
\n
\n
Improving the overall User Interface
\n
Multi language support, it allow user to change language while using Deer without restarting it through settings and it supports: English, العربية, Español, Русский, Polski, Português do Brasil, Česky and German
\n
Rich Text Editor with necessary tools for styling your notes
Lots of fixes and changes. Specifically, an AppImage file is now available. This should run on many GNU/Linux versions, and also on Windows using WSL2. For better portability, DomTerm-2.9.3.AppImage was built on a 2-year-old version (30) of Fedora. \nTo use DomTerm-2.9.3.AppImage, making it executable with chmod +x DomTerm-2.9.3.AppImage and optionally rename it or install it somewhere in your path.
Reduce memory leaks. The issue was lying in a transient dependency used by the app for performing inter-process communication (IPC). The improvement will be most noticeable for those who actively use the local store mode since in this mode a huge pack of data regularly goes the \"main process (provider) => renderer/web process (client)\" way.
Windows, Mac and Linux 64bit builds. The windows build includes both 32 and 64 bit binaries.
\n
The packages support these OSes:
\n
MacOS X 10.15 Catalina+ (might work with Mojave too) \nWindows 7, 8, 10+ \nUbuntu 10.04+ or compatible, older Linuxes, and rolling release distros like Arch.
Extension will be retrieved from mime-type / Content-type header from the http response
\n
Avoid over writing the existing files if there are multiple urls with the exact same path \nExisting files will be reported as errors on the final report as well
\n
\n
And some developer debts are payed
\n
\n
Get rid of optional chaining plugin of babel, since its included in the core modules of babel
\n
Update browserlist to reduce the number of polyfills added to the bundle
\n
Reactivate codefactor for quick automatic code review support
\n
And as always update some dependencies (webpack, babel, electron, jest etc.)
Windows, Mac and Linux 64bit builds. The windows build includes both 32 and 64 bit binaries.
\n
The packages support these OSes:
\n
MacOS X 10.15 Catalina+ (might work with Mojave too) \nWindows 7, 8, 10+ \nUbuntu 10.04+ or compatible, older Linuxes, and rolling release distros like Arch.
Fix for XSS and Electron reverse shell vulnerabilities by sanitizing exiftool HTML output in the UI. To take advantage of this, an attacker would have had to write image metadata containing malicious script code to a file that you then download and run through ExifCleaner. Proofs of concept:
It's been a while since I release the previous version 😄 \nThe new version mostly contains UI changes and some new features like the option to mute, unmute all the sounds.
Note that games built for Android are now targeting the \"API level 30\" as required to continue submitting apps to Google Play.
\n
\n
💝 Improvements
\n
\n
Add option to allow building Android App Bundles that can be uploaded if you already published APKs with Play App Signing enabled for your game\n
\n
If you already opted in for \"Play App Signing\" in the Play Developer Console and published some APKs like this, you need to enable the new \"Old upload key\" option, in the Signing Option, before each packaging for Android.
\n
Read this page to learn more and have step by step details of what to do to update your game.
\n
If you publish a new game with Android App Bundles, there is nothing to do!
\n
\n
\n
Add a maximum size for the GDevelop logo so that it's not too big on large resolutions
This release includes fixes for a few bugs that have been popping up more and more due to data source updates. See the change log below for more details. As always, please report any issues or comments to the Issue Tracker. Executables can be downloaded below - simply extract them to a location of your choosing and run.
\n
v1.2.2
\n
Release date: August 17th, 2019
\n
\n
Upgraded a bunch of dependency versions to fix most security issues #43.
\n
Upgraded to Electron 3.1.13, which fixed the menu bar being impossible to see on linux #45.
\n
Fixed a bug that caused the Hits datatable to throw mad errors when hits had no symbol provided #44.
\n
Fixed a long standing bug due to multiple Uniprot IDs being returned. This caused errors in retrieving the Uniprot Summary and ProtVista data #40.
\n
Fix issues building from source on linux #42 - thanks to @hmontenegro for reporting and help troubleshooting.
This has been a long time coming, more than a year. Bunch of speed and performance improvements. Fixed some errors. Got things more or less working on all major platforms. Enjoy. 😅✌️
\n
Known issues with Linux AppImage package not correctly opening the protocol. No solution yet. deb appears to work great.
\n
Pro Tip Press your ALT key while the search bar is focused.
Remove \"open\" module because of its associated vulnerability (https://nodesecurity.io/advisories/663), update all modules, update electron to latest stable version, other small fix
Remove \"open\" module because of its associated vulnerability (https://nodesecurity.io/advisories/663), update all modules, update electron to latest stable version, other small fix
There is now an emoji picker to the right of the message input box that lets you add emojis to your messages in a few clicks. Emojis are searchable and includes a skin color picker for emojis that support this feature.
\n
Open Channels Directly From Conversation
\n
Easily open a channel with your conversation partner. This is useful if you plan on communicating a lot with a same person and want to avoid paying routing fees for every message. Instead of having to search for their alias or ask for their pubkey to initiate a channel open you can now just click Open Channel from the conversation menu.
\n
LND 0.10.0 Support
\n
Updated GRPC library with 0.10.0 proto files. The only breaking change was related to how we calculate fees for each message we send. In 0.9.x we were able to grab the total fees directly from the payment response object. In 0.10.x we now loop over all HTLC's and sum up the total fees for each one. Luckily this is backwards compatible with 0.9.x so we have a single method for both versions.
\n
Code Signing
\n
The releases are now officially being code signed as part of the release process for Mac and Windows builds. This should remove warnings about an unknown developer when launching the apps on those platforms. I think on Windows there might still be some warning until we reach a certain number of downloads
\n
Bugs
\n
Lots of great bug fixes in this release. Thank you to all the testers who reported these issues.
\n
\n
Wallet balance was not updating properly, now it stays in sync. #14
\n
Fixed a display issue when sending really long messages #19
+ added Microsoft Teams storage \n+ added a possibility to override tenant in Microsoft OneDrive \n! disabled automatic installation of KeePassXC-Browser extension \n+ added an option to diagnose YubiKey code listing issues \n- fix #1845: fixed a visible crash on socket write error
\n
Want to keep releases happening? Donate to KeeWeb on OpenCollective or GitHub. Thank you!
TADS save/load works now! Although it's somewhat slow.
\n
Scrollback buffer is now 800 lines or paragraphs.
\n
Bumped Electron to 11.3.0.
\n
\n
Most Mac users should download the build for their machine (macos-x64 for Intel, macos-arm64 for Apple Silicon). The universal build is only important if you need to distribute one binary to a bunch of people.
This release features a complete overhaul of logs and terminals within Lifeboat! It aims to make logs much more readable and performant, and to make interacting with individual services a much more pleasant experience.
\n
\n
Enhancement: Lightning-fast, canvas-based log rendering. This is thanks in large part to the work done by the Visual Studio Code crew to implement this performant terminal work in their app. We're leveraging xterm.js under the hood for a more natural experience.
\n
Enhancement: More interactive experience within the Commands tab. We're also leveraging the node-pty project to create a pseudo TTY interface between Lifeboat and each of your service's containers. This means you can run things like rails console, php artisan tinker and other interactive commands that would otherwise fail without a TTY shell. The commands tab has also been cleaned up to provide a more intuitive experience and prompt for running commands.
\n
Bugfix: Sometimes project logs would print out N times after restarting the project N times. That won't happen anymore 👍
The keyboard shortcuts have been adjusted as they clashed with OS defaults.
\n
TodyCmd or Ctrl + . \nNext DayCmd or Ctrl + N \nPrevious DayCmd or Ctrl + P \nNext WeekCmd or Ctrl + Shift + N \nPrevious WeekCmd or Ctrl + Shift + P \nSettingsCmd or Ctrl + , \nLeave SettingsEsc
Mailspring no longer closes after you link your first account if the system tray has not been configured.
\n
\n
\n
Mailspring's connections to its database no longer time out (causing the red account warning) while syncing more than ~4 accounts, thanks to an updated build of SQLite.
\n
\n
\n
Thanks to everyone for reporting these issues and contributing the information we needed to track them down!
Mailspring no longer closes after you link your first account if the system tray has not been configured.
\n
\n
\n
Mailspring's connections to its database no longer time out (causing the red account warning) while syncing more than ~4 accounts, thanks to an updated build of SQLite.
\n
\n
\n
Thanks to everyone for reporting these issues and contributing the information we needed to track them down!
This app only available on MacOS platform right now, windows version and linux version will be built later. You can download the app using the below link.
v1.0.1 is a security update release. Previous version of Electron, the underlying system, had security risks. Messenger Demo Viewer has been updated to the latest version of Electron.
v1.0.1 is a security update release. Previous version of Electron, the underlying system, had security risks. Messenger Demo Viewer has been updated to the latest version of Electron.
Version 0.4.0 \nThis version includes new features like selective staging and file view live update and some bugfixes. For detailed changes, see Issues page and the release note in app.
Version 0.4.0 \nThis version includes new features like selective staging and file view live update and some bugfixes. For detailed changes, see Issues page and the release note in app.
For the latest features, bug fixes and security patches, check out https://morgen.so \nBy upgrading from within MineTime you have access to special early-bird offers, also valid for Morgen.
\n
Improvements and Bug fixes
\n
\n
We fixed some reported issues with Google Calendars, in particular, the possibility to RSVP and delete invitations.
\n
We restored support for location maps powered by Google Maps.
For the latest features, bug fixes and security patches, check out https://morgen.so \nBy upgrading from within MineTime you have access to special early-bird offers, also valid for Morgen.
\n
Improvements and Bug fixes
\n
\n
We fixed some reported issues with Google Calendars, in particular, the possibility to RSVP and delete invitations.
\n
We restored support for location maps powered by Google Maps.
Allowing duplicated headers (issue #318) was causing some issues with the pre-flight OPTIONS calls and breaking the route headers precedence over environment headers. Duplicated headers are now limited to the Set-Cookie header. (Issue #480)
\n
\n
V1.14.0 Changelog
\n
Welcome to this new release of Mockoon. There are several bug fixes and new features in this version that we hope you will like. But first some news:
\n
\n
\n
With this release, we decided to take the CLI out of beta 🎉. There is still space for improvements, but it looks stable enough. One breaking change though: Node.js v10 is not supported anymore.
\n
\n
\n
More users are joining Mockoon's community every day, spreading the word, contributing to the codebase, and giving us invaluable feedback. We are grateful for this. ❤ While we dedicate more and more time to this project, we are looking for sponsors to help us pursue this great endeavor.
\n
\n
\n
We are interested to learn about specific use cases you or your company encountered. It could even become an article, like Impala's API UX research process we recently published. Contact us!
A new option is now available to serve different responses sequentially. \nIn the below example, Mockoon will answer with 200 → 404 → 500 → 200 → 404... and so on. The sequence gets reset after restarting the server.
A new type of rule, \"Request number\", is now available. It allows you to serve a specific response depending on the index (number) of the entering requests. As for the sequential responses feature, it gets reset when restarting the server.
\n
This example returns a 500 error only for the first call:
\n
\n
While this one returns a 500 error for the first 9 calls:
A new baseUrl helper has been added which returns the request's base URL (without the route path): {protocol}://{hostname}:{port}/{prefix}. (Issue mockoon/commons-server#7)
\n
\n
\n
A new option has been added to prevent forwarding of the API prefix when the proxy mode is enabled. (Issue #237)
\n
\n
\n
\n
Improvements:
\n
\n
\n
To improve the application stability, only one instance can run at a single time. Running a second instance of the application will focus the running instance if any. (Issue #455)
\n
\n
\n
Multiple headers with the same name are now supported everywhere (route headers, environment headers, proxy request/response headers). This may be a non-standard way of sending the headers (vs comma-separated values) but a common one, especially for the Set-Cookie header. (Issue #318)
\n
\n
\n
We added more suggestions to the header names and values dropdowns to help you mock faster!
\n
\n
\n
Thanks to work on issue #199, we improved the look and feel of the HTTP methods dropdown with improved hype (and more accessible) pastel colors.
\n
\n
\n
\n
\"Port is invalid\" message has been updated to \"Port is invalid or access is denied\" to give more hints about the potentially reserved ports on Windows. (Issue #463)
\n
\n
\n
Fixes:
\n
\n
We updated the Faker.js library to its latest version. This indirectly solved the issue with 'internet.avatar' URLs returning a 403. (Issue mockoon/commons-server#1)
\n
Having a response with empty rules but an AND operator does not interrupt the rules evaluation and does not serve the wrong response anymore. (Issue mockoon/commons-server#6)
\n
Route path and prefix duplicated slashes are now correctly deduplicated when running the server. (Issue mockoon/commons-server#9)
\n
\n
Thank you
\n
A big thank you to the following people that helped to make Mockoon better:
Fixed issue where saving MoviePrints while file details are not available yet would crash the app
\n
Fixed issue where adding movies while file details and thumbs of the previous movie list were still loading, would stop loading the previous movie list and overwrite the list with the newly added movies
This release note includes updates from both 4.0.0 and 4.0.1.
\n
🎉 Important Features
\n
The Blacklist
\n
Forbid your chosen apps when Mr Noplay is running in work mode. (Click the arrow button above the time inputbox to set work mode)
\n
💎 Functional Updates
\n
Change Maximum Overtime
\n
Now we allow users to change the length of the maximum overtime.
\n
⚙️ Minor Modifications
\n
\n
(4.0.1) User experience enhancements.
\n
\n
🗞 Information
\n
Tips for Windows Users:
\n
\n
Please note that if you've turned on Windows Defender SmartScreen, you may need to click more info and then still allow to run it, or to click run anyway for Windows 8. The situation is here because we cannot afford to buy a signing certificate which costs hundreds of dollars.
\n
\n
Tip for macOS Users:
\n
\n
Please note that the macOS version is unsigned, so you may need to follow this guide in order to use. This software is clean and safe, I promise.
Click \"More info\" and \"Run anyway\" when your windows PC shows \"Windows protected your PC\". \n「WindowsによってPCが保護されました」という画面が表示された場合は、「詳細情報」を参照し、「実行」をクリックしてください。
Bundling OS-specific dependencies only when needed\n
\n
This removes a file from Windows bundles that tripped Windows Defender into finding a false positive
\n
\n
\n
Importing: ensuring arbitrarily large notes collections containing arbitrarily many files with the same name are still imported correctly, assuming the underlying importing library can parse the collection in the first place
\n
\n
Bug Fixes
\n
\n
Editor: disabled automatic clipboard copying when selecting in favor of being able to create multiple cursors while dragging with the middle click (Linux)
\n
Ensuring both creation date and modification date are updated when duplicating a note
\n
Ensuring paste actions when dragging with the middle click are only prevented inside the editor (Linux)
\n
Fixed misalignment in loose task lists
\n
Fixed some regexes that were wrongly expecting to match at least one character in certain places
\n
Multi-cursors: using “Ctrl+MouseEvent” rather than “Alt+MouseEvent” as the latter switches the focus to the menu bar (Windows)
You can find the release notes for this month's release in this changelog.
\n
That next desktop release will ship on February 22nd, 2020.
\n
Thank you for using the nteract desktop app! nteract is a non-profit open-source organization fiscally sponsored by NumFOCUS. If you like our work, please consider making a recurring donation.
This patch release includes some minor usability enhancements.
\n
NB!! The source code linked to here is not the actual tagged release source code. Please contact Particl for source code information. The actual source code will be uploaded and made available after an appropriate interval of time has passed.
\n
RELEASE INFORMATION
\n
\n\n
\n
BUILD
\n
NETWORK
\n
PARTICL CORE (MIN VERSION)
\n
MARKETPLACE VERSION
\n
\n\n\n
\n
2.3.6
\n
mainnet
\n
0.19.2.6
\n
0.2.10
\n
\n\n
\n
UI UPDATES
\n
\n
Includes a new top status bar (top right corner of the application) item that presents a dialog to automatically export the necessary data that assists with particl-core blinded output debugging.\n
\n
NOTE: requires available wallets to be \"unlocked\" at the time of performing the export.
\n
\n
\n
The console dialog now allows for commands to be input that are escaped as provided by particl-core, eg: the format of this command would now be valid: filtertransactions \"{\\\"type\\\":\\\"anon\\\",\\\"count\\\":0}\"
\n
\n
REQUIREMENTS
\n
\n
For a new installation: in order to “activate” the open marketplace, the user needs to add a wallet named “Market” (any capitalization would work). The open marketplace is currently only available via the Particl Desktop on this wallet.
\n
\n
NOTES
\n
\n
There will be an automatic update to the latest supported particl-core version, if applicable, when the marketplace is launched.
\n
If using an encrypted marketplace wallet, the wallet needs to be unlocked in order to process buy and sell orders on the open marketplace. It is not necessary to unlock the wallet to process or browse listed items.
\n
The marketplace is still in on-going development, and thus is considered to be a Beta release.
\n
NB!! The source code linked to here is not the actual tagged release source code. Please contact Particl for source code information. The actual source code will be uploaded and made available after an appropriate interval of time has passed.
\n
\n
KNOWN ISSUES
\n
\n
Please only use the .dmg file to install the application for Mac OSX 10.15 or greater. The .app file extracted from the zip package does not currently run on OSX 10.15 (although it should work correctly on 10.14 (Mojave) or earlier)
\n
\n
VERIFICATION
\n
LINUX:\n068f1a6d6d7021b142e20566ebe1e6f861a06dabd299c7f17345cbd69896b6db particl-desktop-2.3.6-linux-amd64.deb\n2c79c07ad648967a41749c0011b62af303b2698f866e90f59b5404f450ffa142 particl-desktop-2.3.6-linux-x64.zip\n1fa773f3c737a724e62575194f5354b33b4f98b2b27c2dc1e0a39d25f6de57f0 particl-desktop-2.3.6-linux-x86_64.rpm\n\n\nWINDOWS:\ne8dcfbe5bbc142ff86e1496049d71c3bd4931cf6e65e7f3f69aaf00527d8a552 particl-desktop-2.3.6-win.exe\nf28f20d7f8be521dd313fe1c654f04598e21841ba6c04493f5b78070df008972 particl-desktop-2.3.6-win-ia32.zip\na25ce5d581685678dd13b157e61ddb97c619a1af757b462dc50ebfe3f0eaccb7 particl-desktop-2.3.6-win-x64.zip\n\n\nOS X:\nAny version, including 10.15 (Catalina) or greater\nf64949b01f5b5302a18a5487c998725baded41c873d91f06b0bd8272aeae1596 particl-desktop-2.3.6-mac.dmg\n\nCan only be used on 10.14 (Mojave) or earlier\nf90d6250ed7ddb880a55f3b03fd7bcbbcbcb2cd4729f354f06e7dc69c12d3100 particl-desktop-2.3.6-mac.zip\n
That's right folks. This is it. Nearly six years after the initial commit by Paul, the time of Patchwork will come to an end.
\n
This is the last release of Patchwork \nThere will be no further development on Patchwork. \nIssue tracker and pull requests will be closed.
\n
This release is meant to tide us over so that other clients can take it from here.
\n
Where do we go from here? Do I have to change client now?
\n
For the time being (the next couple of months) you should be fine to just keep Patchwork running. However, as time progresses and security of the underlying components \"degrades\" (read: already existing issues are discovered) it will become a bad idea to keep running Patchwork. \nBy that time, you should pick a different ssb client.
\n
Why retire Patchwork? Can I keep it alive?
\n
Of course Patchwork is, as always, released under the AGPL license. So if you really wanted to, you could fork it and keep it alive. However, let me (Daan) explain why this is a bad idea:
\n
All the devs say \"Don't do it!\"
\n
Everyone who has spent significant time in the codebase agrees that it is time to retire Patchwork. Over the years, it has seen multiple iterations of developers coming in, trying to change things in a structural way, then burning out on it. It's a pattern, so be warned. This is due to the fact that Patchwork makes some architectural decisions that make it hard to maintain, and even harder for new developers to get into the codebase:
\n
\n
depject is a bespoke dependency injection system, which breaks any kind of navigation and tool support for debugging.
\n
mutant is another bespoke implementation of observables. It is also used for generating HTML, which makes a transition to component-based UI toolkits very hard.
\n
custom sbot: Patchwork doesn't really work except with its own, bundled ssb-server. This is considered bad form; ssb applications should really be able to peacefully co-exist.
\n
ssb-db, the bespoke database of the original ssb stack, is deeply baked into patchwork. Migrating to the new ssb-db2 would be a long and painful process. This is compounded by the fact that patchwork bundles a few custom plugins for ssb-db.
\n
\n
I want to be clear that none of the above are impossible to solve; in fact, they all have straight-forward but labour-intensive solutions. I also want to be clear that these technological choices were all made for good reasons at the time, and I am sure you're as greatful to the developers who made them as I am, for putting their (overwhelmingly volunteered!) time into the project, and for making Patchwork the application that it is. In combination however, the above issues mean that new developers are faced with a very, very steep leaning curve before they're able to even make small changes. \nGiven all of the above, it makes more sense to deprecate Patchwork and focus our efforts on projects like oasis or manyverse which are nearing feature parity with Patchwork. If you want to get involved with ssb development, both are great projects for that; they are much more hackable than Patchwork, and follow standard techniques & workflows, so you'll feel right at home.
\n
If you do, against all advice, want to continue developing Patchwork then we kindly request you rename it to reflect the change in leadership.
If this somehow doesn't work, you might be on the beta channel. Using sudo snap refresh --channel=stable ssb-patchwork should solve this.
\n
You can also download ssb-patchwork_3.18.1_amd64.snap directly but you have to install with snap install --dangerous because it's unsigned.
\n
\n
\n
\n
Getting started
\n
If this is your first time on Scuttlebutt you may need an invite to get connected. After installing Patchwork and choosing your name you should select the Join Pub button. You'll need to get a pub invite, paste it into the prompt, and select Redeem invite.
Spellchecking: add ability to select multiple languages or to disable it completely.
\n
Rudimentary Status page shows index progress per view
\n
Context menus are much richer now, allowing to copy media & open things in Browser both locally and on a public viewer.
\n
\n
Deprecated
\n
\n
Use of depject had been deprecated for a long while. \nAs a proof of concept, some modules in this release were now migrated from depject to regular imports.
\n
\n
Security
\n
\n
A metric ton of version bumps, most notably including electron (now v11.3.0) and chloride. \nThe result is a much snappier experience and virtually no \"falling back to JS crypto\" slowness.
While publishing a message, the content warning will be trim()'ed of leading and trailing whitespace. If the result is empty, no content warning will be published.
\n
\n
Fixed
\n
\n
Drop-down for blocking feeds was not showing (#1328, fixed in #1368)
Poddr 2.0.0 is finally here and with it comes a lot of new stuff!
\n
TL;DR Poddr just got a HUGE update, updated look, updates under the hood and more new features!
\n
Poddr is getting a major overhaul! \nThere are a lot of work behind this update but with a lot of new changes comes a lot of new things and scenarios to test out so if you encounter any issues feel free to open an issue in the repository.
\n
Poddr is free and will remain free to use but I've invested a lot of time into this so if you appreciate the work I do you can make a monetary donation to support the continued development of Poddr. There are several ways to do this and they are explained in the README of this repository.
\n
So without further ado let's move on to the actual changes!
\n
\n
Poddr is now ported from AngularJS to Angular 8 & Typescript! This means greater performance, better maintainability, minified production builds and more!
\n
The whole codebase is more or less refactored to improve performance, reliability, logging, readability and structure.
\n
Poddr is now mainly built by Flexbox and custom CSS classes to reduce the need for 3rd party frameworks.
\n
I aim to use as much CSS3 & HTML5 (for layout/animations etc.) as possible to improve performance, in the process of doing this I ended up writing my own package for pure CSS tooltips with support for CSS custom properties (it's called Pop-Pop.css, check it out!).
\n
The amount of design changes are too many to mention so I'll just say that most things are changed but you will recognize Poddr 😄
\n
Poddr now remembers your navigation in the app so you can utilize your mousebuttons or the newly added buttons in the titlebar to move forwards and backwards.
\n
Podcasts now has a dedicated page instead of the old side menu that slid in.
\n
There are now support for different themes! You will still be able to choose your own primary color and then there are a couple of themes you can try out (default is the dark theme ofc 💃). There will be more themes added in the future and if you become a top donor of mine you will be able to make your own theme together with me which will be bundled with Poddr for everyone to see and use!
\n
The font is changed to Nunito Sans.
\n
All icons are now SVGs instead of a webfont.
\n
Improved responsiveness of different pages and layouts (Podcast grids now looks good even on a 4k screen!).
\n
Poddr now remembers where you were in a currently playing podcast when you exit Poddr.
\n
There's finally an early version of offline functionality! This is subject to change and I'm listening to all of your suggestions on this matter. At this moment Poddr downloads the podcast file to a folder named Poddr in your Downloads folder. Poddr also stores a reference to this location together with title and author of the podcast. You can find all of your downloaded episodes on the favourites page. At the moment Poddr doesn't download the associated podcast cover so it will use the default Poddr cover instead.
\n
There's now also a .deb file for Linux users who prefers that over snaps & appimages.
\n
\n
Notices
\n
\n
If you are upgrading from a version of Poddr that is earlier than 1.1.0 and you want to keep your settings you have to install 1.1.0 first and run it once. This will migrate your old settings to the new format that is used by Poddr 1.1.0+.
\n
The .AppImage no longer asks for desktop integration since electron-builder decided to no longer support this. To integrate it you can either use appimaged or AppImageLauncher, you can also create your own .desktop file.
\n
\n
This last year have been challenging in a lot of different ways but I'm really happy to be able to say that 2.0.0 is here 🕺
\n
Thanks for using Poddr! \n// Marcus \"Sn8z\" Sneitz
⚠️ : This release will cause you to have to re-login to Pullp and re-select the repositories you want to monitor!
\n
Welcome to Pullp 3.0.0! This release has some quite major changes which I hope you will enjoy. These include:
\n
\n
💄 Total refresh of the colour palette and re-work of UI, particularly the information shown when you drill down into the pull requests for a particular repository.
\n
✨ Extended and customisable notification types! You now get notified for reviews on your PR, requests for your review, pull requests getting opened/closed/merged and comments on PRs. Turn them on/off on the Settings screen. 👍
\n
✨ New display choices on the Monitor screen - choose from a full view, a minimised view or a view showing only your open PRs (across all repos!).
\n
✨ Recently closed PRs are now shown for each repository
\n
✨ Tooltips!
\n
✨ Notification counters are now shown in the UI. You can dismiss them by clicking on them, or by clicking on the PR to view it in Github.
⚠️ : This release will cause you to have to re-login to Pullp and re-select the repositories you want to monitor!
\n
Welcome to Pullp 3.0.0! This release has some quite major changes which I hope you will enjoy. These include:
\n
\n
💄 Total refresh of the colour palette and re-work of UI, particularly the information shown when you drill down into the pull requests for a particular repository.
\n
✨ Extended and customisable notification types! You now get notified for reviews on your PR, requests for your review, pull requests getting opened/closed/merged and comments on PRs. Turn them on/off on the Settings screen. 👍
\n
✨ New display choices on the Monitor screen - choose from a full view, a minimised view or a view showing only your open PRs (across all repos!).
\n
✨ Recently closed PRs are now shown for each repository
\n
✨ Tooltips!
\n
✨ Notification counters are now shown in the UI. You can dismiss them by clicking on them, or by clicking on the PR to view it in Github.
Version 0.5.0 can now open the XML formats UN/CEFACT CII and UBL , plain PDF, and PDF with embedded Factur-X. In the latter case one tab with the PDF and one with the visualized XML will open. Please report any Factur-X/ZUGFeRD samples where anything is wrong or missing.
Increase the way of displaying keys in directory mode \nFix translation errors in multiple languages \nIn line display mode, use scan command to get keys \nFix the problem that the scan command fails to execute under the command line \nAdjust the layout of delete and refresh buttons
removed --nonfree from ffmpeg and built ffmpeg on high sierra VM (note: this change only affects the MAS and Mac builds to support older mac computers back to Mac OSX High Sierra 10.13)
removed --nonfree from ffmpeg and built ffmpeg on high sierra VM (note: this change only affects the MAS and Mac builds to support older mac computers back to Mac OSX High Sierra 10.13)
Release RIDE 4.3 \nThis commit is included with 18.0 Issue 2 installation images on macOS.
\n
Changelog: \nUpdate location of Info.plist \nfix isDyalogBuild and remove afterCopy on Electron-packager \nopen help with navigation pane opened fix #581 \nset isDyalogBuild to false \nDisable check for building with Dyalog \nFix changelog not populating on github releases \ndon't hard-code RIDE version in Jenkins \nmount /devt inside Github Publish container \nJenkins (#585) \nMerge changes for zfpr to ride4.3 from master
Release RIDE 4.3 \nThis commit is included with 18.0 Issue 2 installation images on macOS.
\n
Changelog: \nUpdate location of Info.plist \nfix isDyalogBuild and remove afterCopy on Electron-packager \nopen help with navigation pane opened fix #581 \nset isDyalogBuild to false \nDisable check for building with Dyalog \nFix changelog not populating on github releases \ndon't hard-code RIDE version in Jenkins \nmount /devt inside Github Publish container \nJenkins (#585) \nMerge changes for zfpr to ride4.3 from master
This beta version of ScanCode Workbench is compatible with scans from any ScanCode Toolkit develop version/branch at or after v3.1.1.
\n
Using
\n
\n
\n
To install, download and extract the release for your operating system from the archives above. Then, run the ScanCode-Workbench application from the extracted directory.
\n
\n
\n
For more information on how to use the app see the wiki.
This beta version of ScanCode Workbench is compatible with scans from any ScanCode Toolkit develop version/branch at or after v3.1.1.
\n
Using
\n
\n
\n
To install, download and extract the release for your operating system from the archives above. Then, run the ScanCode-Workbench application from the extracted directory.
\n
\n
\n
For more information on how to use the app see the wiki.
Skrifa was created with privacy and simplicity in mind, to continue with that mission, Skrifa needed to improve it's compatibility with common PGP solutions, therefore this release besides fixing features and adding some features was focused specially on making PGP and Skrifa work in a better way to provide you a great tool to protect your privacy.
\n
Features Added:
\n
\n
You can now use your existing PGP key or create a new one instead of using a Skrifa account
\n
PDF and HTML export targets are now available
\n
You can now create a Migration backup in order to use another key
\n
It is now possible to clear all data within the app
\n
You can now create unencrypted backups
\n
Exporting your public key is now possible
\n
New Ghost and Playful Themes are available
\n
Keyboard shortcuts are now available for text styling in the editor and creating new notes
\n
Pacman and FreeBSD builds are now available
\n
You can now share a note as a plain text PGP message
\n
\n
Bugs Fixed:
\n
\n
App closed even when there was unsaved data
\n
Couldn't import local images in any other than PNG format
\n
Notebook welcome screen overlapped with the top nav bar
\n
Note would not be saved if there was no H1 title available
\n
Views were not scrollable if the window was too small
\n
Some cancel file dialogs where not handled correctly
\n
Network requests errors in the login process where not being handled correctly
Skrifa was created with privacy and simplicity in mind, to continue with that mission, Skrifa needed to improve it's compatibility with common PGP solutions, therefore this release besides fixing features and adding some features was focused specially on making PGP and Skrifa work in a better way to provide you a great tool to protect your privacy.
\n
Features Added:
\n
\n
You can now use your existing PGP key or create a new one instead of using a Skrifa account
\n
PDF and HTML export targets are now available
\n
You can now create a Migration backup in order to use another key
\n
It is now possible to clear all data within the app
\n
You can now create unencrypted backups
\n
Exporting your public key is now possible
\n
New Ghost and Playful Themes are available
\n
Keyboard shortcuts are now available for text styling in the editor and creating new notes
\n
Pacman and FreeBSD builds are now available
\n
You can now share a note as a plain text PGP message
\n
\n
Bugs Fixed:
\n
\n
App closed even when there was unsaved data
\n
Couldn't import local images in any other than PNG format
\n
Notebook welcome screen overlapped with the top nav bar
\n
Note would not be saved if there was no H1 title available
\n
Views were not scrollable if the window was too small
\n
Some cancel file dialogs where not handled correctly
\n
Network requests errors in the login process where not being handled correctly
It's finally here! After many Beta builds and many setbacks. Socially has been completely rewritten and works better than ever! Written in React, this new Socially is faster and better than V0.5. Socially will also soon be on the Mac App Store. It is being reviewed and I will edit this when it is live.
Image Compressor: \nA small tool built with xkeshi's module to compress JPEG images in size.
\n
\n
\n
Support Linux \nHead over here to know How to get Color Emojis in Linux ?
\n
\n
\n \n
Changelog
\n
2340d36 bestzip for windows platform\n4f25410 use bestzip module to zip the builds\n40d882b 0.2.1\n11b1bac make default .png\n3e5756c do not go frameless on any operating system\n77acd57 feature: imagecompresser\n
Image Compressor: \nA small tool built with xkeshi's module to compress JPEG images in size.
\n
\n
\n
Support Linux \nHead over here to know How to get Color Emojis in Linux ?
\n
\n
\n \n
Changelog
\n
2340d36 bestzip for windows platform\n4f25410 use bestzip module to zip the builds\n40d882b 0.2.1\n11b1bac make default .png\n3e5756c do not go frameless on any operating system\n77acd57 feature: imagecompresser\n
Implemented manual update mechanism (OS X & Windows only). If a new version is available on GitHub you should see a dialog the next time you start the Standup Picker. You can then choose to install the download from GitHub and install it manually.
\n
New settings version. Backups from older versions are no longer compatible.
Implemented manual update mechanism (OS X & Windows only). If a new version is available on GitHub you should see a dialog the next time you start the Standup Picker. You can then choose to install the download from GitHub and install it manually.
\n
New settings version. Backups from older versions are no longer compatible.
This release includes the following (notable) new features, improvements and bug fixes:
\n
\n
MathML support: updated to latest MathJax library (3.2.0)
\n
OPDS catalog: prevent adding the same feed URL multiple times
\n
Publication rendering: automatically hide mouse cursor in document viewport when inactive for 1 second
\n
OPDS authentication: title was not human-readable in some cases
\n
User interface: in fullscreen mode, automatically hide bottom and top user interface controls after 1 second of inactivity (reactivated during keyboard activity)
\n
Text To Speech: support for SVG aria-label attribute and title element, new \"read aloud\" option for enabling/disabling utterance splitting (textual sentence detection), and possibility to skip fragmented text when invoking the previous/next navigation commands using the alt+shift key modifiers on button click, or using the available alternative keyboard shortcut
\n
Content navigation UX: modal overlay panel (table of contents, landmarks, bookmarks, search, goto page) automatically closes on button/hyperlink click and keyboard enter events, except when trigerred with key modifiers shift+alt
\n
OS integration: removed installer association of PDF, OPF and ZIP file extensions to avoid hijacking existing file type handlers (Thorium icon and default app launcher). This removes the \"open with..\" menu and double click from file explorer / Finder, but Thorium continues to support these file types via drag and drop and file chooser
\n
Localization: new Swedish translation, and updated Portuguese (Portugal)
\n
Fixed audio/video \"track\" support (CORS cross origin media URL)
\n
Publication information (modal dialog overlay): now displays audiobook tracks and duration
\n
PDF: removed broken paginated / column options
\n
Library / bookshelf tags: avoid showing the special \"about Thorium\" auto-generated publication
This release includes the following (notable) new features, improvements and bug fixes:
\n
\n
MathML support: updated to latest MathJax library (3.2.0)
\n
OPDS catalog: prevent adding the same feed URL multiple times
\n
Publication rendering: automatically hide mouse cursor in document viewport when inactive for 1 second
\n
OPDS authentication: title was not human-readable in some cases
\n
User interface: in fullscreen mode, automatically hide bottom and top user interface controls after 1 second of inactivity (reactivated during keyboard activity)
\n
Text To Speech: support for SVG aria-label attribute and title element, new \"read aloud\" option for enabling/disabling utterance splitting (textual sentence detection), and possibility to skip fragmented text when invoking the previous/next navigation commands using the alt+shift key modifiers on button click, or using the available alternative keyboard shortcut
\n
Content navigation UX: modal overlay panel (table of contents, landmarks, bookmarks, search, goto page) automatically closes on button/hyperlink click and keyboard enter events, except when trigerred with key modifiers shift+alt
\n
OS integration: removed installer association of PDF, OPF and ZIP file extensions to avoid hijacking existing file type handlers (Thorium icon and default app launcher). This removes the \"open with..\" menu and double click from file explorer / Finder, but Thorium continues to support these file types via drag and drop and file chooser
\n
Localization: new Swedish translation, and updated Portuguese (Portugal)
\n
Fixed audio/video \"track\" support (CORS cross origin media URL)
\n
Publication information (modal dialog overlay): now displays audiobook tracks and duration
\n
PDF: removed broken paginated / column options
\n
Library / bookshelf tags: avoid showing the special \"about Thorium\" auto-generated publication
Fixed undraggable window title bar region (Major issue) (topic #17)
\n
Fixed minor information bar unlimited height (Major issue) (topic #18)
\n
Updated window title bar with a responsive behavior in case of small window
\n
\n
📦 AppImage Linux build (update from Monday April 05, 2021)
\n
Newly added AppImage build allows you to run this version of the app on any modern Linux distribution. To be able to run it, go in this AppImage file properties and activate \"Allow file execution like a program\". Additionally you can allow its integration with your system if it asks you to at app first launch.
\n
You can verify your AppImage download by running in a terminal, next to the AppImage : sha256sum Uncolored-v.0.10.2-linux-x64.AppImage. The result should be exactly 108161c43619a05b0b29ba9de39c0c7ef87e80cf0c455cf361b4e3bef26fc8cd.
Fixed undraggable window title bar region (Major issue) (topic #17)
\n
Fixed minor information bar unlimited height (Major issue) (topic #18)
\n
Updated window title bar with a responsive behavior in case of small window
\n
\n
📦 AppImage Linux build (update from Monday April 05, 2021)
\n
Newly added AppImage build allows you to run this version of the app on any modern Linux distribution. To be able to run it, go in this AppImage file properties and activate \"Allow file execution like a program\". Additionally you can allow its integration with your system if it asks you to at app first launch.
\n
You can verify your AppImage download by running in a terminal, next to the AppImage : sha256sum Uncolored-v.0.10.2-linux-x64.AppImage. The result should be exactly 108161c43619a05b0b29ba9de39c0c7ef87e80cf0c455cf361b4e3bef26fc8cd.
Snapshot & Plugin functions based on latest Node-Vagrant \nUpdate to Electron 5. \nUpdate to Node 10 build sequence. \nUpdate on Mac build options in prep for notarization. \nSimplify tests & use NYC instead of Istanbul \nRewritten configuration setup \nMinor language corrections
Electron has been updated to 1.7.3: \nChrome used by Electron is now 58.0.3029.11, Node and V8 also updated. \nUserland should notice an increase in the smoothness and performance of WAIL when working with large (size and number of) collections
\n
\n
\n
WAIL's Page Only Crawl updated \nThanks to the Chrome version bump in Electron 1.7.3 the Page Only Crawl \nhas been transitioned away from the modified WARCreate style preservation to a full browser based crawl implementation. \nLook for more update as WAIL transitions away from relying on Heritrix to provide its Page + Same Domain and Page + All Links crawls. \nHeritix based crawls will still be available in all future releases of WAIL
\n
\n
\n
Twitter login through WAIL improved \nPrevious releases of WAIL relied on electron-oauth-twitter. \nBut userland found that it was not alway reliable so this functionality has been overhauled completely to ensure reliability.
\n
\n
\n
UX improvements \nTwitter Monitoring and Archiving Configuration UI has been redesigned and condensed making it easier to use this feature \nCollections Interface has been reworked making it easier to manage your collections
\n
\n
\n
Pywb updated \nUpdated to 0.33.1 improving replay for all supported operating systems. \nReplay on Windows is now just as smooth as Linux and OSX ❤️
Electron has been updated to 1.7.3: \nChrome used by Electron is now 58.0.3029.11, Node and V8 also updated. \nUserland should notice an increase in the smoothness and performance of WAIL when working with large (size and number of) collections
\n
\n
\n
WAIL's Page Only Crawl updated \nThanks to the Chrome version bump in Electron 1.7.3 the Page Only Crawl \nhas been transitioned away from the modified WARCreate style preservation to a full browser based crawl implementation. \nLook for more update as WAIL transitions away from relying on Heritrix to provide its Page + Same Domain and Page + All Links crawls. \nHeritix based crawls will still be available in all future releases of WAIL
\n
\n
\n
Twitter login through WAIL improved \nPrevious releases of WAIL relied on electron-oauth-twitter. \nBut userland found that it was not alway reliable so this functionality has been overhauled completely to ensure reliability.
\n
\n
\n
UX improvements \nTwitter Monitoring and Archiving Configuration UI has been redesigned and condensed making it easier to use this feature \nCollections Interface has been reworked making it easier to manage your collections
\n
\n
\n
Pywb updated \nUpdated to 0.33.1 improving replay for all supported operating systems. \nReplay on Windows is now just as smooth as Linux and OSX ❤️
In This release experimental WebFrame features have been added. This includes a built in api and web application solution. This release is currently for Linux but refer to the previous relies for mac and windows.
Welcome to the first release of WizardMirror! This release may be out of date, so make sure to check the releases page for the lastest release. To get started read the readme.
PLEASE UNDERSTAND THAT I'VE BEEN EXTREMELY BUSY ON ACADEMIC LEARNING RECENTLY AND I SUPPOSE I WON'T BE VERY ACTIVE ON DEVELOPING BEFORE JUNE, 2022. AND THIS IS THE REASON WHY SOME FEATURES HAVEN'T BEEN IMPLEMENTED YET.
\n
Updated For:
\n
\n
Added a external window to show the title of current timer to help you get focused.
\n
Added the function to edit the title and notes of current timer during timing.
\n
Added separate settings section for alerting after working and alerting after resting.
\n
Enhanced and have bugs fixed.
\n
\n
Contact Me:
\n
In case you have any suggestion or question, drop me a line at scrisqiu@hotmail.com.
\n
Tips for Windows Users:
\n
\n
\n
Please note that if you've turned on Windows Defender Smartscreen, you may need to click [more info] and then [still allow] to run it, or to click [run anyway] for Windows 8. The situation is here because we cannot afford to buy a signing certificate which costs [hundreds of dollars].
\n
\n
\n
If you are using Windows 7 and the application isn't working properly, please apply for the \"Vista Compatibility Mode\".
\n
\n
\n
Tip for macOS Users:
\n
\n
Please note that the macOS version is unsigned, so you may need to follow this guide in order to use. This software is clean and safe, I promise.
If it's too slow to download, try Motrix, my preferred downloader. The file size is little bit big because we are using Electron as the basic framework.
Read our Postmortem on this issue and the last one on our blog.
\n
\n
This is a hotfix that fixes a potentially severe security-issue, reported to us by the Japanese cybersecurity organisation JPCERT. It was reported that due to insecure iFrame handling on our side, malicious actors could take over users' computers using specially crafted iFrame-embed codes or Markdown-documents containing such an iFrame.
\n
This release closes this vulnerability. Specifically, the following precautions were taken:
\n\n
Now, whenever Zettlr renders an iFrame, it will omit all attributes except src -- in the security disclosure, the attribute srcdoc has been used to maliciously access the test system. While this means that certain features are not supported during preview (e.g., allowfullscreen), remember that the attributes will still be exported so that in HTML exports, they will work.
\n
We have added a global whitelist that by default only contains the hostnames of YouTube and Vimeo players so that those embeds work out of the box. For all other hostnames, rendering of iFrames will be blocked by default. Instead, you will be presented with a warning and be asked whether or not you want to render content from the given hostname. You can then choose to render it once, or permanently add the named hostname to the whitelist.
\n\n
\n
Note that you can completely disable any iFrame pre-rendering in your display preferences.
\n
\n
We would like to apologise for the inconvenience. If you are interested in how it came to this situation, please read our Postmortem on this issue.
Improves typing feeling on long files when html preview is hidden
\n
makes it easier to use an external cloud provider (like Dropbox) by replaying the file and syncing the tags every time you open the note through the note list (add meta at the beginning of files)