Commit 6b4d8962 authored by D.H.D. Nguyen's avatar D.H.D. Nguyen
Browse files

update README

parent ee3c2b93

README.md

+41 −45
Original line number Diff line number Diff line
@@ -54,56 +54,52 @@ The system works locally. Open this [URL](http://127.0.0.1:5000/ "Local developm 
In the following scheme is the structure of this directory for the web application :

```bash   

swp/

├── README.md

├── ...

├── __init__.py

├── config.py

├── doc

├── config.py - Configurations

├── doc - Documentation

│   └── ...

├── examples

├── examples - Example files

│   ├── empty_example.txt

│   ├── example_fewer_5.txt

│   ├── first_10_characters_examples

│   ├── first_10_characters_examples.txt

│   └── movie_reviews_examples.txt

├── index.rst

├── main.py

├── project

│   ├── __init__.py

│   ├── annotator

│   │   ├── __init__.py

│   │   ├── account.py

│   │   ├── annotation.py

│   │   ├── forms.py

│   │   ├── helpers.py

│   │   └── views.py

│   ├── generator.py

│   ├── models.py

│   ├── start

├── main.py - Run application in development environment

├── project - Web Application

│   ├── __init__.py - Application Initialization

│   ├── annotator - Annotator Subsystem

│   │   ├── __init__.py

│   │   └── routes.py

│   ├── static

│   │   └── styles.css

│   ├── templates

│   │   ├── annotator

│   │   ├── account.py - Account Management

│   │   ├── annotation.py - Annotation Management

│   │   ├── forms.py - Forms

│   │   ├── helpers.py - Helper Functions

│   │   └── views.py - Views Management

│   ├── generator.py - Generators

│   ├── models.py - Database Models

│   ├── templates - Application Templates

│   │   ├── annotator - Tempaltes in Annotator Subsystem

│   │   │   ├── batch.html

│   │   │   ├── index.html

│   │   │   └── project.html

│   │   ├── questions.xml

│   │   ├── start.html

│   │   └── user

│   │   ├── questions.xml - Keyword Template on Mechanical Turk

│   │   ├── start.html - Homepage

│   │   └── user - Templates in User Subsystem

│   │       ├── index.html

│   │       ├── login.html

│   │       ├── profile.html

│   │       ├── project.html

│   │       ├── signup.html

│   │       └── upload-project.html

│   ├── user

│   ├── user - User Subsystem

│   │   ├── __init__.py

│   │   ├── account.py

│   │   ├── forms.py

│   │   ├── helpers.py

│   │   ├── home.py

│   │   ├── inputs.py

│   │   ├── outputs.py

│   │   └── views.py

│   └── validators.py

│   │   ├── account.py - Account Management

│   │   ├── forms.py - Forms

│   │   ├── helpers.py - Helper Functions

│   │   ├── inputs.py - Inputs Management

│   │   ├── outputs.py - Outputs Management

│   │   └── views.py - Views Management

│   └── validators.py - Form Validators

├── requirements.txt

└── tests

   └── ...
@@ -136,18 +132,18 @@ swp/ 
│	....

└── tests

    ├── __init__.py

    ├── conftest.py

    ├── functional

    ├── conftest.py - Configurations

    ├── functional - Functional Tests

    │   ├── __init__.py

    │   ├── test_annotators.py

    │   ├── test_batches.py

    │   ├── test_projects.py

    │   ├── test_users.py

    │   └── test_wrong_cases_input_required.py

    └── unit

    │   ├── test_annotators.py - Annotator Account Tests

    │   ├── test_batches.py - Annotation Tests

    │   ├── test_projects.py - New Project Tests

    │   ├── test_users.py - User Account Tests

    │   └── test_wrong_cases_input_required.py - Extra Tests

    └── unit - Unit Tests

        ├── __init__.py

        ├── test_generator.py

        └── test_models.py

        ├── test_generator.py - Generator Tests

        └── test_models.py - Database Model Tests

```



#### § Tests