Initial commit

project description, first architecture draft and small MVP roadmap
PERES-Richard · Apr 1, 2022 · 9353faa · 9353faa
commit 9353faa
Show file tree

Hide file tree

Showing 7 changed files with 55 additions and 0 deletions.
diff --git a/.gitattributes b/.gitattributes
@@ -0,0 +1,2 @@
+# Auto detect text files and perform LF normalization
+* text=auto
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,5 @@
+# env
+.env
+
+# IntelliJ
+.idea/
diff --git a/LICENSE b/LICENSE
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Richard Peres
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/README.md b/README.md
@@ -0,0 +1,16 @@
+# AWS Knapsack Microservices Project
+# Project Overview & Description
+The goal of this project is to create a Proof Of Concept (PoC) using different AWS services for a Knapsack greedy problem implementation.
+This implementation will follow an Microservices Event driven architecture to test simultaneously different types of algorithms implemented in different ways, languages and using different (AWS) technologies.
+For more information on the architecture, please refer to [the architecture page](architecture.md) that list all the different iteration and evolution of the architectural and solution design.
+
+Finally, this project should be able to be used and reproduced following an 'Open/Closed Principle' ([OCP](https://stackify.com/solid-design-open-closed-principle/)) with ability to easily add more algorithms and take advantage of logs and analytics data generated.
+It will also use modern CI/CD technologies (see the full list [below](#List-of-Technologies-&-services-used)) to automatically deploy, run and monitor each services/modules of the whole solution.
+
+# List of Technologies & services used
+* TBD  
+
+# RoadMap
+[] Create a simple generator of knapsack problems (list of items + bag size)  
+[] Create a first simple MVP of a naive solver  
+[] TBD  
diff --git a/architecture-diagrams/v0.1.png b/architecture-diagrams/v0.1.png
diff --git a/architecture.md b/architecture.md
@@ -0,0 +1,6 @@
+# v0.1 - 01/04/2022
+## Added
+- Identification of 'all' different services and modules involved
+## Changed
+## Removed
+![](architecture-diagrams/v0.1.png)
diff --git a/changelog.md b/changelog.md
@@ -0,0 +1,5 @@
+# v0.1 - 01/04/2022
+## Added
+- First draft of the architecture
+## Changed
+## Removed
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		# Auto detect text files and perform LF normalization
		* text=auto