Skip to content

Commit 41ef88a

Browse files
committed
[doc] Improve the readme
1 parent 76b2e18 commit 41ef88a

1 file changed

Lines changed: 47 additions & 14 deletions

File tree

README.md

Lines changed: 47 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,36 +1,45 @@
11
# 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.
33

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.
85

96
## Features
107

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.
1212

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.
1415

15-
Multiple Input Methods: Support for validating CSVs via direct file upload or external URL retrieval.
16+
## Built With
1617

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
21+
* [Maven](https://maven.apache.org/) - Dependency Management
22+
* [Docker](https://www.docker.com/) - Containerization
1923

2024
## Prerequisites
21-
- Java 21
22-
- Maven 3.6+
25+
* Java 21
26+
* Maven 3.6+
2327

24-
## Running the Application
28+
## Getting Started
2529
Using Maven
2630

2731
```bash
2832
git clone https://github.com/evolvedbinary/bbl-validator.git
2933
cd bbl-validator
30-
mvn clean compile
3134
mvn mn:run
3235
```
3336

37+
Build the JAR
38+
39+
```bash
40+
mvn clean package
41+
```
42+
3443
Using Docker
3544

3645
```bash
@@ -41,6 +50,30 @@ docker run -p 8080:8080 -v /path/to/schemas:/app/schemas:ro evolvedbinary/bbl-va
4150
```
4251

4352
note: use the absolute path to the schemas directory when running the docker container.
53+
54+
## Usage
55+
56+
### Web Interface
57+
Navigate to http://localhost:8080/views/validate in your browser. You can:
58+
59+
1. Select a Schema ID from the dropdown.
60+
61+
2. Choose to validate via URL or Content.
62+
63+
3. View the validation status and any error messages in the results table.
64+
65+
### HTTP API
66+
You can validate files programmatically using the API. Full documentation is available via:
67+
68+
Online: [SwaggerHub API Docs](https://app.swaggerhub.com/apis/evolvedbinary/bbl-validator-web-api/1.0.0#/schema/validateCsv)
69+
70+
Local Spec: The OpenAPI YAML file is available at `/static/openapi.yaml` on the running server.
71+
72+
## Configuration
73+
The application uses application.yml for configuration.
74+
75+
* Server Port: Defaults to `8080`.
76+
* Schema Directory: Defaults to `schemas` relative to the working directory.
4477

4578
## Contact and Support
4679
Evolved Binary Limited

0 commit comments

Comments
 (0)