Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/asishraju/firepad
Faster Text Editing Without Being AFK 🔥
https://github.com/asishraju/firepad
afk desktop editor electron electron-app firepad keyboard keyboard-aka mousetrap notepad pell text wysiwyg wysiwyg-editor
Last synced: 1 day ago
JSON representation
Faster Text Editing Without Being AFK 🔥
- Host: GitHub
- URL: https://github.com/asishraju/firepad
- Owner: AsishRaju
- License: mit
- Created: 2020-05-16T14:57:40.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2023-02-03T07:20:32.000Z (almost 2 years ago)
- Last Synced: 2023-03-04T10:31:47.261Z (over 1 year ago)
- Topics: afk, desktop, editor, electron, electron-app, firepad, keyboard, keyboard-aka, mousetrap, notepad, pell, text, wysiwyg, wysiwyg-editor
- Language: JavaScript
- Homepage: https://firepad.asish.me
- Size: 3.14 MB
- Stars: 25
- Watchers: 3
- Forks: 5
- Open Issues: 15
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# FirePad 🔥 []()
## Overview 👀
### FirePad is next generation text editing app that beleives faster text editing without being away from keyboard aka AFK.
- **Fully covered with keyboard shortcuts 👨🏻💻**
- **Meaningful Content Generation 📝**
- **30+ Text formatting options 😱**
- **Native file format support 📂**
- **Add clickable links 🔗**
- **To-do list support ✔**
- **Exports to text 📄**
- **Supports Emoji 😁**
- **Dark mode 🌗**
- **Cleaner UI ⚡**
- **Auto updates 🌀**
## But Why FirePad ❓
#### FirePad believes in faster and meaning full content generation, the only bottel neck most of the industry leading word/text editors is being away from keyboard aka (AFK) for formating text. Though keyboard shortcut are available ,not all formatting options are available through them .FirePad bridges this gap by providing full keyboard support to each and every formatting style that FirePad offers with additional meaningful text generation 😀
## Dependencies 🗃
### Short Answer
- [Electron] - **Core module**
- [Pell] - **Simpalistic WYSIWYG Editor**
- [Bootstrap] - **Frontend CSS Framework**
- [MouseTrap] - **Highlevel way of interacting with keyboard**
### Long Answer
- Firepad is made possible with [Electron] which allows web technologies to run on cross platform desktop environment by adding chromium on app instances, great now on the next one.
- Now we need a way for user to enter text in our app, simple right just put a html textbox and done NO!, using text box has its own limitation and dosent really go on with the notion of notepad like experince, this were [Pell] drops into picture, providing more than a textbox.
- This all plugs into [Bootstrap] UI , no need to explain bootstrap right?
- Now another core functionality of FirePad is providing keyboard shorcuts, this is achieved by high level api called [MouseTrap]
- Along with these core functionality modules FirePad also uses sub electron packages for some other built in functions
see `src/FirePadv1.0.0/package.json` for more details
## WIP 🛠
- More Shorcuts and functionality
- Writing scalable and clean code for rapid new modules integration
- Make it hackable , introducing of plugins for FirePad
- Implementing system-wide fonts
## Why should you contribute ❓
- There is a lot more stuff a industry leading text editing based apps can do which FirePad can't , in that note FirePad will grow and at some day people will be sharing .pad files instead of .txt 😅
- After giving 50+ hrs to this project , i realized project like these should not have a one person prespective
- Projects like this need make you think about end users and one mind thinking about that is not a huge prespective
- Help grow FirePad , and help people move out of notepad 😁
## How To Contribute🤝
#### I would recommend you to get familar with the [Electron] before you start working on this project and do have a look at [Pell Documentation] and your good to go!
1. Clone or Download **`src\FirePadv1.0.0`**
2. Open your terminal and run **`npm install`** this install all dependency and sets up your project
3. To start app run **`npm run watch`** -- for Hot-Reload
4. To build app for windows **`npm run build`** -- generates setup file for windows
- Yes,it is open source you can clone and change code to your need.
- Most of the code is self explanatory, anyhow
- for any clarification on code or want to contribute contact
- [Gmail] / [Twitter] /[LinkedIn]
####
## Downloads
| Windows | Mac | Linux |
|----------------------|----------------|----------------|
| [Download Here v1.1.0]! | Coming soon... | Coming soon... |
[Electron]:
[Bootstrap]:
[MouseTrap]:
[Pell]:
[Pell Documentation]:
[Download Here v1.1.0]:
[Gmail]:
[LinkedIn]:
[Twitter]: