Skip to content

Latest commit

 

History

History
50 lines (35 loc) · 1.9 KB

README.md

File metadata and controls

50 lines (35 loc) · 1.9 KB
Raw

Mini Diary

Simple and secure journal app Screenshot

Download

Features

  • Beautiful and clean design
  • Encryption
  • Full-text search
  • Light and dark themes
  • Import from Day One, jrnl, or JSON
  • Export to PDF, Markdown, TXT, or JSON
  • Localization in multiple languages
  • Keyboard shortcuts

Development

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.

Running the app

  1. Clone the repository
  2. yarn install
  3. yarn start

Building the app

After cloning the repo and installing the dependencies, run yarn build. The built app can be found in the dist folder.

Contributing

Suggestions and contributions are always welcome! Please first discuss changes via issue before submitting a pull request.

Localization

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:

  1. The translation files can be found in src/main/i18n/translations. Duplicate the en.js file as [LANG].js, where [LANG] is the shortcode of your language.
  2. In the file you just created, replace the English translations with your own. Make sure they fit into the app's input fields.
  3. Import your file in the ALL_TRANSLATIONS object in src/main/i18n/i18n.js.
  4. Add your language shortcode to the electronLanguages array in package.json.
  5. Submit a PR. Thank you!