joytheslothh commited on
Commit
b67be67
·
1 Parent(s): 52d6ced

Add professional README file with tech stack and setup instructions

Browse files
Files changed (1) hide show
  1. README.md +79 -1
README.md CHANGED
@@ -1 +1,79 @@
1
- # BacSense-2.0
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ # 🦠 Bacsense 2.0
2
+
3
+ ![Bacsense Banner](https://img.shields.io/badge/Bacsense-2.0-13a4ec?style=for-the-badge)
4
+
5
+ **Bacsense 2.0** is an open-access visual platform for clinical microbiology research. Our mission is to accelerate pathogen identification through advanced hybrid neural networks and machine learning.
6
+
7
+ This project integrates a robust **VGG16 + SVM** hybrid classification architecture with a modern, high-performance web interface to quickly and accurately identify microscopic bacterial species from uploaded culture images.
8
+
9
+ ## ✨ Key Features
10
+
11
+ - **🔬 High-Accuracy Classification:** Leverages a pre-trained VGG16 backbone for deep feature extraction, paired with a Support Vector Machine (SVM) classifier for pinpoint taxa identification.
12
+ - **⚡ Real-time API:** Fast and lightweight inference backend powered by FastAPI.
13
+ - **🌌 Premium Scientific UI:** A stunning, fully responsive dark-theme design featuring highly interactive GSAP spring cursors, meteor shower effects, and beautifully animated petri-dish data components.
14
+ - **📊 Detailed Analysis Metrics:** Get immediate clinical insights on morphological traits, probability distribution thresholds, and gram stains for tested pathogens natively in the browser.
15
+
16
+ ## 🛠️ Tech Stack
17
+
18
+ ### Frontend
19
+ - **Framework:** React + Vite (TypeScript)
20
+ - **Styling:** Tailwind CSS
21
+ - **Animations:** GSAP (GreenSock) & Framer Motion
22
+ - **UI Architecture:** MagicUI
23
+
24
+ ### Backend / ML Engine
25
+ - **REST API Runtime:** FastAPI & Uvicorn
26
+ - **Machine Learning Pipelines:** TensorFlow / Keras (VGG16), Scikit-Learn (SVM, PCA)
27
+ - **Image Processing Computation:** Pillow (PIL), NumPy, SciPy
28
+
29
+ ---
30
+
31
+ ## 🚀 Getting Started
32
+
33
+ ### Prerequisites
34
+ - [Node.js](https://nodejs.org/) (v16+)
35
+ - [Python](https://python.org/) (3.9+)
36
+
37
+ ### 1. Boot the ML Backend
38
+
39
+ Open a terminal in the project root and navigate to the backend service to spin up the prediction API:
40
+
41
+ ```bash
42
+ cd bacterial-classifier
43
+ python -m venv venv
44
+
45
+ # Windows Activation
46
+ venv\Scripts\activate
47
+ # Mac/Linux Activation
48
+ # source venv/bin/activate
49
+
50
+ pip install -r requirements.txt
51
+ pip install fastapi uvicorn python-multipart
52
+
53
+ # Start the FastAPI uvicorn server
54
+ uvicorn api:app --host 0.0.0.0 --port 5000 --reload
55
+ ```
56
+ The ML API will successfully bind to `http://localhost:5000`.
57
+
58
+ ### 2. Start the React Frontend
59
+
60
+ Open a new terminal tab, navigate to the frontend folder, install dependencies, and launch the Vite dev server:
61
+
62
+ ```bash
63
+ cd frontend
64
+ npm install
65
+ npm run dev
66
+ ```
67
+
68
+ The user interface will be live at `http://localhost:5173`. 🥳 Drag and drop a microscopic image into the Upload Zone to test the prediction model!
69
+
70
+ ## 🔬 Supported Species
71
+ The engine spans multiple common pathogenic datasets and correctly identifies critical bacteria including:
72
+ - *Escherichia coli* (Gram-negative)
73
+ - *Staphylococcus aureus* (Gram-positive)
74
+ - *Clostridium perfringens* (Anaerobic)
75
+ - *Bacillus cereus* (Spore-forming)
76
+ - *Listeria monocytogenes*
77
+
78
+ ---
79
+ *© 2026 Bacsense Scientific Systems. Built for Next-Gen Bioinformatics.*