Code Monkey home page Code Monkey logo

mininote's Introduction

MiniNote

Say thanks

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

Buy me a coffee

Requirements

  • NodeJS >= 6.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

License

MIT @ Ferdinand Mütsch

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.