feat: update readme
This commit is contained in:
parent
f7f5689f5a
commit
0c0d90fd50
71
README.md
71
README.md
@ -89,70 +89,15 @@ yarn start
|
|||||||
|
|
||||||
Open http://localhost:8000 in a web browser.
|
Open http://localhost:8000 in a web browser.
|
||||||
|
|
||||||
### Use docker compose
|
### Use docker
|
||||||
|
|
||||||
Create a `docker-compose.yml` file
|
```bash
|
||||||
|
docker run --name my-nocobase-app -p 8000:13002 -d nocobase/nocobase:0.5.0-alpha.23
|
||||||
```yaml
|
docker logs my-nocobase-app
|
||||||
version: "3"
|
|
||||||
networks:
|
|
||||||
nocobase:
|
|
||||||
driver: bridge
|
|
||||||
services:
|
|
||||||
adminer:
|
|
||||||
image: adminer
|
|
||||||
restart: always
|
|
||||||
networks:
|
|
||||||
- nocobase
|
|
||||||
ports:
|
|
||||||
- 28080:8080
|
|
||||||
postgres:
|
|
||||||
image: postgres:10
|
|
||||||
restart: always
|
|
||||||
networks:
|
|
||||||
- nocobase
|
|
||||||
command: postgres -c wal_level=logical
|
|
||||||
environment:
|
|
||||||
POSTGRES_USER: nocobase
|
|
||||||
POSTGRES_DB: nocobase
|
|
||||||
POSTGRES_PASSWORD: nocobase
|
|
||||||
nocobase:
|
|
||||||
image: nocobase/nocobase:0.5.0-alpha.14
|
|
||||||
networks:
|
|
||||||
- nocobase
|
|
||||||
command: [ "yarn", "serve", "start", "--port", "8000" ]
|
|
||||||
environment:
|
|
||||||
DB_DIALECT: postgres
|
|
||||||
DB_DATABASE: nocobase
|
|
||||||
DB_USER: nocobase
|
|
||||||
DB_PASSWORD: nocobase
|
|
||||||
DB_PORT: 5432
|
|
||||||
DB_HOST: postgres
|
|
||||||
ports:
|
|
||||||
- "28000:8000"
|
|
||||||
```
|
```
|
||||||
|
|
||||||
Run the command on your terminal
|
|
||||||
|
|
||||||
```
|
|
||||||
docker-compose run nocobase bash -c 'yarn serve init'
|
|
||||||
docker-compose up -d
|
|
||||||
```
|
|
||||||
|
|
||||||
Open http://localhost:28000 in a web browser.
|
|
||||||
|
|
||||||
### Participate in the development
|
|
||||||
|
|
||||||
~~~shell
|
|
||||||
git clone https://github.com/nocobase/nocobase.git
|
|
||||||
cd nocobase
|
|
||||||
cp .env.example .env
|
|
||||||
docker-compose up -d postgres
|
|
||||||
yarn install
|
|
||||||
yarn bootstrap
|
|
||||||
yarn build
|
|
||||||
yarn nocobase init
|
|
||||||
yarn start
|
|
||||||
~~~
|
|
||||||
|
|
||||||
Open http://localhost:8000 in a web browser.
|
Open http://localhost:8000 in a web browser.
|
||||||
|
|
||||||
|
## Contributing
|
||||||
|
|
||||||
|
https://docs.nocobase.com/guide/contributing
|
||||||
|
@ -95,70 +95,17 @@ yarn start
|
|||||||
|
|
||||||
使用浏览器打开 http://localhost:8000
|
使用浏览器打开 http://localhost:8000
|
||||||
|
|
||||||
### 使用 docker compose
|
### 使用 docker
|
||||||
|
|
||||||
创建 `docker-compose.yml` 文件
|
```bash
|
||||||
|
# 启动 app
|
||||||
```yaml
|
docker run --name my-nocobase-app -p 8000:13002 -d nocobase/nocobase:0.5.0-alpha.23
|
||||||
version: "3"
|
# 查看日志
|
||||||
networks:
|
docker logs my-nocobase-app
|
||||||
nocobase:
|
|
||||||
driver: bridge
|
|
||||||
services:
|
|
||||||
adminer:
|
|
||||||
image: adminer
|
|
||||||
restart: always
|
|
||||||
networks:
|
|
||||||
- nocobase
|
|
||||||
ports:
|
|
||||||
- 28080:8080
|
|
||||||
postgres:
|
|
||||||
image: postgres:10
|
|
||||||
restart: always
|
|
||||||
networks:
|
|
||||||
- nocobase
|
|
||||||
command: postgres -c wal_level=logical
|
|
||||||
environment:
|
|
||||||
POSTGRES_USER: nocobase
|
|
||||||
POSTGRES_DB: nocobase
|
|
||||||
POSTGRES_PASSWORD: nocobase
|
|
||||||
nocobase:
|
|
||||||
image: nocobase/nocobase:0.5.0-alpha.14
|
|
||||||
networks:
|
|
||||||
- nocobase
|
|
||||||
command: [ "yarn", "serve", "start", "--port", "8000" ]
|
|
||||||
environment:
|
|
||||||
DB_DIALECT: postgres
|
|
||||||
DB_DATABASE: nocobase
|
|
||||||
DB_USER: nocobase
|
|
||||||
DB_PASSWORD: nocobase
|
|
||||||
DB_PORT: 5432
|
|
||||||
DB_HOST: postgres
|
|
||||||
ports:
|
|
||||||
- "28000:8000"
|
|
||||||
```
|
```
|
||||||
|
|
||||||
终端运行
|
|
||||||
|
|
||||||
```
|
|
||||||
docker-compose run nocobase bash -c 'yarn serve init'
|
|
||||||
docker-compose up -d
|
|
||||||
```
|
|
||||||
|
|
||||||
浏览器内打开 http://localhost:28000
|
|
||||||
|
|
||||||
### 参与开发
|
|
||||||
|
|
||||||
~~~shell
|
|
||||||
git clone https://github.com/nocobase/nocobase.git
|
|
||||||
cd nocobase
|
|
||||||
cp .env.example .env # 配置数据库信息、APP 端口等
|
|
||||||
docker-compose up -d postgres # 用 docker 启动数据库
|
|
||||||
yarn install
|
|
||||||
yarn bootstrap
|
|
||||||
yarn build
|
|
||||||
yarn nocobase init
|
|
||||||
yarn start
|
|
||||||
~~~
|
|
||||||
|
|
||||||
浏览器内打开 http://localhost:8000
|
浏览器内打开 http://localhost:8000
|
||||||
|
|
||||||
|
## 参与贡献
|
||||||
|
|
||||||
|
https://docs.nocobase.com/zh-CN/guide/contributing
|
Loading…
Reference in New Issue
Block a user