# ccs-note

**Repository Path**: Yogurt_cry/ccs-note

## Basic Information

- **Project Name**: ccs-note
- **Description**: 创云笔记项目。一个属于自己的云笔记服务。v2.0.0 版完成
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 3
- **Forks**: 3
- **Created**: 2021-12-15
- **Last Updated**: 2024-08-05

## Categories & Tags

**Categories**: Uncategorized

**Tags**: 私有云笔记

## README

# ccs-note

![](https://img.shields.io/badge/Ubuntu-18.04.6%20LTS_64%E4%BD%8D-blue) ![](https://img.shields.io/badge/Docker-20.10.12-blue) ![](https://img.shields.io/badge/Go-1.17.5-blue) ![](https://img.shields.io/badge/vue-20.10.12-blue) ![](https://img.shields.io/badge/mongoDB-5-blue)

> 本项目预览版传送门：[http://note.yogurtcry.icu:8004/#/Login](http://note.yogurtcry.icu:8004/#/Login)

### 1 介绍

![4e9c60c4a80e3f76e619a2232f01304f.png](https://note.yogurtcry.icu:8011/Static/Upload/Note/202112/4e9c60c4a80e3f76e619a2232f01304f.png)

![111b8ba0be5dc41bcbb5764f343cb97d.png](https://note.yogurtcry.icu:8011/Static/Upload/Note/202112/111b8ba0be5dc41bcbb5764f343cb97d.png)

#### 1.1 立项原因

个人的笔记需求越来越多，虽然市面上有很多的笔记服务，但多多少少有这或那不能让自己满意的地方。

- 😳 要么收费
- 😔 要么空间少
- 🙃 要么创建笔记需要操作的流程比较多
- 😟 要么需要分屏写 markdown
- 🥱 要么功能少

等等，因此就想着是不是能够有一个个人的笔记服务器呢？随后找到了 `Leanote` —— 蚂蚁笔记，这个项目很强大，全平台支持，功能丰富。但开源版不支持流程图、脑图等，用起来还是有点不方便，以及那个设计界面个人也不是很喜欢。就想着要不自己开发一个只有笔记功能的工具，而且还要满足多平台和云存储的基本需求。

经过了一段时间的考察，遇到了各种各样优秀的开源 Markdown 组件，例如 `md-editor-v3`、`v-md-editor` 等等，最后找到了本项目的核心 Markdown 组件 `Vditor`。最后简单集成测试了一下，感觉还不错，因此就有了本次的项目。

#### 1.2 解决问题

* **精简功能，让笔记回归本质。让自己专注笔记本身**。通过对常用云笔记软件的试用，如 `印象笔记`、`语雀`、`有道云笔记`、`Leanote`、`CSDN` 等等，针对自己最常用的功能进行了筛选，砍掉了绝大部分在个人笔记场景中用的比例极低甚至根本用不上的功能。例如：分享笔记、建立博客、签到、广告、文件夹管理、更换主题、视频、录音、会员等等 ~~（也不完全用不上，更主要的是能力实在有限，😥）~~。仅安排了 `账号登录`、`账号注销`、`修改密码`、`笔记的增删改查`、`笔记全文搜索`、`笔记标签管理`、`自动保存`、`断网缓存` 等这点功能。
* **私有化部署**。其实最想做的就是这件事情了。云笔记有它的优势——大公司，大投入，稳定性好，技术支持、生态好（比如笔记分享什么的，很好的功能）等等，但由于免费提供 ~~（主要是我想白嫖，😛）~~，避免不了的就是可能会有广告、可能会加上各种各样用来变现的功能，可能整个软件逐步逐步就脱离了笔记的本身 ~~（这也是没办法，厂商要存活，员工要吃饭，服务器还要电，还要担着数据泄露和丢失风险。如果是我，也只能这么选择🥺）~~。因此要想一款笔记工具符合自己的想法，就只能自己开发，自己承担风险。创云笔记是一个建议私有化部署的项目，由于项目和功能极其简单（看源码就知道），出问题的概率也不大，基本上不需要什么维护。
* **支持的 Markdown 功能多**。这不是 Yogurt 带来的，而是 Vditor 带来的，他们团队创造了这一切，Yogurt 只是搬运过来 ~~（基于 MIT 协议）~~ 包装了一下。

#### 1.3 运用技术

~~本项目中最有技术含量的就是 Vditor 了，还不是我开发的 🙈，尴尬。~~

整个项目后端部分由 `Golang` 实现，前端部分使用 `Vue3`+`Vditor`（Markdown 编辑器）+`vue3-contextmenu`（右键菜单） 来实现，所有的笔记数据存储在 `MongoDB` 中。以 Docker 容器为载体运行在云服务器中。

### 2 开发环境


| 信息             | 说明                                            |
| ------------------ | ------------------------------------------------- |
| 服务器系统版本   | Ubuntu 18.04.6 LTS (64位)                       |
| 开发环境系统版本 | Microsoft Windows 10 专业工作站 10.0.19042 64位 |
| Go 版本          | 1.17.5                                          |
| Vue 版本         | 3.x                                             |
| MongoDB 版本     | 5.x                                             |
| Docker 版本      | 20.10.12                                        |
| 服务器配置       | 天翼云 4 核 8G 4M带宽                           |

### 3 支持

理论上在任何一台装了 MongoDB 的电脑中都可以运行。由于开发的时候考虑的是如何用 Docker 容器在云服务器中运行，后期可能会考虑是否需要将本地部署也做一下响应的适配

### 4 如何部署

详情请见 wiki 文档。传送门：[https://gitee.com/Yogurt_cry/ccs-note/wikis/部署文档](https://gitee.com/Yogurt_cry/ccs-note/wikis/%E9%83%A8%E7%BD%B2%E6%96%87%E6%A1%A3)

### 5 更多信息

其他更多信息详见项目注释（项目真的很简单）