@@ -23,12 +23,47 @@ An intelligent AI-powered assistant that integrates with Odoo ERP to provide nat
2323
2424### Prerequisites
2525
26+ ** For Docker (Recommended):**
27+ - Docker installed
28+ - Odoo ERP server (v14.0 or higher)
29+ - Google Cloud account for Gemini AI API
30+
31+ ** For Python Setup:**
2632- Python 3.8+
2733- Odoo ERP server (v14.0 or higher)
2834- Google Cloud account for Gemini AI API
2935
3036### Installation
3137
38+ #### 🐳 Docker (Recommended - Zero Dependency Hassles)
39+
40+ 1 . Clone the repository:
41+ ``` bash
42+ git clone https://github.com/Shamlan321/OdooSense.git
43+ cd OdooSense
44+ ```
45+
46+ 2 . Create your ` .env ` file:
47+ ``` env
48+ ODOO_URL=http://localhost:8068
49+ ODOO_DB=your_database_name
50+ ODOO_USERNAME=your_username
51+ ODOO_PASSWORD=your_password
52+ GEMINI_API_KEY=your_gemini_api_key
53+ ```
54+
55+ 3 . Run with Docker (one command, no setup):
56+ ``` bash
57+ # Quick start
58+ ./docker-run.sh
59+
60+ # Or manual
61+ docker build -t odoosense .
62+ docker run -i --rm --net=host --env-file .env odoosense
63+ ```
64+
65+ #### 🐍 Traditional Python Setup
66+
32671 . Clone the repository:
3368``` bash
3469git clone https://github.com/Shamlan321/OdooSense.git
@@ -53,6 +88,10 @@ GEMINI_API_KEY=your_gemini_api_key
5388
54891 . Start the assistant:
5590``` bash
91+ # Docker
92+ ./docker-run.sh
93+
94+ # Python
5695python odoosense.py
5796```
5897
@@ -98,13 +137,16 @@ The assistant recognizes different keywords for each module:
98137
99138### Project Structure
100139```
101- odoo-ai-assistant/
102- ├── odoosense.py # Main integration file
103- ├── odoo_inspector.py # Module inspection tool
104- ├── module_access_test.py # Access testing utility
105- ├── requirements.txt # Python dependencies
106- ├── .env # Environment configuration
107- └── README.md # Documentation
140+ OdooSense/
141+ ├── odoosense.py # Main integration file
142+ ├── odoo_inspector.py # Module inspection tool
143+ ├── module_access_test.py # Access testing utility
144+ ├── requirements.txt # Python dependencies
145+ ├── Dockerfile # Docker container setup
146+ ├── docker-run.sh # Docker convenience script
147+ ├── .dockerignore # Docker build exclusions
148+ ├── .env # Environment configuration
149+ └── README.md # Documentation
108150```
109151
110152### Adding New Features
0 commit comments