diff --git a/README.md b/README.md index dcee5c4..6780181 100644 --- a/README.md +++ b/README.md @@ -25,4 +25,40 @@ src/components/(chartComponents.tsx, dropDownComponents.tsx, tableComponents.tsx(only if needed, else delete)), src/context(querycontent.tsx), src/QueryOptions(apiQueryOptions.tsx, dataTypes.tsx). -``` \ No newline at end of file +``` + +### How to upload quote to the database + +* Step 1: Open the server folder source, create the /archives file as in the image below. +![alt text](readmeimg/5.png) +* Step 2: After creating the archives folder, paste your zip files containing the quotes to be ingested inside the +* /archives folder, as in the image below. +![alt text](readmeimg/6.png) +* Step 3: The format for each quotes file should be as in the example file below, this is just a test file as directed to use a * * test file for configuring. If a real sample file available for use, drop it and i will reconfigure the pipeline to the format. +![alt text](readmeimg/7.png) +* Step 4: On the command interface, navigate to the server folder ((venv) samman@samman:~/Documents/My_CodeBase/Quote_Plotter_App/* Quote_Manager_server$) this is my example CI, might be diffferent on a windows. check the image below for example. +* Then run the code "python3 batch_ingest.py" to activate the ingestion. +![alt text](readmeimg/8.png) +* Step 5: You get a success message on CI. +* INFO:quote_db:Quotes inserted successfully for session 20_test2 (2004 quotes) +* INFO:ingest:Ingestion completed for archive file: 02.07.2025_10.07.2025 +* Ignore "Skipping empty row: {'Ts': '', 'Bid': '', 'Ask': '', 'Type': ''}" error for now. it ingests the quotes nonetheless, +* though i am working on clearing the error which i think stems from me editing the original excel file in other to add the type +* column. +![alt text](readmeimg/9.png) + +* Note: confirm that the excel file format is same as in the example. CHeck excel file ? Same format : send sample to reconfigure. + +### How to run the Application + +* Step 1: Run the apps (front end and backend) +![alt text](readmeimg/1.png) +* Step 2: This image shows the prompt to start the backend app +![alt text](readmeimg/2.png) +* Step 3: This image shows the prompt to start the frontend app, then follow the link http://127.0.0.1:8000 to open in browser +![alt text](readmeimg/3.png) +* Step 3: This is the initial view for the app on your browser +![alt text](readmeimg/4.png) +* Step 4: This is the chart view after selecting brokers and symbols + + diff --git a/readmeimg/1.png b/readmeimg/1.png new file mode 100644 index 0000000..0e323a6 Binary files /dev/null and b/readmeimg/1.png differ diff --git a/readmeimg/2.png b/readmeimg/2.png new file mode 100644 index 0000000..477664b Binary files /dev/null and b/readmeimg/2.png differ diff --git a/readmeimg/3.png b/readmeimg/3.png new file mode 100644 index 0000000..8c8ace0 Binary files /dev/null and b/readmeimg/3.png differ diff --git a/readmeimg/4.png b/readmeimg/4.png new file mode 100644 index 0000000..8419b1e Binary files /dev/null and b/readmeimg/4.png differ diff --git a/readmeimg/5.png b/readmeimg/5.png new file mode 100644 index 0000000..d2c40a1 Binary files /dev/null and b/readmeimg/5.png differ diff --git a/readmeimg/6.png b/readmeimg/6.png new file mode 100644 index 0000000..3a52433 Binary files /dev/null and b/readmeimg/6.png differ diff --git a/readmeimg/7.png b/readmeimg/7.png new file mode 100644 index 0000000..5fc00b3 Binary files /dev/null and b/readmeimg/7.png differ diff --git a/readmeimg/8.png b/readmeimg/8.png new file mode 100644 index 0000000..46cd74c Binary files /dev/null and b/readmeimg/8.png differ diff --git a/readmeimg/9.png b/readmeimg/9.png new file mode 100644 index 0000000..b3ae662 Binary files /dev/null and b/readmeimg/9.png differ