Add README

2026-02-17 20:22:09 -08:00
parent c0fd27da07
commit 926003c6b4
1 changed files with 30 additions and 0 deletions
@@ -0,0 +1,30 @@
+# AI - Stock Trader
+Overview of the directories
+
+```bash
+./                   # Docker Files
+├── data             # Local debugging data folder
+└── WebServer        # The ASP.NET Core 9 Webserver
+    ├── AIPython     # All the AI files written in python [Copied to the docker container via the C# compiler]
+    ├── Components   # HTML pages written in .razor pages
+    ├── Controllers  # Python Interop Controllers and Database Controlelrs
+    ├── Properties   # ASP.Net Properties files
+    └── wwwroot      # Statically hosted Web Files
+```
+
+## Installation
+How to host a local copy
+
+```bash
+# Pull the files using git
+git clone git@gitlab.com:wgu-gitlab-environment/student-repos/dhol325/d683-advanced-ai-and-ml.git
+
+# Enter the working directory
+cd ./d683-advanced-ai-and-ml
+
+# use docker compose to bring everything up
+docker compose up -d
+```
+
+## Usage
+Navigate to [Localhost:5000](http://localhost:5000).