Merge pull request #83 from oslabs-beta/readme

docs: Create the first version of README.md

README.md

@@ -1,20 +1,49 @@
 # TrailGuide
 
-## Getting Started:
+[TrailGuide](https://oslabs-beta.github.io/TrailGuideIO/) is a open source AWS cloud security solution for developers who need their cloud security reassured.
 
-1. First clone this repository:
+We built TrailGuide because we are passionate in solving the data overloading problem in the cloud. Join us!
 
-   `git clone https://github.com/oslabs-beta/TrailGuide`
+- Track key management events: Quickly view events related to creating, modifying, or deleting AWS resources.
+- Visualize CloudTrail data: Present data in easy-to-read formats, such as pie charts for event distribution and heatmaps for geographical IP access.
+- Analyze recent events based on various criteria, such as IP addresses, event types, associated users, and timestamps.
 
-2. Install [Docker](https://docs.docker.com/get-started/get-docker/) if it is not installed already
-3. Run the following commands from within the TrailGuide directory to deploy the app to a docker container
+Every single part is fully open source! Fork it, extend it, or deploy it to your own server.
 
-   `docker build -t trailguide .`
+<img src="./readmeAssets//trailguide-readme-main.webp" alt="List View Screenshot" width="500">
 
-   `docker run -d --name TrailGuide -p 8080:8080 trailguide`
-<!-- 
-4. (To Run in Development Mode)
+# Installation and Spin-Up
 
-   `docker build -t trailguide-dev --target dev .`
+- Make sure you have docker installed
+- Create your compose.yml file
+  - (see our starter version in [Docker Hub](https://hub.docker.com/r/trailguide/trailguide-prod), or copy the one from this repo )
+- run `docker compose up` on the command line
 
-   `docker run -it --name trailguide-dev -p 8080:8080 trailguide-dev` -->
+# Getting Start:
+
+1. Use the signup link to create user
+
+<img src="./readmeAssets/sign-up.png" alt="List View Screenshot" width="500">
+
+2. Login
+
+<img src="./readmeAssets/log-in.png" alt="List View Screenshot" width="500">
+
+3. Copy paste the aws credentials in the fields in the profile
+
+<img src="./readmeAssets/aws-credential.png" alt="List View Screenshot" width="500">
+
+## Shoutouts :tada:
+
+Omnivore takes advantage of some great open source software:
+
+- [TypeScript](https://www.typescriptlang.org/) - Most of our backend and frontend are written in TypeScript.
+- [PostgreSQL](https://www.postgresql.org/)- For managing complex queries and storing event data, PostgreSQL is our go-to. Its reliability and performance are key to managing and analyzing extensive data, enhancing the robustness of our monitoring and analytics features.
+- [Docker](https://www.docker.com/)- Thanks to Docker, deploying our platform is seamless and consistent, whether locally or on the cloud. Docker allows us to containerize our ML models and backend services, ensuring reliable and scalable performance for our users.
+- [AWS](https://aws.amazon.com/)- AWS forms the backbone of TrailGuide, providing the infrastructure and data streams that allow us to offer real-time monitoring and security insights for AWS environments. CloudTrail logs enable us to dive deep into user activity and detect anomalies as they happen.
+- [Scikit-learn](https://scikit-learn.org/)- TrailGuide’s anomaly detection thrives with Scikit-learn's Isolation Forest, enabling real-time detection of unusual activity in CloudTrail logs with efficiency and accuracy.
+- And many more awesome libraries, just checkout our package files to see what we are using.
+
+## Requirements for development
+
+TraildeGuide is written in TypeScript and JavaScript.