# Welcome to Automated Essay Grader’s documentation!

Automated Essay Grader is essentially a usable wrapper for using machine learning models based on Essay grading. Our project runs on `Starlette server` hosted on `Heroku cloud` with a noSQL database hosted on `Firebase`. Using `MVC architecture` we have created a web interface powered by `Bootstrap 4.0`. Our project also has a fully featured `Android` interface.

To check a live web demo Check out

## Project environment setup

To start the project you first need to install all dependencies:

    >>> pip install requirements.txt

After we have all the requirements set up, we will now create an environment

    >>> conda env create -f Softlab.yml

After the environment is set up you can initialize the environment somehow

    >>> conda activate Softlab

Yes that was it!! Now simply start the system by typing

    >>> python3 main.py

## Deployment steps using Docker

1. You can simply build the the image file by running following in the directory where Dockerfile is present

       >>> docker build --tag essay-grader .

       >>> docker run --name essay-grader -p 8000:8000 essay-grader

## Checkout some code now

Back end:

- MVC architecture connections
- Automated essay grader model

Front end:

- Web views
- Android application

## Indices and tables

- Index

- Module Index

- Search Page