GithubHelp home page GithubHelp logo

rongzhiy / rethink Goto Github PK

View Code? Open in Web Editor NEW

This project forked from morvanzhou/rethink

0.0 0.0 0.0 29.03 MB

A new way to Rethink your notes. A note/thought taking app

Home Page: https://rethink.run

License: GNU General Public License v3.0

Shell 0.22% Python 76.07% CSS 22.69% HTML 0.98% Dockerfile 0.04%

rethink's Introduction

Rethink

Unittest License Package version Supported Python versions

English | 简体中文

Rethink is a new understanding of self-developing.

Every time a new thought is recorded, the relevant old thought will automatically emerge, cross-connect, and continuously analogize and upgrade cognition.

The official web version can be found at https://rethink.run.

demo

Let ideas find you rather than you find them

Let people who love to record with no useless thought. Even with a continuous stream of input, you don't need to worry about finding it.

We introduce a recommendation mechanism that allows old records to come back while recording a new thought. Making the new thought more connectable and memorable.

Features

  1. Bi-directional links: To @ link in the note with one click;
  2. Markdown syntax: Seamless support for Markdown syntax;
  3. Automatic association: Automatically recommend related notes while writing, actively assist you in forming a knowledge network.
  4. Local storage: Rethink attaches great importance to data security. You can store data in a local storage. Or the online version https://rethink.run, which makes it easy to synchronize across multiple platforms.
  5. Multi-language: Support multiple languages, including Chinese and English.

Deploy methods:

Deploy with Docker

Pull the image:

docker pull morvanzhou/rethink

Run the container:

For keeping your data safe, you should mount a local path to the container.

docker run \
  -p 8080:8080 \
  -v /your/data/path:/.data \
  morvanzhou/rethink

Then you can visit http://127.0.0.1:8080 in your browser.

If you want to define another host's port, you have to also add an environment variable API_URL, and make sure the port is the same as the host's port (8001 in this example):

docker run \
  -e API_URL=http://127.0.0.1:8001 \
  -p 8001:8080 \
  -v /your/data/path:/.data \
  morvanzhou/rethink

If you want to set a password for authorization, just add a environment variable APP_PASSWORD:

docker run \
 -e APP_PASSWORD=12345678 \
 -p 8080:8080 \
 -v /your/data/path:/.data \
 morvanzhou/rethink

All environment variables:

  • API_URL: the API url in app js code, default is http://127.0.0.1:8080
  • APP_PASSWORD: authorization password, default is None
  • APP_LANGUAGE: language, default is English, optional: zh, en

Deploy with Python

Install via pip

The second way to use Rethink is to install it via pip.

First install:

pip install retk

To update:

pip install -U retk

Config via Python

Quickly start the note web service with retk.run(), and save your note data locally, The default save path is the .data folder under the path of this script:

import retk

retk.run()

If you need to customize settings, you can set the parameters in retk.run():

import retk

retk.run(
   path='.',  # path to store notes, default is current directory
   host="127.0.0.1",  # host ip, default is localhost
   port=8080,  # port number, default is 8080
   language="zh",  # language, default is English, optional: zh, en
   password="12345678",  # authorization password, default is None
   headless=False,  # set True to not auto open browser, default is False
   debug=False,  # set True to print debug info, default is False
)

All notes will be stored in the path specified by path, and the .data folder will be created in your path directory.

English and Chinese languages are supported, and the default is English en. If you want to use Chinese zh, you can use language="zh" parameter.

Open your browser and visit http://127.0.0.1:8080 to start recording your ideas.

Star History

Star History Chart

rethink's People

Contributors

morvanzhou 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.