Code Monkey home page Code Monkey logo

memos's Introduction

✍️ Memos

An open source, self-hosted knowledge base that works with a SQLite db file.

GitHub stars Docker pull Go report

Live DemoDiscuss in Telegram 👾

demo

Features

  • 🦄 Fully open source;
  • 📜 Writing in plain textarea without any burden,
    • and support some useful markdown syntax 💪.
  • 🌄 Share the memo in a pretty image or personal page like Twitter;
  • 🚀 Fast self-hosting with Docker;
  • 🤠 Pleasant UI and UX;

Deploy with Docker

docker run -d --name memos -p 5230:5230 -v ~/.memos/:/var/opt/memos neosmemo/memos:latest

Memos should be running at http://localhost:5230. If the ~/.memos/ does not have a memos_prod.db file, then memos will auto generate it.

Development

Memos is built with a curated tech stack. It is optimized for developer experience and is very easy to start working on the code:

  1. It has no external dependency.
  2. It requires zero config.
  3. 1 command to start backend and 1 command to start frontend, both with live reload support.

Tech Stack

tech stack

Prerequisites

Steps

  1. pull source code

    git clone https://github.com/usememos/memos
  2. start backend using air(with live reload)

    air -c scripts/.air.toml
  3. start frontend dev server

    cd web && yarn && yarn dev

Memos should now be running at http://localhost:3000 and change either frontend or backend code would trigger live reload.

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated. 🥰

Star history

Star History Chart

memos's People

Contributors

boojack avatar lqwakeup avatar hyoban avatar rebron1900 avatar limdingwen avatar whoistiger avatar westxu avatar leopold7 avatar

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.