Welcome to aadarchi-technology-detector 👋

A Java project loosely spawned aadarchi which aims to detect notable technologies in a variety of languages

🏠 Homepage

Prerequisites

• Install Java 21
• Install Maven 3.9
• Install DVC
• Create a libraries.io API token
• Create a GitHub API token

Usage

Accessing to generated metrics

As of today, latest version of metrics are available in src/main/resources/csv. Once #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:

		<profile>
			<id>settings-tech-trends</id>
			<properties>
				<tech-trends.libraries.io.token><!-- Replace with your own Libraries.io token --></tech-trends.libraries.io.token>
				<tech-trends.github.token><!-- Replace with your own GitHub API token --></tech-trends.github.token>
			</properties>
		</profile>

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 (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
• Github: @Helielzel

Show your support

Give a ⭐️ if this project helped you!

📝 License

Copyright © 2023 Riduidel & Helielzel.
This project is MIT licensed.

---

This README was generated with ❤️ by readme-md-generator