ayush2917 commited on
Commit
9dea693
·
verified ·
1 Parent(s): 01d7a5e

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +31 -19
README.md CHANGED
@@ -1,24 +1,36 @@
1
- # India News Fetcher on Hugging Face Spaces
 
 
 
 
 
 
 
2
 
3
- This Flask app fetches finance-related news, generates descriptions using AWS Bedrock, and serves a simple frontend.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
4
 
5
- ## Setup for Testing
6
  1. **Create a Space**:
7
  - Go to [Hugging Face Spaces](https://huggingface.co/spaces).
8
- - Create a new Space (e.g., `india-news-tester`), select "Docker" SDK.
9
- 2. **Upload Files**:
10
- - Clone the repo: `git clone https://<their-username>-<space-name>.hf.space`.
11
- - Copy `app.py`, `Dockerfile`, `requirements.txt`, `static/index.html`, `README.md`.
12
- - Push: `git add . && git commit -m "Initial setup" && git push`.
13
- 3. **Set Environment Variables**:
14
- - In Space settings, add `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY`, `AWS_REGION`.
15
- 4. **Test**:
16
- - Visit `https://<their-username>-<space-name>.hf.space`.
17
- - If you see "Your Space has encountered a config error," check logs and ensure YAML in `README.md` is correct.
18
-
19
- ## Notes
20
- - Requires AWS Bedrock access.
21
- - Frontend loads 2 articles per topic for testing.
22
- - Check build logs in the Space UI if it fails.
23
 
24
- Feedback welcome!
 
 
 
 
1
+ ---
2
+ title: India News Fetcher
3
+ emoji: 📰
4
+ colorFrom: blue
5
+ colorTo: green
6
+ sdk: docker
7
+ app_port: 7860
8
+ ---
9
 
10
+ # India News Fetcher
11
+
12
+ This Flask application fetches finance-related news from Indian websites and generates article descriptions using AWS Bedrock models. It includes a simple frontend for easy interaction and an API endpoint for programmatic access.
13
+
14
+ ## Features
15
+ - Fetches news on topics like Market trends, IPO, Cryptocurrency, etc.
16
+ - Generates concise 60-80 word descriptions using AWS Bedrock.
17
+ - Frontend with buttons to fetch news for all topics or specific ones.
18
+ - API endpoint for custom queries.
19
+
20
+ ## Prerequisites
21
+ - A Hugging Face account.
22
+ - An AWS account with Bedrock access and valid credentials.
23
+ - Git installed locally (optional, for manual deployment).
24
+
25
+ ## Setup Instructions
26
+ Follow these steps to deploy and test the app on Hugging Face Spaces:
27
 
 
28
  1. **Create a Space**:
29
  - Go to [Hugging Face Spaces](https://huggingface.co/spaces).
30
+ - Click "Create new Space".
31
+ - Name it (e.g., `india-news-tester`), select "Docker" as the SDK, and set visibility (public or private).
 
 
 
 
 
 
 
 
 
 
 
 
 
32
 
33
+ 2. **Upload Files**:
34
+ - Clone the Space repository locally:
35
+ ```bash
36
+ git clone https://huggingface.co/spaces/<your-username>/<space-name>