An innovative News Feed Analyzer Agent which provides comprehensive summaries of the latest news from many News Outlets based on User Interests, leveraging open-source LLMs, ScrapeGraph AI, Spheron and tools like LangChain ️🔥
- Demo
- Features
- Prerequisites
- Steps to Run
- Deploy on Spheron
- Project structure
- Contributing
- Acknowledgments
- License
The Server and Ollama Llama3 was deployed on Spheron when this demo video was shot.
An News Feed Analyzer Agent that can:
- 🗞️ Aggregate news from 14+ sources.
- 🔍 Analyze content from 60+ interests choosed by user.
- 📝 Concise and comprehensive summaries of the latest news.
- 📧 Email subscriptions with customizable frequency.
- 🔖 Bookmark news for later read.
You should have
- Node v20.16.0 or higher
- Python 3.11 or higher
- MongoDB Atlas Connection URL
- Google App Password for SMTP
- Ollama Llama3
Navigate to the Project Directory: Change to the directory where the project files are located. For example:
cd path/to/project/directory-
Install dependencies
bun install # or npm install -
Configure environment variables
- Copy
.env.exampleto.env. - Fill in the
.envfile with the necessary environment variables.
- Copy
-
Start the app
bunx expo start # or npx expo start
In the output, you'll find options to open the app in a
- Development build
- Android emulator
- iOS simulator
- Expo Go, a limited sandbox for trying out app development with Expo
This project uses file-based routing.
-
Change the directory
cd server -
Create a virtual environment.
python3 virtualenv venv
-
Activate the virtual environment.
source ./venv/bin/activate -
Install dependencies from
requirements.txtpip install -r requirements.txt
-
Configure environment variables
- Copy
.env.exampleto.env. - Fill in the
.envfile with the necessary environment variables.
- Copy
-
Start the server
fastapi dev main.py --reload --port 8000 # or for production, fastapi run main.py --port 8000
Note
Ollama should be running locally before you start the server!
Here I will help you to deploy Server and Ollama on Spheron using Spheron Protocol CLI 💪
You should have this before you start deploying on Spheron:
curl -sL1 https://sphnctl.sh | bashAfter installation, verify the installation by using a simple command to check the Spheron version:
sphnctl version # or `sphnctl -h` for helpsphnctl wallet create --name <your-wallet-name>Replace <your-wallet-name> with your desired wallet name. Here is an example of how the result will look:
Created account xxx:
path: /home/thatsmeadarsh/.spheron/<your-wallet-name>.json
address: 0x3683Ae6bd8f23DEb35f79A750EA0a7e6fc858047
secret: xxxxxxxxxx
mnemonic: xxxxxx xxxxx xxxx xxxxx xxxxx xxxx xxxxx xxxxxMake sure to securely save the mnemonic phrase and key secret provided.
You will need some token to deploy on Spheron. Visit the Spheron Faucet to obtain test tokens for deployment. After receiving the tokens, you can check your wallet balance with:
sphnctl wallet balance --token USDTHere is an example of how the result will look:
Current ETH balance: 0.09993387282
Total USDT balance: 35
Deposited USDT balance
unlocked: 14.030481
locked: 4e-06 Note: You might have unlocked or locked USDT balance as 0 but here I don't because I have previously deployed on Spheron. Don't worry, in next step I have covered that 😋.
Deposit USDT to your escrow wallet for deployment:
sphnctl payment deposit --amount 20 --token USDTNow check your balance, if it's unlocked and sufficient (just like mine above):
sphnctl wallet balance --token USDTI have already created a docker image for you so you can directly head towards to deployment without worrying 😉.
In the project directory, navigate to server/:
cd serverOpen deploy.yml in a code editor and fill the environmental variables:
- MONGO_CONNECTION_URL=
- DATABASE_NAME=
- JWT_SECRET_KEY=
- JWT_REFRESH_SECRET_KEY=
- ACCESS_TOKEN_EXPIRE_MINUTES=
- REFRESH_TOKEN_EXPIRE_MINUTES=
- ALGORITHM=
- SMTP_SERVER=
- SMTP_PORT=
- SMTP_USERNAME=
- SMTP_PASSWORD=And deploy the deploy.yml configuration file on Spheron:
sphnctl deployment create deploy.ymlHere is an example of how the result will look:
Validating SDL configuration.
SDL validated.
Sending configuration for provider matching.
Create deployment tx: [Tx Hash]
Waiting for providers to bid on the deployment order...
Bid found.
Order matched successfully.
Deployment created using wallet 0x3683Ae6bd8f23DEb35f79A750EA0a7e6fc858047
lid: 389
provider: 0x6634d41cccBD1E1576Ed4c6226832521A66bF874
agreed price: 0.74
Sending the manifest for deployment…
Deployment manifest sent, waiting for acknowledgment.
Deployment is finished.Note: The lid we get from the deployment is called Lease ID. This is the identifier you need to use to access your deployment's logs and status.
Now, Congratulations!! You have deployed the Server and Ollama on Spheron successfully 🥳🥳.
To get details about your deployment, including the URL, ports, and status, run:
sphnctl deployment get --lid <lease-id>Replace the <lease-id> with your actual Lease ID, you obtained after deployment.
├── app/ # Main application
│ ├── email-subscription/ # Email subscription screen
│ ├── interest/ # News Interest screen
│ ├── news-outlet/ # News Outlet screen
│ ├── login/ # Login screen
│ ├── register/ # Register screen
│ ├── news/ # News screen (dynamic)
│ ├── (tabs)/ # Screens those are on Navigation Tab
│ ├── index.tsx # Home screen
│ ├── bookmark/ # Bookmark screen
│ └── settings/ # Settings screen
├── assets/ # Assets like fonts and images
│ ├── fonts/ # Font files
│ └── images/ # Image and Icon files
├── components/ # Reusable components
│ ├── auth/ # Authentication components
│ ├── button/ # Button components
│ ├── common/ # Common components
│ ├── form/ # Form-related components
│ └── sections/ # Section components
├── constants/ # Constant values
├── hooks/ # Custom hooks
├── server/ # SERVER (BACKEND)
├── service/ # Services for API calls
│ ├── auth/ # Authentication services
│ ├── email-subscription/ # Email subscription services
│ └── news/ # News services
├── utils/ # Utility functions
├── .env.example # Example environment variables
└── .gitignore # Git ignore rules├── app/ # Main application folder
│ ├── auth/ # Authentication module
│ ├── news/ # News module
│ ├── subscription/ # Subscription module
│ └── users/ # User management module
├── data/ # Data and templates folder
├── database/ # Database management module
├── helpers/ # Helper functions
├── models/ # Models for data validation, serialization, and type enforcement
├── service/ # Service-related code
│ ├── news/ # News service
│ └── subscription/ # Subscription service
├── utils/ # Utility functions
├── main.py # Main application file
├── deploy.yml # Spheron Deployment configuration
├── Dockerfile # Docker configuration
├── .dockerignore # Docker ignore rules
├── .env.example # Example environment variables
├── .gitignore # Git ignore rules
└── requirements.txt # Python dependencies- Fork the repository.
- Create a new branch:
git checkout -b feature-name. - Make your changes.
- Push your branch:
git push origin feature-name. - Create a pull request.
This project couldn't be there if they didn't be there!
Even I had many issues while making this project and this was my first time to make a complete react native project with backend but spheron team helped me to over come the issues, gave me suggestions and I am really thankful to it ❤️🩹!
This project is licensed under the MIT License.