https://github.com/samuelmeuli/mini-diary

📘 Simple and secure journal app
https://github.com/samuelmeuli/mini-diary

diary diary-application electron-app journal linux-app mac-app windows-app

Last synced: 3 months ago
JSON representation

📘 Simple and secure journal app

• Host: GitHub
• URL: https://github.com/samuelmeuli/mini-diary
• Owner: samuelmeuli
• License: mit
• Archived: true
• Created: 2018-07-17T17:54:16.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2021-07-11T19:25:19.000Z (over 3 years ago)
• Last Synced: 2024-09-25T19:03:28.414Z (3 months ago)
• Topics: diary, diary-application, electron-app, journal, linux-app, mac-app, windows-app
• Language: TypeScript
• Homepage: https://minidiary.app
• Size: 8.54 MB
• Stars: 1,028
• Watchers: 24
• Forks: 234
• Open Issues: 45
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

• awesome-starred - samuelmeuli/mini-diary - 📘 Simple and secure journal app (others)

README

        


  

  
Mini Diary

  Simple and secure journal app

  



**Mini Diary is no longer maintained. Please use a different journal app instead.**

## Website

Features and FAQs can be found on the website: [**minidiary.app**](https://minidiary.app)

## 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 this repository: `git clone REPO_URL`

2. Navigate into the project directory: `cd mini-diary`

3. Install the dependencies: `yarn`

4. Run the app: `yarn start`

### Building the app

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

## Contributing

### Features and Bugs

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

### Adding missing translations

The list of all English strings can be found in [`en.ts`](./src/main/i18n/translations/en.ts). If there are translations missing for your language and you'd like to help with the translation, you can add the translated strings to your language's file in [`src/main/i18n/translations`](./src/main/i18n/translations) and submit a PR.

### Adding a new language

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`](./src/main/i18n/translations). Duplicate the [`en.ts`](./src/main/i18n/translations/en.ts) file as `[LANG].ts`, where `[LANG]` is the [shortcode of your language](https://electronjs.org/docs/api/locales).

2. In the file you just created, replace the English translations with your own.

3. Import your file in the `ALL_TRANSLATIONS` object in [`src/main/i18n/i18n.ts`](./src/main/i18n/i18n.ts).

4. Add your language shortcode to the `electronLanguages` array in [`package.json`](./package.json).

5. Run the app in your language (see the steps [above](#development)) and make sure that the translations fit into the app (e.g. that they aren't too long for input fields).

6. Submit a PR. Thanks for your help!