<br />

<div align="center">
  <a href="https://github.com/levrone1987/PulseSpotter">
        <img src="images/pulsespotter-logo.svg" width="180" title="PulseSpotter">
    </a>
  <h1 align="center">PulseSpotter</h1>
  <p align="center">delivers AI-powered insights in news trends</p>
  
  [![License](https://img.shields.io/github/license/levrone1987/PulseSpotter?color=green)](https://github.com/levrone1987/PulseSpotter/blob/main/LICENSE)
  [![GitHub issues](https://img.shields.io/github/issues/levrone1987/PulseSpotter)](https://github.com/levrone1987/PulseSpotter/issues)
  [![GitHub stars](https://img.shields.io/github/stars/levrone1987/PulseSpotter)](https://github.com/levrone1987/PulseSpotter/stargazers)
</div>

> [!WARNING]
> This application is currently in alpha state and under active development. Please be aware that the API and features may change at any time.

## Project Description

Writing news articles about trending events requires journalists to sift through large amounts of content and deciding what to cover.
This process can be time-consuming and mentally exhausting, with constant switching between different sources and ideas.

**PulseSpotter** is designed to assist journalists in the task of identifying newsworthy topics that are likely to become popular.
By gathering information from various news sources and analyzing patterns over time, the system suggests emering trends, saving journalists time on research and deciding which stories to focus on.

## Getting started

### Installation with pip
TBA

## Usage
TBA

## Use with Docker
You can find usage examples with docker here: [Docker example](https://github.com/levrone1987/PulseSpotter/tree/main/docker).

## Contributing
We welcome any contributions from the community!
If you're interested in improving PulseSpotter, here are some ways you can get involved:
* **Model improvements**: Contribute by refining the scraping algorithms, improving topic modeling, or increasing the accuracy of predictions.
* **Reporting Bugs**: Identify issues or bugs in the system and suggest fixes.
* **Feature Requests**: Propose new features or improvements that could make PulseSpotter even more useful for journalists.
* **Improving documentation**: Assist in writing or refining documentation to make PulseSpotter more accessible to new users and contributors.
* **Testing and feedback**: Test the system, explore new features, and offer feedback to ensure a smooth user experience.

## License
This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details.

## Contact
If you want to get in touch feel free to reach out at [pulsespottermedialab@gmail.com](mailto:pulsespottermedialab@gmail.com).

## Acknowledgements
This project was supported by:

<a href="https://www.media-lab.de/en/programs/media-tech-lab">
    <img src="images/media-tech-lab.png" width="180" title="Media Tech Lab powered by logo">
</a>