aiguo159 / joplin-web

:snake: :books: Web application companion for Joplin

Joplin Web

A Web application companion for JoplinApp

why that project ?

Because it may happened we need to access to JoplinApp without having access to our smartphone or the Joplin Desktop, and a Web Application could to the trick at a given moment.

Requirements

• Python >= 3.6
• joplin-api
• starlette
• VueJS

Installation

export JW_BASE="${HOME}" # Set the directory where you would like to install
cd "${JW_BASE}"
python3 -m venv joplin-web
cd joplin-web
source bin/activate
git clone https://github.com/foxmask/joplin-web
cd joplin-web
pip install -r requirements.txt
cd joplin-vue
npm install

settings

copy env.sample to .env

then set at least this parm:

• the JOPLIN_WEBCLIPPER_TOKEN you have in the Webclipper config page in Joplin
• the JOPLIN_RESOURCES to find the files of joplin and being able to load them in the editori
• the JW_BASE_URL to set the base of the application eg set it to /joplin/ to move the URL from / to /joplin/

the config file is commented to be able to help you to fill the parameters, like HTTP_PORT, PAGINATOR or DEBUG

Running

to be able to manage the joplin notes from the web app, we need to start:

• if you are on your workstation just start "Joplin Desktop"
• if you are using joplin on a dedicated server, you can start "joplin headless", as follow

joplin --profile ~/.config/joplin-desktop/ server start
Server is already running on port 41184

joplin headless is available with the "joplin terminal" version (since build 147), you can install like that

NPM_CONFIG_PREFIX=~/.joplin-bin npm install -g joplin
sudo ln -s ~/.joplin-bin/bin/joplin /usr/bin/joplin

(have a look at https://joplinapp.org/ for more details)

for developement purpose

we start the front and the back in 2 dedicated process

• start the backend part of joplin-web app like this

export JW_BASE="${HOME}" # Must match value used at install time
cd "${JW_BASE}/joplin-web/joplin-web/joplin_web"
source "../../bin/activate"
python app.py &
Joplin Web - Starlette powered
Started server process [10043]
Waiting for application startup.
Uvicorn running on http://0.0.0.0:8001 (Press CTRL+C to quit)

• start the frontend

see joplin-web/joplin-vue/README.md file

for production purpose

• compile the vuejs project first,

cd joplin-vue
npm run build

• then start the application:

export JW_BASE="${HOME}" # Must match value used at install time
cd "${JW_BASE}/joplin-web/joplin-web/joplin_web"
source "../../bin/activate"
python app.py &
Joplin Web - Starlette powered
Started server process [11243]
Waiting for application startup.
Uvicorn running on http://0.0.0.0:8001 (Press CTRL+C to quit)

Joplin-web : Docker

if you prefer to run the project from docker :

see joplin-web/docker.md for details

System settings

see joplin-web/system.md for details