Merge pull request #32 from jrsmth/feature/initial-release/main

Feature/initial release/main
jrsmth · Dec 9, 2023 · f8ffbde · f8ffbde
2 parents 7a74d10 + b6c1c52
commit f8ffbde
Show file tree

Hide file tree

Showing 10 changed files with 27 additions and 11 deletions.
diff --git a/.gitignore b/.gitignore
@@ -15,7 +15,7 @@ build/
 .cache/
 .pytest_cache/
 .idea/
-docs/_build/
+documentation/_build/
 .vscode
 
 # Coverage reports

diff --git a/README.md b/README.md
@@ -5,8 +5,7 @@
 # <img src="./src/resources/static/img/badge.png" width="28" alt="Logo"> Ultima
 [ultima.jrsmth.io](https://www.ultima.jrsmth.io)
 
-<img width="1440" alt="Ultima Game Play" src="https://github.com/jrsmth/ultima/assets/34093915/c847db7d-8b72-4614-b3fc-7219e95c3bf5">
-<!-- TODO :: Replace with .GIF -->
+![ultima_demo](https://github.com/jrsmth/ultima/assets/34093915/701a547e-66ab-4178-9da1-cb5ae9654166)
 
 ## Explanation
 - ⭕ Each square contains a smaller game of Tic-Tac-Toe

diff --git a/CHANGELOG.md → documentation/CHANGELOG.md b/CHANGELOG.md → documentation/CHANGELOG.md
@@ -23,6 +23,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 # Releases
 <!-- @LatestFirst -->
 
+## [1.0.0] - 09/12/23
+- UMA-46: Address security vulnerabilities
+- UMA-59: [BUG] Address deployment issue caused by missing .git/.project-root (`from-root` lib)
+- UMA-60: Add .gif to README
+- UMA-61: Create architecture diagram
+
 ## [0.7.1] - 08/12/23
 - UMA-55: Fix the test step in the GitHub Actions workflow
 - UMA-56: Add tests for admin and login blueprint
@@ -117,4 +123,5 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 [0.6.0]: https://github.com/jrsmth/ultima/compare/0.5.3...0.6.0
 [0.6.1]: https://github.com/jrsmth/ultima/compare/0.6.0...0.6.1
 [0.7.0]: https://github.com/jrsmth/ultima/compare/0.6.1...0.7.0
-[0.7.1]: https://github.com/jrsmth/ultima/compare/0.7.0...0.7.1
+[0.7.1]: https://github.com/jrsmth/ultima/compare/0.7.0...0.7.1
+[1.0.0]: https://github.com/jrsmth/ultima/compare/0.7.1...1.0.0
diff --git a/documentation/README.md b/documentation/README.md
@@ -0,0 +1,10 @@
+[![jhc github](https://img.shields.io/badge/GitHub-jrsmth-181717.svg?style=flat&logo=github)](https://github.com/jrsmth)
+
+# <img src="../src/resources/static/img/badge.png" width="28" alt="Logo"> Documentation
+
+## Architecture
+<img width="1275" alt="Ultima Architecture" src="./ultima_architecture.png">
+
+## Version
+- 📋 [changelog.md](./CHANGELOG.md)
+
diff --git a/documentation/ultima_architecture.png b/documentation/ultima_architecture.png
diff --git a/documentation/ultima_demo.gif b/documentation/ultima_demo.gif
diff --git a/src/.project-root b/src/.project-root
diff --git a/src/app/app.py b/src/app/app.py
@@ -14,8 +14,8 @@
 
 
 # Initialise app
-templates = from_root("src", "resources", "templates")
-statics = from_root("src", "resources", "static")
+templates = from_root("resources", "templates")
+statics = from_root("resources", "static")
 app = Flask(__name__, template_folder=templates, static_folder=statics)
 socketio = SocketIO(app)
 auth = HTTPBasicAuth()
@@ -41,7 +41,7 @@
 
 
 # Initialise message bundle
-messages = Messages(from_root('src', 'resources', 'messages.properties'))
+messages = Messages(from_root('resources', 'messages.properties'))
 
 
 # Register routes

diff --git a/src/app/requirements.txt b/src/app/requirements.txt
@@ -3,9 +3,9 @@ Gunicorn~=21.2.0
 Redis~=5.0.1
 Flask_redis
 pyjavaproperties~=0.7
-pip~=20.2.4
+pip~=23.3
 argparse~=1.4.0
-wheel~=0.35.1
+wheel~=0.38.1
 pytest~=7.4.2
 MarkupSafe~=2.1.3
 werkzeug~=3.0.0
@@ -14,7 +14,7 @@ Jinja2~=3.1.2
 blinker~=1.6.3
 itsdangerous~=2.1.2
 packaging~=23.2
-setuptools~=50.3.2
+setuptools~=65.5.1
 zipp~=3.17.0
 gevent
 flask_socketio

diff --git a/src/version/version.py b/src/version/version.py
@@ -1 +1 @@
-__version__ = "0.7.2-SNAPSHOT"
+__version__ = "1.0.0-SNAPSHOT"