Giter Club home page Giter Club logo

notelix

logo

An open source web note taking / highlighter software (with backend).

demo demo2

Notelix features:

  • Powerful and reliable web highlighting (powered by MIT-licensed @notelix/web-marker)
  • Adding notes to highlights
  • A search engine for your highlights and notes (powered by MeiliSearch)
  • An app to manage your highlights and notes in one place
  • Optional client-side encryption (and an optional agent that runs on user's machine if they have client-side encryption enabled and want features such as the search engine)
  • Use as a chrome plugin (download a zip and install it to try), or use it as a service and integrate it into your website / project without requiring users to install a plugin (try it)
  • Works well with darkreader
  • More features coming soon...

building and running chrome extension

cd chrome-extension
./build-extension.sh

Then Load unpacked from chrome://extensions/

building and running backend

cd ./server
echo "DB_PASSWORD=$(echo $RANDOM$RANDOM$RANDOM | md5sum | head -c 32)" > .env.dev
docker network create notelix

# start server in dev mode

docker build . -f ./Dockerfile.dev -t notelix:dev
docker-compose -f docker-compose.dev.yml --env-file .env.dev -p notelix-dev up -d 

Architecture

Running notelix agent (only necessary when client-side encryption is enabled)

cd server
echo "DB_PASSWORD=123456" > .env.agent
docker network create notelix
docker build . -f ./Dockerfile.agent -t notelix:agent
docker-compose -f docker-compose.agent.yml --env-file .env.agent -p notelix-agent up -d

Wait a bit, refresh a tab in Chrome, then wait a bit for data to sync.

After successful data sync, you will be able to use advanced features such as searching, with client-side encryption enabled.

Public DEV server

https://public-dev.notelix.com/

Note: this server is free-to-use, but doesn't provide any guarantee regarding availability or data safety.

In fact, this database will be reset when there is major Notelix API change. (expected every year).

Only use this dev server when you are trying out Notelix.

For production use, please host your own server (see building and running backend), and use cron + pg_dump or https://github.com/wal-g/wal-g to backup your database.

Using Notelix Embedded to add it to your website without requiring users to install a browser extension

Try here. See chrome-extension/embedded.html for the code.

A note about LICENSE: If you want to integrate Notelix into your project using the above method, it's okay not to disclose source code of your project. You only need to disclose source code for any changes made directly to Notelix.

Contact me if you have questions regarding LICENSE / for custom licensing.

notelix's Projects

notelix icon notelix

An open source web note taking / highlighter software - Please star if you like this project

web-marker icon web-marker

a web page highlighter - Please star if you like this project

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.