Update documentation
This commit is contained in:
parent
dec36d0771
commit
6aa28f88e7
4
.github/CONTRIBUTING.md
vendored
4
.github/CONTRIBUTING.md
vendored
|
|
@ -18,15 +18,15 @@
|
||||||
- [Composer](https://getcomposer.org)
|
- [Composer](https://getcomposer.org)
|
||||||
- [PowerShell Core](https://github.com/PowerShell/PowerShell#get-powershell)
|
- [PowerShell Core](https://github.com/PowerShell/PowerShell#get-powershell)
|
||||||
|
|
||||||
然后执行以下命令来拉取代码:
|
然后执行以下命令:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
git clone https://github.com/bs-community/blessing-skin-server.git
|
git clone https://github.com/bs-community/blessing-skin-server.git
|
||||||
cd blessing-skin-server
|
cd blessing-skin-server
|
||||||
composer install
|
composer install
|
||||||
cp .env.example .env
|
cp .env.example .env
|
||||||
yarn
|
|
||||||
php artisan key:generate
|
php artisan key:generate
|
||||||
|
yarn
|
||||||
```
|
```
|
||||||
|
|
||||||
然后在 `.env` 中配置好您的环境信息,务必设置好 `ASSET_URL`,否则无法编译前端资源。
|
然后在 `.env` 中配置好您的环境信息,务必设置好 `ASSET_URL`,否则无法编译前端资源。
|
||||||
|
|
|
||||||
28
README.md
28
README.md
|
|
@ -166,33 +166,7 @@ Blessing Skin 提供了强大的插件系统,您可以通过添加多种多样
|
||||||
|
|
||||||
## 自行构建
|
## 自行构建
|
||||||
|
|
||||||
如果你想为此项目作贡献,或者抢先尝试未发布的新功能,你应该先用 GitHub 上的代码部署。
|
详情可阅读 [这里](https://blessing.netlify.com/build.html)。
|
||||||
|
|
||||||
**不推荐不熟悉 shell 操作以及不想折腾的用户使用。**
|
|
||||||
|
|
||||||
请先确保您安装好以下工具:
|
|
||||||
|
|
||||||
- [Git](https://git-scm.org)
|
|
||||||
- [Node.js](https://nodejs.org)
|
|
||||||
- [Yarn](https://yarnpkg.com)
|
|
||||||
- [Composer](https://getcomposer.org)
|
|
||||||
|
|
||||||
从 GitHub 上 clone 源码并安装依赖:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
git clone https://github.com/bs-community/blessing-skin-server.git
|
|
||||||
cd blessing-skin-server
|
|
||||||
composer install
|
|
||||||
yarn
|
|
||||||
```
|
|
||||||
|
|
||||||
构建前端代码!
|
|
||||||
|
|
||||||
```bash
|
|
||||||
yarn build
|
|
||||||
```
|
|
||||||
|
|
||||||
接下来请参考「快速安装向导」进行后续安装。
|
|
||||||
|
|
||||||
> 您可以订阅我们的 Telegram 频道 [Blessing Skin News](https://t.me/blessing_skin_news) 来获取最新开发动态。当有新的 Commit 被推送时,我们的机器人将会在频道内发送一条消息来提示您能否拉取最新代码,以及拉取后应该做什么。
|
> 您可以订阅我们的 Telegram 频道 [Blessing Skin News](https://t.me/blessing_skin_news) 来获取最新开发动态。当有新的 Commit 被推送时,我们的机器人将会在频道内发送一条消息来提示您能否拉取最新代码,以及拉取后应该做什么。
|
||||||
|
|
||||||
|
|
|
||||||
28
README_EN.md
28
README_EN.md
|
|
@ -167,33 +167,7 @@ Currently you can sponsor us via [爱发电](https://afdian.net/@blessing-skin).
|
||||||
|
|
||||||
## Developer Install
|
## Developer Install
|
||||||
|
|
||||||
If you'd like make some contribution on the project, please deploy it from GitHub first.
|
Please refer to [here](https://blessing.netlify.com/build.html).
|
||||||
|
|
||||||
**You'd better have some experience on shell operations to continue.**
|
|
||||||
|
|
||||||
Please make sure you have installed the tools below:
|
|
||||||
|
|
||||||
- [Git](https://git-scm.org)
|
|
||||||
- [Node.js](https://nodejs.org)
|
|
||||||
- [Yarn](https://yarnpkg.com)
|
|
||||||
- [Composer](https://getcomposer.org)
|
|
||||||
|
|
||||||
Clone the code from GitHub and install dependencies:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
git clone https://github.com/bs-community/blessing-skin-server.git
|
|
||||||
cd blessing-skin-server
|
|
||||||
composer install
|
|
||||||
yarn
|
|
||||||
```
|
|
||||||
|
|
||||||
Build the things!
|
|
||||||
|
|
||||||
```bash
|
|
||||||
yarn build
|
|
||||||
```
|
|
||||||
|
|
||||||
Congrats! You made it. Next, please refer to No.2 of **Quick Install** section.
|
|
||||||
|
|
||||||
## Configure the Web Server
|
## Configure the Web Server
|
||||||
|
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue
Block a user