mirror of https://github.com/QingWei-Li/notea.git synced 2024-12-04 20:32:36 +03:00

📒 Self hosted note taking app stored on S3

docker markdown minio note-taking s3 starred-qingwei-li-repo starred-repo

Go to file

liqingwei a6cc9f1090 fix: middlewares		2021-03-20 08:41:10 +08:00
.github	feat: add pull app	2021-03-09 23:22:54 +08:00
.vscode	fix: get note missing id	2021-03-11 21:34:57 +08:00
assets	docs: add screenshots	2021-02-21 20:18:03 +08:00
components	fix: note api	2021-03-19 22:09:06 +08:00
libs	fix: middlewares	2021-03-20 08:41:10 +08:00
packages	fix: upload file	2021-03-12 23:11:45 +08:00
pages	fix: middlewares	2021-03-20 08:41:10 +08:00
static	feat: add icons	2021-03-09 21:46:50 +08:00
.babelrc	refactor: trash and search	2021-03-19 18:53:43 +08:00
.dockerignore	chore: add dockerfile	2021-02-22 22:40:13 +08:00
.env.sample	feat: page tree	2021-02-19 19:40:47 +08:00
.eslintignore	feat: init	2021-02-13 18:16:27 +08:00
.eslintrc.json	feat: 代码优化	2021-02-20 20:11:53 +08:00
.gitignore	feat: add pwa	2021-03-09 18:43:45 +08:00
.prettierignore	feat: init	2021-02-13 18:16:27 +08:00
.prettierrc	feat: init	2021-02-13 18:16:27 +08:00
docker-compose.yml	feat: init	2021-02-13 18:16:27 +08:00
Dockerfile	chore: add dockerfile	2021-03-09 21:11:09 +08:00
LICENSE	feat: init ui	2021-02-15 17:59:00 +08:00
next-env.d.ts	feat: init search ui	2021-03-03 21:27:14 +08:00
next.config.js	fix: upload file	2021-03-12 23:11:45 +08:00
package.json	refactor: trash and search	2021-03-19 18:53:43 +08:00
postcss.config.js	feat: init ui	2021-02-15 17:59:00 +08:00
README.md	feat: add pull app	2021-03-09 23:22:54 +08:00
tailwind.config.js	feat: trash	2021-03-08 20:07:50 +08:00
tsconfig.json	feat: store notes	2021-03-02 14:08:34 +08:00
vercel.json	fix: editor title	2021-02-23 22:00:08 +08:00
yarn.lock	refactor: trash and search	2021-03-19 18:53:43 +08:00

README.md

Notea [WIP]

Self hosted note taking app stored on Amazon S3 or like.

Fork and install Pull app to automatically update your repo.

Features

One-click deploy to Vercel/Netlify or deploy to host with Docker
Support storage in Amazon S3, Minio, Aliyun OSS, etc
Notion like markdown editor

Demo

Link: https://notea.vercel.app
Password: notea

Data is stored in https://play.minio.io:9000/notea/

Quickstart

Choose Storage
Deploy App
Visit your website

Deploy

Vercel(Recommanded)

Netlify

Docker

Storage

Configure environment variables according to storage mode.

Minio

.env

STORE_TYPE=MINIO
STORE_ACCESS_KEY=
STORE_SECRET_KEY=
STORE_BUCKET=notea
STORE_END_POINT=

Amazon S3

.env

STORE_TYPE=AWS
STORE_ACCESS_KEY=
STORE_SECRET_KEY=
STORE_BUCKET=notea
STORE_REGION=us-east-1

Aliyun OSS

.env

STORE_TYPE=OSS
STORE_ACCESS_KEY=
STORE_SECRET_KEY=
STORE_BUCKET=notea
STORE_END_POINT=oss-cn-hangzhou.aliyuncs.com

Environment variables

Name	Description	Default	Optional	Required
PASSWORD	password to login to the app			true
STORE_TYPE	storage method		`MINIO`, `OSS`, `AWS`	true
STORE_ACCESS_KEY	accessKey			true
STORE_SECRET_KEY	secretKey			true
STORE_BUCKET	bucket			true
STORE_END_POINT	host name or an IP address.
STORE_REGION	region	us-east-1

Development

cp .env.sample .env
docker-compose up -d
yarn dev

LICENSE

MIT