A simple, self-hosted Markdown note-taking app built with VueJS, and Express.
- NodeJS >= 6.x
git clone https://github.com/n1try/mininote
- In root directory:
npm install
- And again in mininote-frontend directory:
npm install
- Adapt
config.js
to your needs (e.g. set web server port) - In mininote-frontend directory:
npm run build
- In root directory:
npm start
git clone https://github.com/n1try/mininote
docker build -t mininote .
docker run -d -p 3000:3000 -v /your-dir-of-choice:/app/data mininote
--> MiniNote will listen on port 3000 and persist data to/your-dir-of-choice
on your host system using a shared volume.
- Open
config.js
- Edit the
HTTPS_KEY
andHTTPS_CERT
field, and insert the file locations at which your private key and site certifications are stored. - Launch the backend server --> To switch back to the HTTP server, nullify either field and relaunch again.
This project is still under development. The following features are about to be implemented. Feel free to contribute.
- Tests
- Improved data validation
- More REST
- Ability to rename notebooks and notes
MIT @ Ferdinand Mütsch