From b616f19e423ffbe9f0a12a2353b70c3aa76e5dc5 Mon Sep 17 00:00:00 2001
From: Peyton Kelly <pkelly5511@gmail.com>
Date: Mon, 5 Feb 2024 13:44:17 -0500
Subject: [PATCH] Update Readme

---
 .../Admin/__pycache__/settings.cpython-39.pyc | Bin 2653 -> 2653 bytes
 Admin/db.sqlite3                              | Bin 200704 -> 200704 bytes
 README.md                                     |  98 +++++++++++++++++-
 3 files changed, 93 insertions(+), 5 deletions(-)

diff --git a/Admin/Admin/__pycache__/settings.cpython-39.pyc b/Admin/Admin/__pycache__/settings.cpython-39.pyc
index cb4d5071610a4f28fd39fc6687e72f720db45b8f..81988af7462e31f44356973adca27323fa53904f 100644
GIT binary patch
delta 19
ZcmcaBa#w^ak(ZZ?0SJz1Y~%{&0st~(1b6@d

delta 19
ZcmcaBa#w^ak(ZZ?0SL-eH*y7Y0RS*{1SJ3f

diff --git a/Admin/db.sqlite3 b/Admin/db.sqlite3
index be6828ccf015c00922430a9d3a45c732b16ed834..f960237d3ccd7be82c8420c090a9f2017db11de0 100644
GIT binary patch
delta 72
zcmZozz|*jRXM!|i%|sbz#+r=@r}P*Nnzi-Ywe=aNYwI)JWH#Vpp3ZK-6wAV;%*DL1
ZaW*HDoWXQgD<*kHeK57%#foXqRRH!e6Y2l}

delta 52
zcmZozz|*jRXM!|i)kGO*#;T18r}P;0nzi-Ywe=aNYwI)JWY*(yp3ZK-6uYtUKIe94
IE2h0y0liHTIsgCw

diff --git a/README.md b/README.md
index 0008481e..cbf87fd5 100644
--- a/README.md
+++ b/README.md
@@ -2,7 +2,7 @@
 
 ## Overview
 
-> This project is a Django application that provides a simple way to control who is accessing your database information. With tools that track suspiscous login attempts a administrator would be able to secure the site and files to protect against losses.  
+> This project is a Django application that provides a simple way to control who is accessing your database information. With tools that track suspiscous login attempts a administrator would be able to secure the site and files to protect against losses. 
 
 ## Table of Contents
 
@@ -28,8 +28,10 @@ List and briefly describe the key features of your project. This can include:
 
 + **IP Honeypot tracker:** How users' IP addresses are used for authentication.
 + **Database Protection:** Measures taken to secure databases.
-+ **RSA Encryption logic**
-+ **Uploading files to database**
++ **IP Authentication:** Filtered IP specific access to the site.
++ **Uploading files to database** For usage of the site.
++ **Admin Dashboard:** For the admin to manage the site and users.
++ **Web Traffic Monitoring:**  To track suspicious login attempts and database views.
 
 ## DATA
 
@@ -42,6 +44,92 @@ While developing this project, we reviewed existing solutions in the realm of IP
 
 ## Installation
 
-MySQL and MYSQL workbench are used in this project. Once those are downloaded properly. Find the local instance and connect to the server. From there create a new database called 'incominguser' with the password that is set in the Settings.py file of the project repository. Once the database is created, open the terminal, Cd to the projects directory. Outside of the virt folder run 'source virt/Scripts/activate'
-Once in the repository, be in the Admin folder which has manage.py in the directory. Run 'python manage.py makemigrations' then 'python manage.py migrate' this should create the local instances of the schemas used, if no errors run 'python manage.py runserver'. This will start the local server for the site to be displayed. 
+To install the project, follow these steps:
+
+1. Clone the repository to your local machine:
+
+```bash
+git clone ...
+```
+
+2. Once in the Peyton_Kelly_Artifact, start the virtual environment:
+
+```bash
+source venv/bin/activate
+```
+
+3. Install the project dependencies:
+
+```bash
+pip install -r requirements.txt
+```
+
+4. Change Directory to Admin, Create a superuser:
+
+```bash
+cd Admin
+python manage.py createsuperuser
+```
+
+5. Check for migrations:
+
+```bash
+python manage.py makemigrations
+python manage.py migrate
+```
+
+
+5. Run the project locally:
+
+```bash
+python manage.py runserver
+```
+
+6. Open your web browser and navigate to the following URL:
+
+```bash
+http://127.0.0.1:8000/
+```
+
+USING DOCKER:
+
+1. Clone the repository to your local machine:
+
+```bash
+git clone ...
+```
+
+2. Once in the Peyton_Kelly_Artifact, start the virtual environment:
+
+```bash
+source venv/bin/activate
+```
+
+3. Where the Dockerfile is located, build the docker image:
+
+```bash
+docker-compose build
+```
+
+4. Run the docker image:
+
+```bash
+docker-compose up
+```
+
+5. Open your web browser and navigate to the following URL:
+
+```bash
+http://0.0.0.0:8000
+or localhost:8000
+```
+
+## Conclusion
+
+
+
+
+
+
+