Olive

Olive is a digital typewriter app for MacOS (also Windows and Linux, but untested). It is not meant to perfectly simulate using a typewriter (the way some skeuomorphic typewriter apps do), but rather bring the workflow into the digital age. There is no copy-pasting, no editing, and correcting mistakes is tedious. That's the fun part.

Formerly "Typeright".

Local development

Start by installing the project dependencies (note: I have not gotten Bun to work here, so you will need to use NPM).

npm install

To boot-up the application locally, run:

npm run dev

You can also run npm run build:mac to test the full build locally (specifically building the application for MacOS). To build for all platforms (Windows, MacOS, and Linux), run:

npm run build

The application can also be built and deployed as a webapp. To test the project in your browser, run npm run dev:web. To build the webapp for production, run: npm run dev:web. The web-version is currently built and deployed from Netlify; you can view it at olive-typewriter.netlify.app.

Project structure

Here is a mini-map of the project to help get your barrings:

├── icon/                 # icon files (ico, icns, png) are automatically used for app icon
├── scripts/              # build scripts
└── src/
    ├── main/
    │   ├── main.ts       # the "app" side (menu bar, reading/writing files, etc)
    │   └── ...
    └── renderer
        ├── App.vue       # the Vue app rendered (SPA)
        ├── components/   # take a wild guess what's in this one
        └── public/       # assets like fonts and sound files

Todo

• download website
• refactor and document
• chores: lint
• remove dependencies
• figure out code signing (...auto-updating?)