toyohal24/jsnote repository overview

⁠jsnote

GitHub repository⁠

⁠Overview

javascript is what a wonderful language!!
I believe we can change the world by javascript.
i'm lovin' it

⁠Dsescription

jsnote will present you easy and fast coding place.
You can code javascript briefly and display the draw space freely.
jsnote is simple javascript editor running on web browsers.

⁠Demo

Go to jsnote⁠

⁠Usage

⁠FUNCTION BUTTON

• "run"
  runs your code written in the editor and record the code to local storage of WEB browser.

• "read"
  read a text file form your local file system to paste contents to the editor.

• "save"
  save a text file as "jsnote.txt" to your local file system.
  the default directory is "Downloads".

• "import"
  imports one or more text files to assing the name and the contents of file to array of "importTexts".
  Ex.
  importTexts[i].filename : filename
  importTexts[i].barefilename : filename without extention
  importTexts[i].ext : extention of file
  importTexts[i].text : contents of file

• "export"
  exports the value of "exportText" assigned string data as a text file.
  Assign string data to "exportText" before clicking the buttion of export.
  Ex.
  exportText = "welcome to jsnote" //before clicking the button of export

• "sample"
  suggests you a lot of sample codes

• "register"
  pushes your sample code to "sample".
  Enter categoroy and filename before pushing the button of register. This buttion is available only with running of AP server.

⁠SHORTCUT KEY

• "Shift + Enter"
  is equal to click the button of "run" to run your code written in the editor.

• "Shift + Tab"
  is equal to check draw box on or off to show or hide draw area.
  The DOM ID of draw area is "drawArea". It includs DOM of "draw".

• "Shift + Delete"
  clears all words in the editor.

⁠SAMPLE CODES

put your sample codes under the sample directory and add a property to list.json
you can register your smaple code by clicking the button of register

public
|-- index.html
|-- scripts
|-- styles
|-- sample
  |-- public
  |  |--list.json
  |  |--JavaScript
  |  |  |-- READ_ME.js
  |  |  |-- HelloWorldExample.js
  |  |--plotly
  |  |   |-- HelloWorldExample.js
  |  |--svg
  |  |  |-- HelloWorldExample.js
  |--private
     |--sample.json
     |-- ReadMe.md
     |-- your private sample category 
  .
  .
  .

⁠INSTALL

⁠Method 1 : pull from Docker Hub (WEB server & AP server)

pull image from Docker Hub and built with docker-compose

step1: make the direcotry as "jsnote" and move to it

mkdir jsnote
cd jsnote

• step2: make docker-.compose.yaml

version: '2'
services:  
    api:
        image: toyohal24/jsnote_api
        restart: always
        volumes 
            - ./sample:/usr/share/nginx/html/sample/private
            - ./log:/var/log/node
    web:  
        image: toyohal24/jsnote
        restart: always
        ports:
            - "2555:80"
        volumes 
            - ./sample:/usr/share/nginx/html/sample/private
            - ./log:/var/log/nginx

• step3: build with docker-compose

docker-compose up -d

⁠Method 2 : git clone from GitHub (WEB server & AP server)

git clone https://github.com/Toyoharu-Nishikawa/jsnote.git
cd jsnote
docker-compose up -d

⁠Method 3 : run behind a reverse proxy or load balancer (WEB server & AP server)

The initial setting of 'networks' is neco_link.
Change setting of 'networks' depending on your network configuration.

git clone -b necosystem https://github.com/Toyoharu-Nishikawa/jsnote.git
cd jsnote
docker-compose up -d

⁠Lisence

MIT