Skip to content

A simple electron markdown editor made with Uikit, Codemirror and markdown-it. Support for MathJax, code highlighting, live preview, and more.

License

Notifications You must be signed in to change notification settings

OXTimoA/electron-md-editor

Repository files navigation

Electron md editor

A markdown document editor

Install

Create an env file from the example

cp .env.example .env

Start the server

docker-composer up -d

Start electron application

electron .

requires electron installed globally with npm i -g electron

Envs

Going to try to stick to prefixing with server and electron to specify which part the env is for.

ENV for conditions within both server and electron that might need differences between environments

ENV=development


Nginx host name

NGINX_HOST=test.local

Keymetrics account credentials [optional]

This is more for deployment and server monitoring etc

KEYMETRICS_PUBLIC=
KEYMETRICS_SECRET=

See Keymetrics for more.

PM2 server configurations and express hosting port

SERVER_EXPRESS_PORT=3000
SERVER_INSTANCES=1
SERVER_WATCH=true

Instances is used to managed your cluster processes http://pm2.keymetrics.io/docs/usage/cluster-mode/

Secret used for JWT authentication

#JWT secret
SERVER_JWT_SECRET=thisissoooosecret

Mongo DB host and port

SERVER_MONGO_HOST=db
SERVER_MONGO_PORT=27017

GraphQL pretty print

#GraphQL pretty
SERVER_PRETTY_QL=true

Auth0 credentials

#Auth0 Credentials
SERVER_AUTH0_DOMAIN=
SERVER_AUTH0_CLIENTID=
SERVER_AUTH0_SECRET=

Helpful aliases and commands

Accessing the pm2 docker (there's no bash here)

alias dn="docker exec -it $(docker ps -f 'name='node-cli'' -q) "

You can use the above to access pm2 commands like so dn pm2 logs

About

A simple electron markdown editor made with Uikit, Codemirror and markdown-it. Support for MathJax, code highlighting, live preview, and more.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •