Browse Source

Merge pull request #1352 from doccano/fix/#1346

Update docs
pull/1358/head
Hiroki Nakayama 3 years ago
committed by GitHub
parent
commit
a2c1c8dae0
No known key found for this signature in database GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 15 additions and 15 deletions
  1. 4
      docs/getting-started.md
  2. 4
      docs/index.md
  3. 22
      docs/project_structure.md

4
docs/getting-started.md

@ -54,7 +54,7 @@ $ git clone https://github.com/doccano/doccano.git
$ cd doccano $ cd doccano
$ pipenv sync --dev $ pipenv sync --dev
$ pipenv shell $ pipenv shell
$ cd app
$ cd backend
$ python manage.py migrate $ python manage.py migrate
$ python manage.py create_roles $ python manage.py create_roles
$ python manage.py create_admin --noinput --username "admin" --email "admin@example.com" --password "password" $ python manage.py create_admin --noinput --username "admin" --email "admin@example.com" --password "password"
@ -64,7 +64,7 @@ $ python manage.py runserver
### Node.js ### Node.js
```bash ```bash
$ cd doccano/frontend
$ cd frontend
$ yarn install $ yarn install
$ yarn dev $ yarn dev
``` ```

4
docs/index.md

@ -28,12 +28,12 @@ Final demo is one of the sequence to sequence tasks, machine translation. Since
## Quick Deployment ## Quick Deployment
### Azure
<!-- ### Azure
Doccano can be deployed to Azure ([Web App for Containers](https://azure.microsoft.com/en-us/services/app-service/containers/) + Doccano can be deployed to Azure ([Web App for Containers](https://azure.microsoft.com/en-us/services/app-service/containers/) +
[PostgreSQL database](https://azure.microsoft.com/en-us/services/postgresql/)) by clicking on the button below: [PostgreSQL database](https://azure.microsoft.com/en-us/services/postgresql/)) by clicking on the button below:
[![Deploy to Azure](https://azuredeploy.net/deploybutton.svg)](https://portal.azure.com/#create/Microsoft.Template/uri/https%3A%2F%2Fraw.githubusercontent.com%2Fdoccano%2Fdoccano%2Fmaster%2Fazuredeploy.json)
[![Deploy to Azure](https://azuredeploy.net/deploybutton.svg)](https://portal.azure.com/#create/Microsoft.Template/uri/https%3A%2F%2Fraw.githubusercontent.com%2Fdoccano%2Fdoccano%2Fmaster%2Fazuredeploy.json) -->
### Heroku ### Heroku

22
docs/project_structure.md

@ -4,7 +4,7 @@ The important files/directories are as follows:
``` ```
/ /
├── app/
├── backend/
├── frontend/ ├── frontend/
├── nginx/ ├── nginx/
├── tools/ ├── tools/
@ -14,9 +14,9 @@ The important files/directories are as follows:
Consider them: Consider them:
**[app/](https://github.com/doccano/doccano/tree/master/app)**
**[backend/](https://github.com/doccano/doccano/tree/master/backend)**
The `app/` directory contains backend code. See [below](#Backend).
The `backend/` directory contains backend code. See [below](#Backend).
**[frontend/](https://github.com/doccano/doccano/tree/master/frontend)** **[frontend/](https://github.com/doccano/doccano/tree/master/frontend)**
@ -45,7 +45,7 @@ In the future, they will be integrated into the current code or removed:
``` ```
/ /
├── app/
├── backend/
├── └── server/ ├── └── server/
``` ```
@ -56,24 +56,24 @@ The important directories are as follows:
``` ```
/ /
├── app/
├── backend/
├── ├── api/ ├── ├── api/
├── ├── app/ ├── ├── app/
└── └── authentification/ └── └── authentification/
``` ```
**[app/api/](https://github.com/doccano/doccano/tree/master/app/api)**
**[backend/api/](https://github.com/doccano/doccano/tree/master/backend/api)**
The `app/api` directory contains backend API application. We use [Django Rest Framework](https://www.django-rest-framework.org) to implement the API.
The `backend/api` directory contains backend API application. We use [Django Rest Framework](https://www.django-rest-framework.org) to implement the API.
If you want to add new API, change the contents of this directory. If you want to add new API, change the contents of this directory.
**[app/app/](https://github.com/doccano/doccano/tree/master/app/app)**
**[backend/app/](https://github.com/doccano/doccano/tree/master/backend/app)**
The `app/app` directory contains Django project settings. See [Writing your first Django app, part 1](https://docs.djangoproject.com/en/3.0/intro/tutorial01/#creating-a-project).
The `backend/app` directory contains Django project settings. See [Writing your first Django app, part 1](https://docs.djangoproject.com/en/3.0/intro/tutorial01/#creating-a-project).
**[app/authentification/](https://github.com/doccano/doccano/tree/master/app/authentification)**
**[backend/authentification/](https://github.com/doccano/doccano/tree/master/backend/authentification)**
The `app/authentification` directory contains authentification application. It is mainly used for user signup.
The `backend/authentification` directory contains authentification application. It is mainly used for user signup.
## Frontend ## Frontend

Loading…
Cancel
Save