README.md

eula.ai

A simple web application that tells you if your end-user license agreement is ethical and summarizes your document for easy understanding.

Setup

To clone and run this application, you will need Git, Python 3.8.5, and Node.js (which comes with npm) installed on your computer. Begin by cloning repository:

# Clone this repository
$ git clone https://github.com/cs130-w21/22.git

# Go into the repository
$ cd 22

Download the machine learning model and place the tarball into the backend/ folder, set up, and run Flask server:

# Go into backend/ folder
$ cd backend

# Run script to set up folder for model
$ ./fetch_model.sh

# Install Python dependencies
$ pip3 install -r requirements.txt

# Set environment variable
$ export FLASK_APP=flaskApi.py

# Run Flask app
$ flask run

In a new terminal, install dependencies and run the frontend with npm:

# Install dependencies
$ npm install

# Run the app
$ npm start

Or, use yarn:

# Install dependencies
$ yarn install

# Run the app
$ yarn start