Memoma

A simple memo app.

What's about?

A memo-app that can write markdown, and this app is made by electron.

Demo

Installation

Please download zip file from here.
After unzip it, please execute Memoma.exe.

How To

Create new project or open a project.
Edit file.
Save the project.

Create New Project

Select File->Create New Project or Ctrl + n.
Select the directory which you want to create new project.
Input a project name.
Click save button.

Open Project

Select File->Open Project or Ctrl + o.
Select a project file (.mmm file) and open it.

Edit File

Move to next tab: Ctrl + Tab
Move to prev tab: Ctrl + Shift + Tab
Toggle Preview/Edit: Ctrl + p

Save the Project

Select File->Save Project or Ctrl + s.

For Developers

Introduction

# copy to local
$ git clone https://github.com/narugit/Memoma.git

# package install
$ npm install # npm i

Dev

$ npm run dev

Build

compile

This sources is made by typescript, so you have to compile the files.

We use gts to compile them and you can use this.

$ npm run compile

And then, you must move the compiled files to src/, because the files create in build/.

Below command is a shell script that can move to src/ automatically.

$ npm run movejs
# or you can use this one
$ ./jt.sh

deploy

# For Windows
$ npm run build:win

# For Mac
$ npm run build:win

code lint

$ npm run check [:your_target_file] # you can select the file to check statements.

Documentation

Here is the documentation by generating TypeDoc.

Directory

/
├ docs                      # documentation
│   └ requirement           # system requirement document
├ src                       
│   ├ app
│   │   └ modules           # core modules
│   ├ public
│   │   └ modules           # front modules
│   ├ index.html
│   ├ main.ts
│   └ style.css
├ build-mac.js              # build config for Mac
├ build-win.js              # build config for Windows
├ jt.sh                     # automation scripts
└ README.md

Contributors

License

MIT