https://github.com/riduidel/aadarchi-technology-detector
A helper script for aadarchi allowing us to fetch interesting technologies
https://github.com/riduidel/aadarchi-technology-detector
github-actions hacktoberfest java mvnrepository playwright
Last synced: about 1 year ago
JSON representation
A helper script for aadarchi allowing us to fetch interesting technologies
- Host: GitHub
- URL: https://github.com/riduidel/aadarchi-technology-detector
- Owner: Riduidel
- Created: 2023-06-15T07:52:02.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2025-03-01T03:03:38.000Z (over 1 year ago)
- Last Synced: 2025-03-24T10:06:40.576Z (over 1 year ago)
- Topics: github-actions, hacktoberfest, java, mvnrepository, playwright
- Language: Java
- Homepage:
- Size: 33.4 MB
- Stars: 3
- Watchers: 2
- Forks: 4
- Open Issues: 21
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Welcome to aadarchi-technology-detector 👋
> A Java project loosely spawned aadarchi which aims to detect notable technologies in a variety of languages
### 🏠 [Homepage](https://github.com/Riduidel/aadarchi-technology-detector)
## Prerequisites
* Install Java 21
* Install Maven 3.9
* Install [DVC](https://dvc.org/doc/install)
* Create a [libraries.io API token](https://libraries.io/api#:~:text=API%20Docs-,authentication,-All%20API%20requests)
* Create a [GitHub API token](https://docs.github.com/en/rest/authentication/authenticating-to-the-rest-api?apiVersion=2022-11-28)
## Usage
### Accessing to generated metrics
As of today, latest version of metrics are available in [src/main/resources/csv](https://github.com/Riduidel/aadarchi-technology-detector/tree/main/src/main/resources/csv).
Once [#93](https://github.com/Riduidel/aadarchi-technology-detector/issues/93) will have been implemented, the CSV files will also be available as GitHub releases.
## 🤝 Contributing
### Building the JAR
Since we mainly use Camel Quarkus, the whole application can be built the usual maven way: `mvn install`
### Data access
Data is stored in a Zenika (the company I'm working in) Google Drive folder.
Beside, a local remote is present in DVC to allow easy exploration.
Everything is already configured in dvc.
To start working, run
* `dvc pull --remote zdrive` to have data copied into the local data folder
* `dvc push --remote local-backup` to store data in the local backup folder (useful when moving data)
Don't forget to run `dvc status` and associated `dvc add && dvc commit` when data gets modified.
### Developping new features
This project is a "simple" Camel Quarkus project.
But it also uses various API credentials (at least GitHub API and Libraries.io API).
So you first need to create in your maven settings a tech-trends profile grouping these settings:
```
settings-tech-trends
```
Once this profile is created, developing is as easy as
1. Load project in your preferred IDE
2. Run `mvn quarkus:dev -Psettings-tech-trends`
3. Profit (you can even remote debug the application on port 5005)
### Do not develop features without having discussed first with the team
We do want to have new features.
But we want to have these features discussed **first**.
So if you want to develop a new feature, check first if there is an associated [issue](https://github.com/Riduidel/aadarchi-technology-detector/issues) (and believe us, it's easy to add new issues on this project).
Once the issue exists, you can create your PR and we will try to review it as fast as possible.
## Author
👤 **Riduidel & Helielzel**
* Github: [@Riduidel](https://github.com/riduidel)
* Github: [@Helielzel](https://github.com/helielzel)
## Show your support
Give a ⭐️ if this project helped you!
## 📝 License
Copyright © 2023 [Riduidel & Helielzel](https://github.com/Helielzel).
This project is [MIT](https://github.com/kefranabg/readme-md-generator/blob/master/LICENSE) licensed.
***
_This README was generated with ❤️ by [readme-md-generator](https://github.com/kefranabg/readme-md-generator)_