diff --git a/README.md b/README.md index ee7a902a..fa25f4e9 100644 --- a/README.md +++ b/README.md @@ -68,42 +68,13 @@ If you want to report a problem or suggest an enhancement we'd love for you to [ Thank you very much for visiting our project repository. We hope you feel inspired and welcomed to test or even contribute to our online microbiome data analysis. - -## How can I generate the website locally? +## How can I run the website? The Project relies on Flask and Postgres. The detailed installation instructions are available [here](docs/deployment.md) +## How can I generate videos from slides? -## Generate videos - -### Requirements - -Ubuntu - -``` -$ sudo apt-get install sox -$ sudo apt-get install libsox-fmt-mp3 -``` - -#### Steps - -In different terminals: - -1. Launch MozillaTTS for speech - - ``` - $ docker run -it -p 5002:5002 synesthesiam/mozillatts - ``` - -2. Launch scripts - - ``` - $ conda activate dnanalyzer - $ ./bin/ari-make.sh - ``` - -You need to modify ``, e.g `./bin/ari-make.sh game/level1/intro/slides.md` - +The video generation relies on scripts in the folder `\bin`. The detailed installation instructions are available [here](docs/video_generation.md) ## Update quiz questions If changes are made to the quiz questions in yaml files under the folder `game` diff --git a/docs/database_relational_diagram.png b/docs/database_relational_diagram.png deleted file mode 100644 index 6acb68fb..00000000 Binary files a/docs/database_relational_diagram.png and /dev/null differ diff --git a/docs/diagrams/database_relational_diagram.drawio b/docs/diagrams/database_relational_diagram.drawio new file mode 100644 index 00000000..cfa6bc68 --- /dev/null +++ b/docs/diagrams/database_relational_diagram.drawio @@ -0,0 +1,663 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/diagrams/database_relational_diagram.png b/docs/diagrams/database_relational_diagram.png new file mode 100644 index 00000000..288b391e Binary files /dev/null and b/docs/diagrams/database_relational_diagram.png differ diff --git a/docs/diagrams/system_architecture_diagram.drawio b/docs/diagrams/system_architecture_diagram.drawio new file mode 100644 index 00000000..15faeca7 --- /dev/null +++ b/docs/diagrams/system_architecture_diagram.drawio @@ -0,0 +1,91 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/diagrams/system_architecture_diagram.png b/docs/diagrams/system_architecture_diagram.png new file mode 100644 index 00000000..58481633 Binary files /dev/null and b/docs/diagrams/system_architecture_diagram.png differ diff --git a/docs/system_architecture_diagram.png b/docs/system_architecture_diagram.png deleted file mode 100644 index cb98e227..00000000 Binary files a/docs/system_architecture_diagram.png and /dev/null differ diff --git a/docs/video_generation.md b/docs/video_generation.md new file mode 100644 index 00000000..b178510b --- /dev/null +++ b/docs/video_generation.md @@ -0,0 +1,29 @@ +## Generate videos + +### Requirements + +Ubuntu + +``` +$ sudo apt-get install sox +$ sudo apt-get install libsox-fmt-mp3 +``` + +### Steps + +In different terminals: + +1. Launch MozillaTTS for speech + + ``` + $ docker run -it -p 5002:5002 synesthesiam/mozillatts + ``` + +2. Launch scripts + + ``` + $ conda activate dnanalyzer + $ ./bin/ari-make.sh + ``` + +You need to modify ``, e.g `./bin/ari-make.sh game/level1/intro/slides.md` diff --git a/routes/main.py b/routes/main.py index 9665f4eb..d77719b7 100644 --- a/routes/main.py +++ b/routes/main.py @@ -15,6 +15,15 @@ WORKFLOW_URL = " https://usegalaxy.eu/training-material/topics/assembly/tutorials/general-introduction/workflows/assembly-general-introduction.ga" +@bp.route('/coming_soon', methods=['GET']) +def coming_soon(): + """ + Function to return coming soon page + @return: return to the coming soon page + @rtype: flask template + """ + return render_template("coming_soon.html") + @bp.route('/login', methods=['GET', 'POST']) def login(): """ diff --git a/static/images/undraw_under_construction.svg b/static/images/undraw_under_construction.svg new file mode 100644 index 00000000..ae18f5bc --- /dev/null +++ b/static/images/undraw_under_construction.svg @@ -0,0 +1 @@ +under construction \ No newline at end of file diff --git a/templates/coming_soon.html b/templates/coming_soon.html new file mode 100644 index 00000000..1f92e0e6 --- /dev/null +++ b/templates/coming_soon.html @@ -0,0 +1,16 @@ +{% extends 'base.html' %} + +{% block body %} + +
+
+

Coming soon!

+
+
+ +
+
+
+
+ +{% endblock %} \ No newline at end of file diff --git a/templates/index.html b/templates/index.html index 368441a2..7393b23a 100644 --- a/templates/index.html +++ b/templates/index.html @@ -84,7 +84,7 @@

Welcome to our online & interactive ga