# note

**Repository Path**: rails-train-camp01/note

## Basic Information

- **Project Name**: note
- **Description**: 是一个基于 Ruby on Rails 框架构建的开源笔记、知识管理和 wiki 系统。 fork from Wreeto 
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2021-08-12
- **Last Updated**: 2022-06-09

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 小便条
## 简介

小便条 是一个基于 Ruby on Rails 框架构建的开源便条、知识管理和 wiki 系统。

最初，这是因为我不喜欢市面上的便条应用程序，我想要的是简单、有条理、直截了当的东西，没有花哨的花哨。

## 目录
1. [特性](#features)
2. [路线图](#roadmap)
3. [要求](#requirements)
4. [安装](#installation)
5. [使用](#usage) 
6. [你能帮上什么忙吗？](#how-can-you-help)
7. [截图](#screenshots) 
8. [许可证](#license) 
9. [专业版](#professional-edition)

## <a name="features"></a> 1. 特性 

- 简单、最少的用户界面-少就是多_
- 无限量便条，支持 Markdown 格式
- 分类
- 标签（**新！**）
- 项目（**新增！**）
- 附件（**新增！**）
- 加密备份
- 按类别或子类别列出便条
- 收藏夹便条显示在便条列表和侧边栏的顶部
- 认证、授权
- google oauth 集成
- 搜索
- 通过 __安全__ 链接公开共享便条
- 压缩并下载 Markdown 格式的便条
- 从外部压缩的纯文本文件导入便条
- 响应式移动 web 用户界面

## <a name="roadmap"></a> 2. 线路图 

- 测试一切，无处不在。更多的测试。
- 改善用户界面不一致性。
- 升级到Rails V6。
- 注释模板。
- 加密。
- 为用户提供不同级别的安全访问。
- 用户访问控制。
- 黑暗模式。
- 自动过期的快速便条。
- 将备注导出为PDF格式。
- 云备份。
- 版本跟踪。
- 将UI移动到ReactJS。
- 移动应用程序。
- 多得多..

## <a name="requirements"></a> 3. 要求

- Ruby 2.6.6
- PostgreSQL 11
- Redis 5.0.7

## <a name="installation"></a> 4. 安装

### 4.1 使用 docker

现在最简单的方式是使用`docker-compose`,并简单地执行：

```
docker-compose up
``` 

为了初始化数据库并加载默认帐户，你需要运行：

```
docker-compose run app bundle exec rake db:drop db:migrate db:setup
``` 

### 4.2 本地安装

你需要根据你的操作系统和环境设置Postgres、Ruby、redis以及它们的适当依赖项。

对于每个Rails项目：
- `bundle install`
- `bundle exec rake db:drop db:create db:migrate db:setup`
- `bundle exec rails s`

## <a name="usage"></a> 5. 使用

默认账户
### 5.1 默认账户 

默认凭证为：用户名`admin`和密码`password`。
### 5.2 创建新账号 (rails console)

你可以通过运行`bundle exec rails console`或`docker-compose run app bundle exec rails console`从Rails控制台创建另一个帐户，然后

```
account = Account.create!
User.create!({username: 'admin', email: 'user@email.com', password: 'password', confirmed_at: DateTime.now, account: account})
```
然后 `exit`。

### 5.3 Web UI

要使用默认设置(主机名/端口) 访问Web应用程序，请转到

```
http://localhost:3000
```

## <a name="screenshots"></a> 6. 截图

#### 登录
![Screenshot Running Command](/public/screenshots/scr_1.png?raw=true)

#### 便条库存
![Screenshot Running Command](/public/screenshots/scr_2.png?raw=true)

#### 私人便条视图
![Screenshot Running Command](/public/screenshots/scr_3.png?raw=true)

#### 公共便条视图
![Screenshot Running Command](/public/screenshots/scr_4.png?raw=true)

#### 分类
![Screenshot Running Command](/public/screenshots/scr_5.png?raw=true)

#### 创建便条
![Screenshot Running Command](/public/screenshots/scr_6.png?raw=true)

#### 分类列表
![Screenshot Running Command](/public/screenshots/scr_7.png?raw=true)

#### 维基视图
![Screenshot Running Command](/public/screenshots/scr_8.png?raw=true)

#### 搜索
![Screenshot Running Command](/public/screenshots/scr_9.png?raw=true)

## <a name="license"></a> 7. 许可证

社区版的AGPLv3许可证
## <a name="professional-edition"></a> 8. 专业版 


有专业版，这个版本有定价计划。

请查看 https://wreeto.com 了解更多详细信息(当前正在更新)。