Skip to content

Commit

Permalink
Updated the README
Browse files Browse the repository at this point in the history
  • Loading branch information
cipherdragon committed Sep 24, 2021
1 parent 080a192 commit 3e1c385
Show file tree
Hide file tree
Showing 2 changed files with 61 additions and 41 deletions.
102 changes: 61 additions & 41 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,74 +1,94 @@
<!-- @format -->

## Notice
<div align="center">
<h1>Zombie Diary</h1>
<img src="showcase/screenshot-1.jpg" style="max-width: 820px">
<br>
</div>

This project is a fork of samuelmeuli's mini-diary project which is no longer maintained by
its developers. I have no connection with the original developers. I'm just a fan of the mini-diary
project who thought it would be nice if I could keep on maintaining the project.
<br>

[original project](https://github.com/samuelmeuli/mini-diary) \
[original website by samuelmeuli → minidiary.app](https://minidiary.app)
**Zombie Diary is a simple, secure and attractive journal app. Writing a journal is fun and
enjoyable with Zombie Diary. Share your life stories with Zombie Diary. No matter how sensitive, emotional or private they are, Zombie Diary will keep them as a secrete. More importantly, Zombie
Diary is completely open source, no secrete in the code. No hidden backdoors, telemetry or spyware. Zombie Diary is the most trustworthy friend you will ever find.**

Original project is now dead but this project exist. What you call a dead man who exist in real
world? Maybe, Zombie, hence the name zombie-diary.
### Features

### How am I planning maintain this?
+ Free and Open Source
+ Light and Dark themes
+ Text Formatting
+ Full Text Search
+ Statistics

There are some outdated dependencies this project relying on. Also, some parts of code related
to cryptography are now depreciated. I'm planning to eliminate the outdated dependencies. I'll
remove encryption from the app or make it non-default as I don't have enough experience to work
with cryptography. It's better to completely remove encryption than putting users in risk by
implementing encryption improperly. Then I'm planning to go through samuelmeuli's repo's issues
and fix them.
### Background story

---
Samuel Meuli, a skillful software developer created a great journal app called Mini Diary. His Mini
Diary software had many users and good contributors. I was also a big fan of that app. I used it and
I loved it. Unfortunately, Mini Diary author, Samuel Meuli stopped further development of the
project and marked the project as archived.

<div align="center">
<img src="website/img/app-icon.png" height="120">
<h1>Zombie Diary</h1>
<strong>Simple and secure journal app</strong>
<img src="website/img/screenshot-1.png" width="100%" alt="Screenshot">
</div>
I was not ready to give up using Mini Diary. I don't want to let Mini Diary die. So I forked the
Mini Diary project and that's the birth of Zombie Diary. The beautiful, attractive interface you see
is from the Mini Diary author, Samuel Meuli. My target is to maintain this project as closely as
possible to the Mini Diary project.

**I don't have any connection with Mini Diary developers. I'm just a fan of Mini Diary project.**

So now you know how Zombie Diary project was made, but why I name the project as Zombie Diary? Well,
project Mini Diary is dead but this project, Zombie diary is not. Zombie Diary is live. What do you
call a man who exist in real world but also dead? Zombie?

[Mini Diary Project](https://github.com/samuelmeuli/mini-diary) \
[Mini Diary website by samuelmeuli → 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.
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`
2. Navigate into the project directory: `cd zombie-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.
After cloning the repo and installing the dependencies, run `yarn dist`. The packaged app can be found in the `dist` folder.

## Contributing

This project is just forked from samuelmeuli's repository. I'm not yet ready to accept contributions. I mean, you can
contribute but I cannot guarentee I'll accept it yet. Just give me some time to make the project go.

### Features and Bugs

> Suggestions and contributions are always welcome! Please first discuss changes via issue before submitting a pull request.
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.
I just forked the project. I'm not yet ready to accept language translations. I'll unquote about text when project is ready.
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:
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).
1. In the file you just created, replace the English translations with your own.
1. Import your file in the `ALL_TRANSLATIONS` object in [`src/main/i18n/i18n.ts`](./src/main/i18n/i18n.ts).
1. Add your language shortcode to the `electronLanguages` array in [`package.json`](./package.json).
1. 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).
1. Submit a PR. Thanks for your help!

## Very Important

If you love this project, then you should be thankful to the Mini Diary project author and other
contributors. Without them, You won't be able to use Zombie-Diary.

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!
[Samuel Meuli's Github Account](https://github.com/samuelmeuli)
Binary file added showcase/screenshot-1.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 3e1c385

Please sign in to comment.