### Made by [@kilianvalkhof](https://twitter.com/kilianvalkhof)

#### Other projects:

- 💻 [Polypane](https://polypane.app) - Develop responsive websites and apps twice as fast on multiple screens at once
- 🖌️ [Superposition](https://superposition.design) - Kickstart your design system by extracting design tokens from your website

---

<img src="https://fromscratch.rocks/assets/img/icon.png?">

FromScratch
===========

## A simple but smart note-taking app

FromScratch is a little app that you can use as a quick note taking or todo app.</p>

* Small and simple, the only UI is the text you type
* Saves on-the-fly, no need to manually save
* Automatic indenting
* Note-folding
* Use checkboxes to keep track of your TODO's
* Powerful keyboard control
* Replaces common syntax with symbols, such as arrows
* Dark and Light theme
* Portable mode support
* Free


### Shortcuts

* <kbd>f1</kbd> - show/hide shortcut overview
* <kbd>cmd/ctrl+up</kbd> - move current line up
* <kbd>cmd/ctrl+down</kbd> - move current line down
* <kbd>cmd/ctrl+d</kbd> - delete current line
* <kbd>cmd/ctrl+w/q</kbd> - close application
* <kbd>cmd/ctrl +/=</kbd> - zoom text in
* <kbd>cmd/ctrl -</kbd> - zoom text out
* <kbd>cmd/ctrl+0</kbd> - reset text size
* <kbd>cmd/ctrl+]/[/k</kbd> - fold note collapsing
* <kbd>cmd/ctrl+f</kbd> - search (you can also use regular expressions, by starting and ending with a /)
* <kbd>shift+cmd/ctrl+f</kbd> - replace
* <kbd>shift+cmd/ctrl+r</kbd> - replace all
* <kbd>cmd/ctrl+g</kbd> - jump to line (you can also use <line>:<character> notation, or go relative lines with +<line> and -<line>)
* <kbd>cmd/ctrl+/</kbd> or <kbd>cmd/ctrl+l</kbd> - Add or toggle a checkbox
* <kbd>f11</kbd> - Toggle fullscreen
* <kbd>cmd/ctrl+i</kbd> - Toggle between light and dark theme
* <kbd>alt</kbd> - show or hide menu (Windows only)
* <kbd>cmd/ctrl+s</kbd> - ...this does nothing.

## Download
Recent downloads for macOS, Windows and Linux available on https://fromscratch.rocks

For Arch users, [FromScratch is available on AUR](https://aur.archlinux.org/packages/fromscratch-bin/)

For macOS, you can also install FromScratch via Homebrew: ```$ brew cask install fromscratch```

### Installation
```sh
# Download from git
git clone https://github.com/kilian/fromscratch.git

# Install dependencies
cd fromscratch && npm install

# build and run
npm start

# or run dev version
npm run dev
```
### Command Line Arguments
**Portable Mode**
`--portable`

Lets you store all the files FromScratch generates in a specified location, such as a USB-stick or
other portable storage device. In this mode both the configuration files as well as your text content will be stored in
a "userdata" directory alongside the FromScratch executable, or when given a directory as an argument, will store
the files there.

You can also use this to store the FromScratch configuration files, and the text content, in a synced cloud storage
folder.

```
# run FromScratch in portable mode, saving data in application directory.
fromscratch --portable
```

```
# run FromScratch in portable mode, saving data in custom directory.
fromscratch --portable ~/fromscratch_data
```
**help**
`-h, --help`

Prints help information

### FAQ
*Where is my data saved?*

Your data is saved in a plain text file content.txt. On Mac and Linux, this file is saved in ~/.fromscratch. On Windows
this file is saved in a directory called ".fromscratch" in your userprofile directory.  

*Can my data be saved in an alternate directory?*

Yes! See the **portable mode** section under the **Command Line Arguments** heading above.

### Credits

FromScratch is built upon these open source projects:
	<a href="http://electron.atom.io">Electron</a>,
	<a href="https://facebook.github.io/react/">React</a>,
	<a href="https://github.com/tonsky/FiraCode">Fira Code</a>,
	<a href="http://codemirror.net/">CodeMirror</a> and
	<a href="https://github.com/chentsulin/electron-react-boilerplate">Electron-react-boilerplate</a>.

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.