From d69e0814461763d86b4e511b9945cea3d6d51b3e Mon Sep 17 00:00:00 2001 From: Hironsan Date: Tue, 11 May 2021 09:08:24 +0900 Subject: [PATCH] Update documentation, fix #1353 --- docs/getting-started.md | 37 ++++++++++++++++++++++--------------- 1 file changed, 22 insertions(+), 15 deletions(-) diff --git a/docs/getting-started.md b/docs/getting-started.md index 75babd00..a9de7b98 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -38,9 +38,9 @@ Go to . You can setup local development environment as follows: ```bash -$ git clone https://github.com/doccano/doccano.git -$ cd doccano -$ docker-compose -f docker-compose.dev.yml up +git clone https://github.com/doccano/doccano.git +cd doccano +docker-compose -f docker-compose.dev.yml up ``` Go to . @@ -50,23 +50,30 @@ Or, you can setup via Python and Node.js: ### Python ```bash -$ git clone https://github.com/doccano/doccano.git -$ cd doccano -$ pipenv sync --dev -$ pipenv shell -$ cd backend -$ python manage.py migrate -$ python manage.py create_roles -$ python manage.py create_admin --noinput --username "admin" --email "admin@example.com" --password "password" -$ python manage.py runserver +git clone https://github.com/doccano/doccano.git +cd doccano +pipenv sync --dev +pipenv shell +cd backend +python manage.py migrate +python manage.py create_roles +python manage.py create_admin --noinput --username "admin" --email "admin@example.com" --password "password" +python manage.py runserver +``` + +In another terminal, you need to run Celery to use import/export dataset feature: + +```bash +cd doccano/backend +celery --app=app worker --loglevel=INFO --concurrency=1 ``` ### Node.js ```bash -$ cd frontend -$ yarn install -$ yarn dev +cd frontend +yarn install +yarn dev ``` Go to .