# Docs

**Repository Path**: amtech/Docs

## Basic Information

- **Project Name**: Docs
- **Description**: Fresns 项目文档仓库，包含前后端原型、流程图、数据字典、API 研发 Wiki 等资料内容。
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2021-06-11
- **Last Updated**: 2021-06-11

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

![Fresns LOGO](images/Fresns%20Logo(small).png)

Fresns 是一款免费开源的社交网络服务软件，专为跨平台而打造的通用型社区产品，支持灵活多样的内容形态，可以满足多种运营场景，符合时代潮流，更开放且更易于二次开发。

## 许可协议

- Apache License, Version 2.0 [https://www.apache.org/licenses/LICENSE-2.0](https://www.apache.org/licenses/LICENSE-2.0)
    - 免费开源：免费并且开放源代码（Free and open source）和研发文档。
    - 自由使用：不限任何用途（Freedom to use）使用本产品，包括商业用途。

- CC BY-ND 4.0 [https://creativecommons.org/licenses/by-nd/4.0/deed.zh](https://creativecommons.org/licenses/by-nd/4.0/deed.zh)
    - 署名：必须给出适当的署名，比如展示「本站由 Fresns 提供支持」或者「Powered by Fresns」。你可以用任何合理的方式来署名，但是不得以任何方式暗示许可人为你或你的使用背书。
    - 禁止演绎：如果你再混合、转换、或者基于该产品创作，你不可以分发修改产品。你可以 Fork 本产品代码，未经许可**禁止**在本产品的整体或任何部分基础上以发展任何派生版本、修改版本或第三方版本用于重新分发。
    - 知识产权使用权：本产品的知识产权（商标、发明专利、计算机软件著作权）使用权永久免费授予 Fresns 用户，未经许可**禁止**在任何其他产品中使用。

简而言之：
* 对于使用者，只需署名就可以使用，包括商业项目使用；
* 对于开发者，只能通过 Pull Requests 方式参与开发，不能演绎其他版本；
* 对于竞争者，如果你开发出功能原理一样或者相似的产品，无论使用哪种编程语言，无论是私有化部署或者 SaaS 模式，都有可能构成专利侵权。

## 加入项目

如果你认可我们的开源软件，欢迎加入我们一起开发完善。你可以直接 Fork 本项目，然后 Pull Requests 到仓库，那怕是修改一个错别字也是对我们莫大的帮助。

- [点击了解产品 16 个功能特色](https://gitee.com/Fresns/Docs/blob/master/Features.md)
- 产品经理： [唐杰](https://tangjie.me/)
- 唐杰邮箱： jarvis.tang@foxmail.com
- 交流 QQ 群： 5980111

## 程序结构

- 前后端分离
- 动静态分离

## 运行环境

| 环境 | 服务 |
| --- | --- |
| Web 服务器 | Nginx 或 Apache 或 IIS |
| 程序语言 | PHP 7.3.0 或以上 |
| 数据库 | MySQL 8.0.0 或以上 |
| 数据库排序规则 | utf8mb4_0900_ai_ci |
| 数据库存储引擎 | InnoDB |

## 技术资源

| 技术栈 | 版本 | 用途 |
| --- | --- | --- |
| [Laravel](https://laravel.com/) | 8.5.18 | 主程序框架 |
| [Bootstrap](https://getbootstrap.com/) | 5.0.1 | 前端框架 |
| [Bootstrap Icons](https://icons.getbootstrap.com/) | 1.5.0 | 前端图标字体库 |

## 产品命名

| 名称 | 介绍 |
| --- | --- |
| 主程序 | 也叫“后端”，用于运行官方 API 和插件机制 |
| 控制台 | 后端管理中心，管理密钥和插件等功能 |
| 控制面板 | 管理主程序功能和用户内容的后台，分别有集成模式和独立部署模式 |
| 系统管理员 | 用于登录控制台的用户 |
| 运营管理员 | 用于登录插件管理后台的用户，由插件配置用户和权限 |
| 网站引擎 | 基于主程序 API 开发的网站功能，分别有集成引擎和独立引擎 |
| 网站引擎-集成引擎 | 以插件方式运行在主程序中的网站引擎 |
| 网站引擎-独立引擎 | 独立部署和运行在主程序之外的网站，类似于移动应用（App） |
| 主题模板 | 基于网站引擎开发的外观样式（UE&UI 界面） |
| 移动应用 | 手机 App 和微信小程序等独立运行的移动端应用程序 |

## 需求文档

| 内容 | 链接 |
| --- | --- |
| 数据字典 | [wikis/pages?sort_id=3908763&doc_id=1362860](https://gitee.com/Fresns/Docs/wikis/pages?sort_id=3908763&doc_id=1362860) |
| 配置表字典键值 | [wikis/pages?sort_id=3908759&doc_id=1362860](https://gitee.com/Fresns/Docs/wikis/pages?sort_id=3908759&doc_id=1362860) |
| 配置表键名 | [wikis/pages?sort_id=4009642&doc_id=1362860](https://gitee.com/Fresns/Docs/wikis/pages?sort_id=4009642&doc_id=1362860) |
| 流程图 | [wikis/pages?sort_id=3908815&doc_id=1362860](https://gitee.com/Fresns/Docs/wikis/pages?sort_id=3908815&doc_id=1362860) |
| API 文档 | [wikis/pages?sort_id=3908682&doc_id=1362860](https://gitee.com/Fresns/Docs/wikis/pages?sort_id=3908682&doc_id=1362860) |

| 原型 | 链接 |
| --- | --- |
| 后端控制台 | [https://fresns.gitee.io/docs/backend/](https://fresns.gitee.io/docs/backend/) |
| 控制面板 *基础版* | [https://fresns.gitee.io/docs/control-panel/](https://fresns.gitee.io/docs/control-panel/) |
| 控制面板 *专业版* | [https://fresns.gitee.io/docs/control-panel-pro/](https://fresns.gitee.io/docs/control-panel-pro/) |
| 主题演示 | [https://fresns.gitee.io/docs/theme-demo/](https://fresns.gitee.io/docs/theme-demo/) |
| 内容列表演示 | [https://fresns.gitee.io/docs/lists/](https://fresns.gitee.io/docs/lists/) |
| 编辑器 SDK 演示 | [https://fresns.gitee.io/docs/editor/](https://fresns.gitee.io/docs/editor/) |

## 管理指南

| 指南 | 版本 | 来源 |
| --- | --- | --- |
| [12-factors](https://12factor.net/zh_cn/) | 2017 | Adam Wiggins |
| [代码分支管理指南](https://open.leancloud.cn/git-branch-guide/) | 2014 | LeanCloud |
| [Git Commit 日志风格指南](https://open.leancloud.cn/git-commit-message/) | 2019 | LeanCloud |
| [文案风格指南](https://open.leancloud.cn/copywriting-style-guide/) | 2014 | LeanCloud |
| [Markdown 指南](https://www.markdownguide.org/) | 2021 | Matt Cone |

## 编码风格

| 指南 | 版本 |
| --- | --- |
| [PSR-12-MEAT](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-12-extended-coding-style-guide-meta.md) | 2019-09-06 |
| [PSR-12](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-12-extended-coding-style-guide.md) | 2019-12-19 |
| [PSR-4](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-4-autoloader.md) | 2018-01-03 |
| [JSON](https://jsonapi.org) | 1.1 |

## 时间标准

- 数据库中时间值均为 timestamp 字段类型，字段自带时区参数。
- **录入**：默认录入，时区是服务器自带。
- **输出**：按指定时区转换数据库时间，当请求参数无时区参数时，转换为后台配置的默认时区的时间输出。

## 颜色标准

- 颜色字段存储为 Hex 值。

## 变量标准

| 功能 | 标准 |
| --- | --- |
| 货币代码 | [ISO 4217 Currency Codes](https://www.iso.org/iso-4217-currency-codes.html) |
| 多语言-语言标签 | [HTML Language Tag](https://www.w3.org/International/articles/language-tags/) |
| 多语言-语言代码 | [HTML ISO Language Codes](https://www.w3schools.com/tags/ref_language_codes.asp) |
| 多语言-地区代码 | [HTML ISO Country Codes](https://www.w3schools.com/tags/ref_country_codes.asp) |

## 知识产权

| 类型 | 名称 | 注册号 |
| --- | --- | --- |
| 域名 | fresns.cn |  |
| 商标 35 类 | Fresns | 55262508 |
| 商标 42 类 | Fresns | 55248596 |
| 发明专利 | 一种跨平台通用型论坛社区程序的控制方法和系统 | 2020108135110<br>CN111913698A |
| 发明专利 | 一种实时、统一、通用和标准的一体化社交网络多形态内容服务系统 | 202110434555.7 |
| 作品著作权登记 | Fresns 开发者文档 |  |
| 计算机软件著作权 | Fresns App Store |  |
| 计算机软件著作权 | Fresns Backend for PHP |  |
| 计算机软件著作权 | Fresns Control Panel for PHP |  |
| 计算机软件著作权 | Fresns Control Panel API for PHP |  |
| 计算机软件著作权 | Fresns Control Panel Pro for PHP |  |
| 计算机软件著作权 | Fresns Editor SDK for Web |  |
| 计算机软件著作权 | Fresns Editor SDK for 微信小程序 |  |
| 计算机软件著作权 | Fresns Editor SDK for iOS |  |
| 计算机软件著作权 | Fresns Editor SDK for Android |  |
| 计算机软件著作权 | Fresns Client for Web |  |
| 计算机软件著作权 | Fresns Client for 微信小程序 |  |
| 计算机软件著作权 | Fresns Client for iOS |  |
| 计算机软件著作权 | Fresns Client for Android |  |