HeyRoom

小黑屋留学网站

"完美的"README模板

一个"完美的"README模板去快速开始你的项目！
探索本项目的文档 »

查看Demo · 报告Bug · 提出新特性

本篇README.md面向开发者

目录

• 上手指南
  • 开发前的配置要求
  • 安装步骤
• 文件目录说明
• 开发的架构
• 部署
• 使用到的框架
• 贡献者
  • 如何参与项目
  • 如何提交自己的代码到master
• 版本控制
• 作者及其联系
• 鸣谢

上手指南

以下指南将帮助你在本地机器上安装和运行该项目，进行开发和测试。关于如何将该项目部署到在线环境，请参考部署小节。

开发前的配置要求

1. Django 2.2.7
2. Python 3.7
3. Mysql 8.0.13
4. MongoDB 4.0.3

安装步骤

1. Clone the repo

git clone https://github.com/shaojintian/heyroom.git

2. Run the project

 python manage.py runserver localhost:8080

文件目录说明

eg:

filetree 
├── ARCHITECTURE.md
├── LICENSE.txt
├── README.md
├── /account/
├── /bbs/
├── /docs/
│  ├── /rules/
│  │  ├── backend.txt
│  │  └── frontend.txt
├── manage.py
├── /oa/
├── /static/
├── /templates/
├── useless.md
└── /util/

开发的架构

请阅读ARCHITECTURE.md 查阅为该项目的架构。

部署

1. 腾讯云服务器172.81.235.217
2. 域名www.liuxueheyroom

使用到的框架

• Django
• xadmin
• restful API

贡献者

请阅读CONTRIBUTING.md 查阅为该项目做出贡献的开发者。

如何参与项目

1. Fork the Project
2. Create your Feature Branch (git checkout -b xxx-dev)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin xxx-dev)
5. Open a Pull Request

如何提交自己的代码到master

1. 按上述创建好自己的branch
2. git update from master
3. 修改你的branch的代码
4. 确保无误后，提交到你的分支:

git commit -m "..." 
git push origin xxx-dev

5 . 更新你的分支后，更新你的branch到master:

切换到master分支
GitHub Desktop -> Branch -> Merge into Current Branch -> 选择xxx-dev
git push origin master

版本控制

该项目使用Git进行版本管理。您可以在repository参看当前可用版本。

作者

邵靳天@铭丰科技

知乎:笃行er   qq:1075803623

您也可以在贡献者名单中参看所有参与该项目的开发者。

版权说明

该项目签署了MIT 授权许可，详情请参阅 LICENSE.txt

鸣谢

感谢铭丰科技小伙伴和其他项目的支持和陪伴

• GitHub Emoji Cheat Sheet
• Img Shields
• Choose an Open Source License
• GitHub Pages
• Animate.css
• abcadamk1