Course Report is a Spring Boot application designed to integrate with the MySQL database and Slack to fetch user data from Course Report's API and notify relevant Slack channels about new or updated/recreated users.
The application runs continuously in the background, periodically triggering an API endpoint from Course Report. This endpoint returns user data matching specified criteria such as page number, page count, start date, and end date. The retrieved data is then processed to identify new or updated users.
- Integration with Course Report API
- Database management for user records
- Slack notification for new or updated users
To run the application locally, follow these steps:
-
Clone the repository:
git clone https://github.com/talhayaseen57/Course-Report.git
-
Navigate to the project directory:
cd Course-Report
-
Build the project:
./mvnw clean package
-
Run the application:
java -jar target/course-report-<version>.jar
Before running the application, ensure you have configured the following:
- Database connection settings in application.properties
- Slack API token for sending notifications in SlackSecrets.java
- Course Report API parameters in SlackSecrets.java
- Start the application as per the installation instructions.
- The application will automatically fetch data from Course Report API based on configured parameters.
- New users or updated user data will be saved in the database.
- Slack channels will receive notifications containing user contact information.
Contributions are welcome! If you find any issues or have suggestions for improvements, please open an issue or submit a pull request.