From 926003c6b4b12edf4d93530053d271373bf09f28 Mon Sep 17 00:00:00 2001 From: Derek Holloway Date: Tue, 17 Feb 2026 20:22:09 -0800 Subject: [PATCH] Add README --- README.MD | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) create mode 100644 README.MD diff --git a/README.MD b/README.MD new file mode 100644 index 00000000..615ae283 --- /dev/null +++ b/README.MD @@ -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). \ No newline at end of file