Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jotrorox/napi
A simple command line program that allows the user to cache the news headlines for a specific country
https://github.com/jotrorox/napi
command-line-tool gradle kotlin news news-aggregator news-api newsapi
Last synced: about 1 month ago
JSON representation
A simple command line program that allows the user to cache the news headlines for a specific country
- Host: GitHub
- URL: https://github.com/jotrorox/napi
- Owner: Jotrorox
- License: agpl-3.0
- Created: 2024-05-28T15:59:51.000Z (7 months ago)
- Default Branch: master
- Last Pushed: 2024-05-29T07:22:10.000Z (7 months ago)
- Last Synced: 2024-05-29T07:43:13.024Z (7 months ago)
- Topics: command-line-tool, gradle, kotlin, news, news-aggregator, news-api, newsapi
- Language: Kotlin
- Homepage: https://github.com/Jotrorox/napi
- Size: 145 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Napi
About |
Features |
Development Requirements |
Development Setup |
Getting Started |
Contributing |
License |
Author
## :dart: About ##
Napi is a simple project that allows you to query different APIs and cache the data.\
This project is still in development and I am working on adding more features to it.\
If you have any suggestions or ideas, feel free to open an issue or a pull request.
## :sparkles: Features ##
:heavy_check_mark: Querying the API\
:heavy_check_mark: Caching the Data\
:heavy_check_mark: Adding Docker Support\
:clock1: Exposing an api\
:heavy_multiplication_x: Allowing more sources
## :white_check_mark: Development Requirements ##
Before starting :checkered_flag:, you need to have [Git](https://git-scm.com) and a JDK of your choice installed.
## :checkered_flag: Starting (Development Setup) ##
```bash
# Clone this project
$ git clone https://github.com/Jotrorox/napi
# Go into that directory
$ cd napi
# Build the Project
$ ./gradlew clean build
# Package the project into a jar
$ ./gradlew clean jar
# Test the project
$ ./gradlew clean test
```
**If you encounter Problems just hit me up, I'm happy to help you get started**\
**You can do that over matrix: @jotrorox:matrix.org or Discord: https://discord.gg/RVr4cceFUt**
## :dash: Getting Started ##
Since 1.1 there is a easy Docker Setup just ensure you have docker installed.
```bash
# Pull the project
$ docker pull jotrorox/napi
# Start the bot
$ docker run -e NEWS_API_KEY= -e NEWS_COUNTRY_CODE= jotrorox/napi
```
## :raised_hands: Contributing ##
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".
Don't forget to give the project a star! Thanks again!
1. Fork the Project
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
4. Push to the Branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request
## :memo: License ##
This project is under the AGPLv3 License. For more details, see the [LICENSE](LICENSE) file.
Made with :heart: by Jotrorox