https://github.com/espy/writer

Side project, heavily inspired by Left, uses Choo
https://github.com/espy/writer

Last synced: 11 months ago
JSON representation

Side project, heavily inspired by Left, uses Choo

• Host: GitHub
• URL: https://github.com/espy/writer
• Owner: espy
• Created: 2017-12-27T15:53:08.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2018-01-10T21:17:08.000Z (over 8 years ago)
• Last Synced: 2025-03-27T21:52:08.050Z (about 1 year ago)
• Language: JavaScript
• Size: 679 KB
• Stars: 6
• Watchers: 0
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# writer

A themable writing app that encourages regular writing, tracks word count goals and regularity, includes an english thesaurus and can provide writing excercise prompts.

There is a file browsing shelf on the left side, which is basically a calendar. Selecting a file will preview it in the main pane on the right.

## Roadmap

- [x] Calendarised file menu in the sidebar, you select days, not actual files.

  - [ ] File previews show stats (wordcount, date)

- [x] Themeable with hundredrabbits `.thm` files, per drag and drop, with preview

  - [ ] Once file storage is implemented, add a theme management pane

- [x] Character, word and line count

- [ ] Synonym suggestions on tab

  - [x] Basic implementation

  - [ ] Better dictionary

  - [ ] Use stemmer to find word stems

  - [ ] Support more languages

- [x] Electronise the app!

  - [x] Store theme files on disk

  - [x] Store text files on disk

## Bugs

- [x] simple-grep doesn’t support case insensitivity

# Development

You need two terminals running at once, one with `$ npm run build`, which runs the Bankai server and hosts the Choo app, and one with `$ npm start`, which runs the dev instance of Electron.

To set the app icon for this dev instance on MacOS, show the file info for `node_modules/electron/dist/Electron.app` and drag the `./build/icon.icns` file onto the icon in the info pane.

# Packaging the Electron app

Run `$ npm run build`. It will use icon files put in `./build`.

## Routes

Route              | File               | Description                     |

-------------------|--------------------|---------------------------------|

`/`              | `views/main.js`  | The main view

`/*`             | `views/404.js`   | Display unhandled routes

## Commands

Command                | Description                                      |

-----------------------|--------------------------------------------------|

`$ npm start`        | Start the Electron process

`$ npm test`         | Lint, validate deps & run tests

`$ npm run build`    | Compile all files into `dist/`

`$ npm run dev`      | Start the development server

`$ npm run inspect`  | Inspect the bundle's dependencies