decodingdatascience commited on
Commit
107707b
·
verified ·
1 Parent(s): af5e36b

Upload README.md

Browse files
Files changed (1) hide show
  1. README.md +56 -0
README.md ADDED
@@ -0,0 +1,56 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ title: DDS AI Project Assistant
3
+ emoji: 🤖
4
+ colorFrom: indigo
5
+ colorTo: green
6
+ sdk: gradio
7
+ sdk_version: 4.0.0
8
+ app_file: app.py
9
+ pinned: false
10
+ ---
11
+
12
+ # DDS AI Project Assistant
13
+
14
+ A Generative AI project assistant powered by OpenAI GPT.
15
+
16
+ ## Setup Instructions
17
+
18
+ ### Local Development
19
+ 1. Clone the repository
20
+ 2. Create a `.env` file with your OpenAI API key:
21
+ ```
22
+ OPENAI_API_KEY=your-api-key-here
23
+ ```
24
+ 3. Install dependencies:
25
+ ```
26
+ pip install -r requirements.txt
27
+ ```
28
+ 4. Run the app:
29
+ ```
30
+ python app.py
31
+ ```
32
+
33
+ ### Hugging Face Spaces Deployment
34
+ 1. Create a new Space on Hugging Face
35
+ 2. Choose "Gradio" as the SDK
36
+ 3. Add your OpenAI API key as a secret:
37
+ - Go to Settings > Repository Secrets
38
+ - Add `OPENAI_API_KEY` with your API key
39
+ 4. Upload the following files:
40
+ - app_hf.py (rename to app.py in Spaces)
41
+ - ai_wrapper.py
42
+ - requirements.txt
43
+
44
+ ## Features
45
+ - Interactive AI project brainstorming
46
+ - Code generation assistance
47
+ - 10 popular GenAI project templates
48
+ - Beautiful Gradio interface
49
+
50
+ ## Environment Variables
51
+ - `OPENAI_API_KEY`: Your OpenAI API key (required)
52
+
53
+ ## License
54
+ MIT License
55
+
56
+ Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference