MiniNote

A simple, self-hosted Markdown note-taking app built with VueJS, and Express.

Requirements

• NodeJS >= 10.13.x

How to run?

1. git clone https://github.com/n1try/mininote
2. In root directory: npm install
3. And again in mininote-frontend directory: npm install
4. Adapt config.js to your needs (e.g. set web server port)
5. In mininote-frontend directory: npm run build
6. In root directory: npm start

How to run with Docker?

1. git clone https://github.com/n1try/mininote
2. docker build -t mininote .
3. 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.

Use HTTPS for backend

1. Open config.js
2. Edit the HTTPS_KEY and HTTPS_CERT field, and insert the file locations at which your private key and site certifications are stored.
3. Launch the backend server --> To switch back to the HTTP server, nullify either field and relaunch again.

Todo

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

Contributing

Feel free to contribute! All contributions that add value to the project are welcome. However, please be aware that you are not done after having opened a PR. In order to keep quality high, it is expected that you implement change requests and react to comments within an adequate time, until your code is merged. Otherwise your PRs will be closed after a while, sorry!

License

MIT @ Ferdinand Mütsch