diff --git a/.env.sample b/.env.sample new file mode 100644 index 0000000000000000000000000000000000000000..5288e19ee8b46999d106003b38c80951103e21ac --- /dev/null +++ b/.env.sample @@ -0,0 +1,3 @@ +RESTART=no +APP_DEBUG=false +DEV_PORT=5000 diff --git a/Readme.md b/Readme.md index 469192c2c33d7b84a2bfe409d336c9153d7f0fbd..0ffffed1af696c87a019c376fb2bcfac1e020ba0 100644 --- a/Readme.md +++ b/Readme.md @@ -1,8 +1,18 @@ # Unl2Rdf + A serialization converter from the official UNL format to the proposed RDF-UNL format. -This is a one page [flask](https://flask.palletsprojects.com) app to convert unl to rdf, the web app is full python, everything is in the file `src/app/app.py`. +## How to use -The display rendering uses the templates in the directory `src/app/templates` see [flakes templating](https://flask.palletsprojects.com/en/1.1.x/quickstart/#rendering-templates). +```bash +cp .env.sample .env +docker-compose up +``` + +Then open in a browser `http://localhost:5000` +## Developpement +This is a one page [flask](https://flask.palletsprojects.com) app to convert unl to rdf, the web app is full python, everything is in the file `src/app/app.py`. + +The display rendering uses the templates in the directory `src/app/templates` see [flakes templating](https://flask.palletsprojects.com/en/1.1.x/quickstart/#rendering-templates).