Setting up OpenMF Frontend

After cloning, create a virtual environment and install the requirements.
For Linux and Mac users:

```
$ virtualenv venv
$ source venv/bin/activate
(venv) $ pip install -r requirements.txt
```

If you are on Windows, then use the following commands instead:

$ virtualenv venv
$ venv\Scripts\activate
(venv) $ pip install -r requirements.txt

Running

---

Step1: Change directory to React-Frontend

(venv) $ cd React-Frontend

Step2: Install required dependencies

(venv) $ npm install

Step3: Run the react server:

(venv) $ npm start

And use localhost:3000 to browse.

---

OpenMF - Flask Backend

Update Enviornment Variables

To run the project you need to update the following ENVIRONMENT VARIABLES.

export FLASK_APP="api"

export FLASK_ENV="development or production or testing"

SECRET_KEY="your secret key"

MAIL_USERNAME= "< Enter Mail User Name />"

MAIL_PASSWORD= "< Enter Mail App Password />"

MAIL_SERVER="< Enter Mail Server />"

MAIL_PORT="< Enter Mail Port Number />"

Running the Flask Server

Step 1: Set up FLASK_APP (For Linux or Mac)

(venv) $ `export FLASK_APP=api`

(For Windows)

(venv) $ `set FLASK_APP=api`

Step 2: Now, Upgrade the Migrated Database, using the following command

(venv) $ flask db upgrade

Step 3:Start the backend server To run the server use the following command:

(venv) $ flask run

API Endpoints List