Browse Source

Mention v0.x files in a right way (#784)

pull/780/head
Alexander Kurakin 4 years ago
parent
commit
649fce2ede
1 changed files with 13 additions and 8 deletions
  1. 21
      docs/project_structure.md

21
docs/project_structure.md

@ -2,7 +2,7 @@
The important files/directories are as follows: The important files/directories are as follows:
```bash
```
/ /
├── app/ ├── app/
├── frontend/ ├── frontend/
@ -40,18 +40,27 @@ The `nginx` directory contains a NGINX configuration file and Docker container.
The `tools` directory contains some shell scripts. They are used for CI, CD and so on. The `tools` directory contains some shell scripts. They are used for CI, CD and so on.
Also, there are directories and files contain doccano v0.x codes.
In the future, they will be integrated into the currect code or removed:
```
/
├── app/
├── └── server/
└── docker-compose.prod.yml
```
## Backend ## Backend
The directory structure of the backend follows [Django](https://www.djangoproject.com) one. The directory structure of the backend follows [Django](https://www.djangoproject.com) one.
The important directories are as follows: The important directories are as follows:
```bash
```
/ /
├── app/ ├── app/
├── ├── api/ ├── ├── api/
├── ├── app/ ├── ├── app/
├── ├── authentification/
└── └── server/
└── └── authentification/
``` ```
**[app/api/](https://github.com/doccano/doccano/tree/master/app/api)** **[app/api/](https://github.com/doccano/doccano/tree/master/app/api)**
@ -67,10 +76,6 @@ The `app/app` directory contains Django project settings. See [Writing your firs
The `app/authentification` directory contains authentification application. It is mainly used for user signup. The `app/authentification` directory contains authentification application. It is mainly used for user signup.
**[app/server/](https://github.com/doccano/doccano/tree/master/app/server)**
The `app/server` directory contains doccano v0.x codes. In the future, this directory will be integrated into the `api` directory.
## Frontend ## Frontend
The `frontent` directory structure of the frontend follows [Nuxt.js](https://ru.nuxtjs.org) one. The `frontent` directory structure of the frontend follows [Nuxt.js](https://ru.nuxtjs.org) one.

Loading…
Cancel
Save