BramVanroy/astred-demo

Demo app to illustrate ASTrED

ASTrED demo

The demo is currently running at https://lt3.ugent.be/astred-demo/. This repository gives you the tools to adapt the code or run the demo yourself.

API installation

The API runs on FastAPI (Python) to provide an easy access point for the demo. The Python dependencies can be installed with pip (but preferably in its own environment).

• fastapi
• uvicorn
• astred[parsers]
• git+https://github.com/BramVanroy/awesome-align.git@astred_compat

Install language models

By default, the API assumes that English, French, Dutch, and German models are installed. You can change the languages variables as you wish. The front-end will pick up this change accordingly. The language models need to be installed, though. So to install the default models you can run the attached bash script in in the astred-demo-api directory.

sh install-default-models.sh

To start the API server, run the following command in the astred-demo-api/src directory. This may take a while to load all the models.

uvicorn main:app --reload --port 5000

You can change the port, but make sure that you verify that the end points are correct in astred-demo-frontend/src/constants.js.

Available scripts in the front-end directory

In the project directory, you can run:

npm install

to install all the required dependencies for development. This is needed before you can run the following commands.

npm start

Runs the app in the development mode (not necessary for production). Open http://localhost:3000 to view it in the browser.

The page will reload if you make edits.
You will also see any lint errors in the console.

npm run build

Builds the app for production to the build folder. It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes. Your app is ready to be deployed!

See the section about deployment for more information on how best to deploy the front-end app.

Important notes before making app available online

• Make sure to adapt CORS in astred-demo-api/src/main.py to your needs. By default it accepts everything (useful for local development) but that is likely not what you want. You probably want to restrict access to the same server that the front-end is running off. See the FastAPI documentation for more.
• Make sure that the end points in astred-demo-frontend/src/constants.js are correct. Change the domain (localhost) and ports to your set up.