harismalik01 commited on
Commit
8dc04cf
·
verified ·
1 Parent(s): d5870fc

Delete DOCKER_README.md

Browse files
Files changed (1) hide show
  1. DOCKER_README.md +0 -73
DOCKER_README.md DELETED
@@ -1,73 +0,0 @@
1
- ---
2
- title: CodeBuddy AI
3
- emoji: 👨‍💻
4
- colorFrom: indigo
5
- colorTo: purple
6
- sdk: streamlit
7
- sdk_version: 1.32.0
8
- app_file: app.py
9
- pinned: false
10
- python_version: "3.10"
11
- app_port: 8501
12
- ---
13
-
14
- # CodeBuddy AI
15
-
16
- An advanced AI coding assistant powered by Gemini 2.0, built with Streamlit and LangChain.
17
-
18
- ## Features
19
- - Modern, responsive UI with dark theme
20
- - Code-specific assistance and debugging
21
- - Interactive chat interface
22
- - Mobile-friendly design
23
-
24
- ## Environment Setup
25
- This app requires the following environment variable:
26
- - `GOOGLE_API_KEY`: Your Google API key for Gemini access
27
-
28
- Create a `.env` file in the project root with:
29
- ```
30
- GOOGLE_API_KEY=your_api_key_here
31
- ```
32
-
33
- ## Docker Deployment
34
-
35
- ### Option 1: Using Docker Compose (Recommended)
36
-
37
- 1. Make sure you have Docker and Docker Compose installed
38
- 2. Create a `.env` file with your Google API key
39
- 3. Run the application:
40
- ```bash
41
- docker-compose up -d
42
- ```
43
- 4. Access the application at http://localhost:8501
44
-
45
- ### Option 2: Using Docker Directly
46
-
47
- 1. Build the Docker image:
48
- ```bash
49
- docker build -t codebuddy-ai .
50
- ```
51
- 2. Run the container:
52
- ```bash
53
- docker run -p 8501:8501 --env-file .env -d codebuddy-ai
54
- ```
55
- 3. Access the application at http://localhost:8501
56
-
57
- ## Local Development Setup
58
-
59
- 1. Install dependencies:
60
- ```bash
61
- pip install -r requirements.txt
62
- ```
63
- 2. Create a `.env` file with your Google API key
64
- 3. Run the application:
65
- ```bash
66
- streamlit run app.py
67
- ```
68
- 4. Access the application at http://localhost:8501
69
-
70
- ## Deployment Notes
71
- - The app is configured to run on Hugging Face Spaces
72
- - The app will automatically use the correct port (8501) and host settings
73
- - The Docker configuration includes health checks to ensure availability