Skip to content

tsailawrence/NoteFlow

Repository files navigation

NoteFlow

Introduction

Noteflow 為⼀款提供⼼智圖筆記服務的網⾴平台,允許⽤⼾在筆記(Flow)中⾃由添加不同的節點(Node),並且可以在節點當中⾃由地編輯內容,例如增加⽂字、輸入 Latex 算式、插入 PDF ⽂件和插入 Youtube 影⽚等,⽽由這個空間被稱為筆記。這讓⽤⼾在製作筆記時能運⽤節點和邊來繪製整個內容的關係圖,提供使⽤者更多元的做筆記模式。

Noteflow 整合了市⾯上⼤多數筆記產品所提供的編輯元件,還增加了收藏(Library)和⽇曆(Calendar)的功能,讓使⽤者可以更輕易地管理所有筆記內容。除此之外 Noteflow 採⽤了響應式網⾴設計(Responsive Web Design),使其能⾃動適應不同裝置上的不同螢幕⼤⼩,讓使⽤者無論是何時何地都可以輕鬆地紀錄內容。

Complete Design Document

Complete Design Document

Configure Nginx in MacOS

因前後端溝通需要遵守同源政策,所以需要請老師遵照以下指示安裝 Nginx 並修改 configuration 檔。 以下指示為 Mac 系統的安裝方式。

## install nginx using brew, in Linux, try using apt-get install.
brew install nginx

## try default nginx to see whether it works.
nginx

## move our server config into nginx configuration directory.
mkdir /opt/homebrew/etc/nginx/servers
sudo mv ./template/noteflow.nginx.conf /opt/homebrew/etc/nginx/servers/noteflow.conf
## furthermore, you need to edit noteflow.conf where it is left unfilled.
## e.g. <cert_file> & <key_file>. you can fill the path of cert & key in frontend folder.

## make nginx test to see whether the new conf is valid
nginx -t

## if it is valid, kill original nginx and open new one.
lsof -i :8080
kill <pid>
nginx

啟動及關閉

用「docker compose --env-file .env.local up -d」啟動 docker 之後,瀏覽器輸入 localhost 即可使用 NoteFlow 網站。使用完畢通過「docker compose --env-file .env.local down」關閉 docker

docker compose --env-file .env.local up -d

docker compose --env-file .env.local down

其他說明

  1. 本地版本沒有 SSO,如果需要測試 SSO 請使用線上版本
  2. .env.local 以及 k8s_deployment 資料夾中的 k8s_env.sh 需要填上對應的值,這部分已在 email 中附給老師

線上版本

可以直接連「noteflow.live」使用線上版本

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published