diff --git a/.gitignore b/.gitignore index 8c646f2..2e0ebf8 100644 --- 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 index b4a4a8d..6e04861 100644 --- a/README.md +++ b/README.md @@ -5,8 +5,7 @@ # Logo Ultima [ultima.jrsmth.io](https://www.ultima.jrsmth.io) -Ultima Game Play - +![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 b/documentation/CHANGELOG.md similarity index 92% rename from CHANGELOG.md rename to documentation/CHANGELOG.md index 15febda..db671bd 100644 --- a/CHANGELOG.md +++ b/documentation/CHANGELOG.md @@ -23,6 +23,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 # Releases +## [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 \ No newline at end of file +[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 \ No newline at end of file diff --git a/documentation/README.md b/documentation/README.md new file mode 100644 index 0000000..b0ba0dc --- /dev/null +++ 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) + +# Logo Documentation + +## Architecture +Ultima Architecture + +## Version +- 📋 [changelog.md](./CHANGELOG.md) + diff --git a/documentation/ultima_architecture.png b/documentation/ultima_architecture.png new file mode 100644 index 0000000..29dd744 Binary files /dev/null and b/documentation/ultima_architecture.png differ diff --git a/documentation/ultima_demo.gif b/documentation/ultima_demo.gif new file mode 100644 index 0000000..8333bd0 Binary files /dev/null and b/documentation/ultima_demo.gif differ diff --git a/src/.project-root b/src/.project-root new file mode 100644 index 0000000..e69de29 diff --git a/src/app/app.py b/src/app/app.py index cdcd6b1..b96173c 100644 --- 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 index 502a1e7..7151738 100644 --- 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 index 721faeb..20a1248 100644 --- a/src/version/version.py +++ b/src/version/version.py @@ -1 +1 @@ -__version__ = "0.7.2-SNAPSHOT" \ No newline at end of file +__version__ = "1.0.0-SNAPSHOT" \ No newline at end of file