Files
fzu-product/README.md

62 lines
2.5 KiB
Markdown
Raw Permalink Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
<div align="center">
<img src="https://cdn.xyxsw.site/hdu-cs-wiki%20full.svg" alt="logo" width="450rem" height="450rem"/>
</div>
<h1 align="center">FZU-WIKI</h1>
<pre align="center">喜欢本项目可以点击右上角 “点赞” 收藏哦🎇</pre>
## 📖 项目介绍
FZU-WIKI 是福州大学星航电子工作室自发组织的一个开源项目,旨在为全校学生提供一个全面、系统、易用的小百科全书,方便新生以及在校同学快速了解学校方方面面,同时为同学提供学习和生活方面的帮助。
该项目将完全由校内全体学生共同维护,欢迎任何有想法且具备开源精神的伙伴加入到项目贡献中来,完成这项接力式项目的迭代与完善!
项目完全开源,未来计划划分多个文档模块,交由各个学院代表同学负责维护,以最大限度保证项目文档的实时性和准确性。
## 🌟 项目特色
- **全面性**:涵盖学校各个方面的信息,目前主要涵盖学习和生活两大板块。
- **易用性**:采用简洁明了的界面设计,同时支持全页面模糊查询,方便同学快速查找所需信息。
- **开放性**:项目完全开源,欢迎任何有想法且具备开源精神的伙伴加入到项目贡献中来。
- **持续更新**:项目将不断更新,确保信息的时效性和准确性。
## 🚀 项目支持
- 本项目基于hdu-cs-wiki项目进行二次开发感谢hdu-cs-wiki团队的无私奉献
- 本项目q&a模块数据来自“福州大学新生群”(QQ群号:829337155)管理员“23 落枫F.M.”对群内问答的总结,感谢落枫大佬的无私奉献!
- 本项目由星航电子工作室提供技术支持。
## 🤝 贡献者
感谢所有为本项目做出贡献的同学,你们的努力让本项目更加完善!
## 📝 许可证
本作品采用 `知识共享 署名-非商业性使用-相同方式共享 3.0 中国大陆` 许可协议进行许可。 要查看该许可协议, 可访问[这里](http://creativecommons.org/licenses/by-nc-sa/3.0/cn/) 或者写信到 Creative Commons, PO Box 1866, Mountain View, CA 94042, USA.
© 2022. 此文章采用 [**CC BY-NC-SA 3.0 CN**](http://creativecommons.org/licenses/by-nc-sa/3.0/cn/) 许可授权。
## 📣 部署方式
### 1. 克隆项目
```bash
git clone https://gitea.xinxijishubu.asia/moyin/fzu-product.git
```
### 2. 安装依赖
```bash
cd FZU-WIKI
yarn install
```
### 3. 启动项目
```bash
npm run docs:dev
```
### 4. 访问项目
在浏览器中访问 `http://localhost:5173` 即可查看项目。