Text Grader

Text Grader - A system for automatic evaluation of essays

About • Usage • Development • Credits • License

About

This repository contains TextGrader. In essence textgrader contains the various versions of a Essay and short answer evaluation system.

The system is divided as explained below:

1. Frontend (NodeJS)
   1. Text Grader Website
      1. Show an User Interface with a Text Editor and a button to grade the text
      2. Send the text in a HTTP GET request body to Text Grader API
      3. Receive the HTTP response and show it to the user
2. Backend (Python - Flask)
   1. Text Grader API
      1. Receive a HTTP get request with a text content
      2. Transform the data in JSON and send the HTTP response
      3. Saves all essays into json files (for now)

Usage

Run in your terminal make up. You can access from your browser:

1. Text Grader API - http://localhost:3006/
2. Text Grader Website - http://localhost:3005/ 2.1. Endpoints:

   • POST /model: receives a essay field, containing textgrader essay and returns a object with five grades Example:

     -Request
     ```
        curl -X POST -H "Content-Type: application/json" -d '{"essay": "Seu texto aqui"}' http://localhost:3006/model
     ```
     
     - Response
     ```
        {
           "grades": {
              "nota_1": 145.6,
              "nota_2": 141.6,
              "nota_3": 118.8,
              "nota_4": 170.8,
              "nota_5": 122.0
           }
        }
     ```            
     

To stop all services: make down

Development

This project uses GitFlow workflow:

• Start your new feature: Make a new branch based on develop branch
• Finish your feature: Open a Pull request from your feature branch to develop

This project also uses Semantic Commit Messages:

See how a minor change to your commit message style can make you a better programmer.

Format: <type>(<scope>): <subject>

<scope> is optional

Example

feat: add hat wobble
^--^  ^------------^
|     |
|     +-> Summary in present tense.
|
+-------> Type: chore, docs, feat, fix, refactor, style, or test.

More Examples:

• feat: (new feature for the user, not a new feature for build script)
• fix: (bug fix for the user, not a fix to a build script)
• docs: (changes to the documentation)
• style: (formatting, missing semi colons, etc; no production code change)
• refactor: (refactoring production code, eg. renaming a variable)
• test: (adding missing tests, refactoring tests; no production code change)
• chore: (updating grunt tasks etc; no production code change)

References:

• https://www.conventionalcommits.org/
• https://seesparkbox.com/foundry/semantic_commit_messages
• http://karma-runner.github.io/1.0/dev/git-commit-msg.html

Credits

Thanks for the open source projects bellow:

• Docker
• NodeJS
• Python

License

MIT