You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+47-14Lines changed: 47 additions & 14 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,36 +1,45 @@
1
1
# Broadband label file Validator Service
2
-
This project is a solution for validating Broadband label files against defined Schemas. Developed by [Evolved Binary](https://www.evolvedbinary.com/),to be used by the FCC https://www.fcc.gov/broadbandlabels, the system consists of a HTTP REST API and a user-friendly Web Application.
2
+
This project provides a solution for validating Broadband Label files against defined Schemas. Developed by [Evolved Binary](https://www.evolvedbinary.com/)for use with the [FCC Broadband Labels](https://www.fcc.gov/broadbandlabels) initiative, the system consists of a HTTP REST API and a user-friendly Web Application.
3
3
4
-
## Overview
5
-
The Broadband label file Validator Service allows public users to validate Broadband label files against various variants and versions of Schema files. The project is built using Java 21 and is open-source under the Apache 2.0 License.
6
-
7
-
The core validation logic is constructed around the Open Source [CSV Validator](https://github.com/digital-preservation/csv-validator) library originally built for The National Archives.
4
+
The core validation logic is built upon the Open Source [CSV Validator](https://github.com/digital-preservation/csv-validator) library, originally developed for The National Archives.
8
5
9
6
## Features
10
7
11
-
HTTP REST API: A robust API that exposes validation services to the internet.
8
+
***HTTP REST API**: A robust API that exposes validation services to the internet.
9
+
***Web Application**: A simple HTML5 interface allowing users to upload files or provide URLs for validation.
10
+
***Multiple Input Methods**: Support for validating broadband label files via direct file upload or external URL retrieval.
11
+
***Schema Management**: dynamically lists and utilizes validation schemas stored in the configured directory.
12
12
13
-
Web Application: A simple HTML5 wrapper around the API allowing users to upload files or provide URLs for validation.
13
+
## Endpoints
14
+
Check the API documentation for more information https://app.swaggerhub.com/apis/evolvedbinary/bbl-validator-web-api/1.0.0#/schema/validateCsv.
14
15
15
-
Multiple Input Methods: Support for validating CSVs via direct file upload or external URL retrieval.
16
+
## Built With
16
17
17
-
## Endpoints
18
-
Check the API documentation for more information https://app.swaggerhub.com/apis/evolvedbinary/bbl-validator-web-api/1.0.0#/schema/validateCsv.
18
+
*[Java 21](https://openjdk.org/projects/jdk/21/) - Programming Language
19
+
*[Micronaut 4](https://micronaut.io/) - The JVM-based framework used
20
+
*[Apache Velocity](https://velocity.apache.org/) - Template engine for the Web Views
0 commit comments