SunnyStormy is a Spring Boot is a fun conceptual project that offers a unique twist on news consumption. It provides short overviews of the latest news articles flavored from either an optimistic or a pessimistic point of view, adding a touch of playfulness to your news feed. This project leverages the NewsAPI to fetch news fragments and the Chat GPT API to generate the flavored news content.
Before you start using SunnyStormy, make sure you have the following prerequisites installed on your system:
- Java Development Kit (JDK) - Version 17 or higher.
- Gradle - Build automation and dependency management tool.
- Git - Version control system.
Also, make sure you have access to the required external resources:
- NewsAPI API Key - Sign up for a free API key to access news data.
- OpenAI API Key - Create your account and API key to access AI text completions.
Follow these steps to install and run SunnyStormy in development mode:
-
Clone the SunnyStormy repository:
git clone https://github.com/johnnysn/sunnystormy.git
-
Navigate to the project directory:
cd sunnystormy -
Set the environment variables APP_API_KEY (API key for protected endpoints of the application), CHAT_API_KEY and NEWS_API_KEY. If the
prodprofile is not active, CHAT_API_KEY should be just a dummy key, since no real communication with OpenAI will occur. -
Build and run the project using Gradle:
gradle bootRun
You can also pass environment variables along with the execution command:
APP_API_KEY=mykey NEWS_API_KEY=newsorgkey CHAT_API_KEY=dummy gradle bootRun
In order to run the project in production mode and actyally consume ChatGPT AI resources, you should add
--args='--spring.profiles.active=prod'to the execution command.
SunnyStormy should now be up and running on http://localhost:8080.
Endpoints that consume external resources are protected by a simple API key authorization, which
is defined by the environment variable APP_API_KEY. The key must be provided in a header
entry identified by ApiKey. You can visualize the API documentation by running the app
and accessing the Swagger UI: http://localhost:8080/swagger-ui/index.html.
- POST
/fetching/news
Retrieves the latest news from an external API with the batch size configured in the application.properties file
(application.news.max-batch-size) and saves them into the database.
- No request body is required.
- The response will be a JSON array containing news articles with the following structure:
[
{
"id": "08da0a53-cedd-4b7c-9a8c-91308be0ea6e",
"timestamp": "2023-11-12 09:22:43",
"title": "Iceland declares state of emergency over escalating earthquakes, and volcano eruption fears - Euronews",
"content": "Iceland has 33 active volcanic systems, the highest number in Europe, and thousands of tremors have been recorded since the end of October.",
"imgUrl": "https://static.euronews.com/articles/stories/08/03/27/68/1000x563_cmsv2_fb6b8b7a-7bb3-539f-ae74-c31b10b96c6e-8032768.jpg"
}
]- This endpoint is protected by API key authorization.
- POST
/prompting/flavored-news
Calls the ChatGPT API to generate an optimistic or a pessimistic overview of a
news article identified by its news_id and saves it into the database.
- The request body should be a JSON object with the following format:
{
"news_id": "0f0b120c-5bde-4cd3-ae49-641df99fc2bc",
"flavor": "SUNNY"
}news_id: The unique identifier of the news article.flavor: The flavor or tone for the generated news overview (e.g., "SUNNY").
- The response will be a JSON object with the following structure:
{
"id": "712dcecf-0bbf-49ac-9d68-71f329163d23",
"flavoredTitle": "Iceland's Resilience Shines as State of Emergency Declared Amidst Earthquakes and Volcano Eruption Fears",
"flavoredContent": "Iceland, home to Europe's highest number of volcanic systems, showcases its strength and preparedness as it declares a state of emergency amidst escalating earthquakes and fears of a volcano eruption. Thousands of tremors have been recorded since October, highlighting the country's resilience and dedication to ensuring public safety.",
"flavor": "SUNNY",
"originalNews": {
"id": "08da0a53-cedd-4b7c-9a8c-91308be0ea6e",
"timestamp": "2023-11-12 09:22:43",
"title": "Iceland declares state of emergency over escalating earthquakes, and volcano eruption fears - Euronews",
"content": "Iceland has 33 active volcanic systems, the highest number in Europe, and thousands of tremors have been recorded since the end of October.",
"imgUrl": "https://static.euronews.com/articles/stories/08/03/27/68/1000x563_cmsv2_fb6b8b7a-7bb3-539f-ae74-c31b10b96c6e-8032768.jpg"
}
}- POST
/prompting/flavored-news/for-latest
Does the same thing of the previous endpoint, but for the most recent news fragment that has not been flavored yet. Both sunny and stormy flavored news overviews will be generated.
- No request body is required.
- An array containing a maximum of two objects, each with the same structure as the previous endpoint.
- This endpoint is protected by API key authorization.
- GET
/public/flavored-news
Retrieves a page of flavored news overviews, sorted in descending order by the timestamp of the original news fragment.
- Accepts two optional query params:
- page: Number of the page, starting from 0
- size: Page size, with maximum value configured in the application property
application.news.max-page-size
- A JSON with the structure of
org.springframework.data.domain.Pagecontaining flavored news descriptors as the previous endpoint.
- No authorization is required.
We welcome contributions to SunnyStormy! If you'd like to add features, fix bugs, or improve documentation, please fork this repository and submit a pull request. For major changes, please open an issue first to discuss the proposed changes.
This project is licensed under the MIT License - see the LICENSE file for details.