syfxlin / xknote

:ledger: XK-Note | 一个集各种神奇功能的云笔记

XK-Note

一个集各种神奇功能的云笔记

目录 Contents

• XK-Note
  • 目录 Contents
  • 简介 Introduction
  • 特性 Feature
  • 演示 Demo
  • 安装 Install
    • 一键安装
    • 升级
    • 手动安装
  • 文档 Doc
  • 维护者 Maintainer
  • 许可证 License
  • 渲染 Render

简介 Introduction

XK-Note = Laravel . Vue2.0 . XK-Editor; 一个由上方代码组成，集各种神奇功能的云笔记。

特性 Feature

• [云存储] 云端撰写笔记，随时保存，多端同步。
• [跨平台] 多平台支持，撰写查阅只需一个浏览器，无惧任何不兼容情况。
• [响应式] 所有页面均采用响应式设计，即使尺寸极小的设备也能保持良好的体验。
• [在线浏览] 拥有独立的浏览模式，查看笔记不再困扰。
• [历史版本] 笔记支持历史版本查看和回滚，您可以切换到任何提交过的历史版本，无惧误删除。(基于 Git)
• [Git 同步支持] 独有的 Git 支持，支持版本控制，无惧误操作，随时从旧版本恢复笔记。
• [浏览器临时保存] 独有的浏览器端保存功能，即使断网了也能安心写作，无惧任何网络波动。
• [发布到博客] 笔记可以在编辑完成后一键推送到 WordPress，Hexo 等博客系统。
• [多笔记同时打开] 笔记可以随时打开，您无需在编辑其他笔记时关闭之前开启的笔记。
• [多用户] 笔记主要面向个人使用，但是也支持多人同时使用，每个用户的笔记互相隔离保存，无需担心笔记泄露。
• [导出笔记] 支持多种导出格式，保存为 MD 文件，html 文件，由本地即时生成，无需繁琐的操作。
• [多种模式] 拥有多种模式，写作，预览，阅读，满足各种人的需求。
• 还有多种神奇的功能等待你的发掘。

演示 Demo

XK-Note

账号： [email protected] / demo

密码： demodemo

安装 Install

目前 XK-Note v2 还处于测试阶段，所以可能存在 Bug，若您在使用中遇到了 Bug 或者疑似 Bug 的情况，请提交 issue 或与我取得联系，以便第一时间取得修复。

一键安装

1. 安装依赖

# Ubuntu/Debian 其他系统请自行查阅
# 鉴于不同用户安装PHP的方法不同，这里就不写PHP的安装方法了
sudo apt-get install curl git
curl -sS https://getcomposer.org/installer | php
sudo mv composer.phar /usr/local/bin/composer
# 安装NodeJS和yarn/npm
sudo apt install npm
sudo npm i -g npm
sudo npm i -g yarn
sudo npm i -g n
sudo n stable

2. 克隆本仓库

git clone https://github.com/syfxlin/xknote.git

1. 复制一份.env.example文件，并重命名为.env，修改对应的信息，并关闭调试模式

APP_DEBUG=false
APP_ENV=production
APP_ADMIN_ID=1 #一般来说第一位注册的用户自动升级为管理员，也就是id为1的用户，如果发现不是可以修改这个参数，改成你的id
APP_URL=you url
DB_CONNECTION=mysql
DB_HOST=127.0.0.1
DB_PORT=3306
DB_DATABASE=xknote
DB_USERNAME=you mysql username
DB_PASSWORD=you mysql password
MAIL_DRIVER=smtp
MAIL_HOST=smtp.example.com
MAIL_PORT=465
MAIL_USERNAME=you mail username
MAIL_PASSWORD=you main password
MAIL_ENCRYPTION=ssl
[email protected]
MAIL_FROM_NAME=XK-Note

4. 安装

composer xknote-install

升级

若您是使用手动安装的话请先确认git是否存在xknote-github的remote，如果没有，请添加后运行下方命令

composer xknote-update

手动安装

1. 安装依赖

# Ubuntu/Debian 其他系统请自行查阅
# 鉴于不同用户安装PHP的方法不同，这里就不写PHP的安装方法了
sudo apt-get install curl git
curl -sS https://getcomposer.org/installer | php
sudo mv composer.phar /usr/local/bin/composer
# 安装NodeJS和yarn/npm
sudo apt install npm
sudo npm i -g npm
sudo npm i -g yarn
sudo npm i -g n
sudo n stable

2. 克隆本仓库

git clone https://github.com/syfxlin/xknote.git

3. 安装模块

composer install
yarn

4. 复制一份.env.example文件，并重命名为.env，修改对应的信息，并关闭调试模式，同时运行以下命令生成 app key

APP_DEBUG=false
APP_ENV=production
APP_ADMIN_ID=1 #一般来说第一位注册的用户自动升级为管理员，也就是id为1的用户，如果发现不是可以修改这个参数，改成你的id
APP_URL=you url
DB_CONNECTION=mysql
DB_HOST=127.0.0.1
DB_PORT=3306
DB_DATABASE=xknote
DB_USERNAME=you mysql username
DB_PASSWORD=you mysql password
MAIL_DRIVER=smtp
MAIL_HOST=smtp.example.com
MAIL_PORT=465
MAIL_USERNAME=you mail username
MAIL_PASSWORD=you main password
MAIL_ENCRYPTION=ssl
[email protected]
MAIL_FROM_NAME=XK-Note

php artisan key:generate

5. 进入网站根目录，并执行以下命令

php artisan storage:link
php artisan migrate
php artisan db:seed

6. 编译 Vue

yarn prod

7. 修改网站的运行目录到public
8. 打开网站，注册一个账户，并确认账户id是否为1，若不是则需要修改.env文件
9. enjoy

文档 Doc

暂无

维护者 Maintainer

XK-Note 由 Otstar Lin和下列贡献者的帮助下撰写和维护。

Otstar Lin - Personal Website · Blog · Github

许可证 License

根据 Apache License 2.0 许可证开源。

渲染 Render

xknote's Issues

项目重制计划

由于XK-Editor的完成，XK-Note项目将会换掉Editor.md，进而使用XK-Editor编辑器，由于XK-Editor是使用Vue开发的所以就无法再使用后端渲染了，于是便打算将本项目重制，但会保留目前的分支，同时若发现Bug依旧会及时修复，但是不会再进行功能性的更新，请谅解。

由于已经用过了Vue和Laravel，v2版的XK-Note将会在不久后与大家见面:smile:，v2版本将会保留v1版本所有的功能，并会优化一些小问题，敬请期待:tada:。

若您熟悉Vue或者Laravel并且有意向协助我开发本项目的话，欢迎联系我或在此 issue 下留言。

是否支持windows server

该项目是否可以在windows server上面搭建并运行，如果可以需要哪些运行环境。