Repository navigation
Add a comprehensive readme to the project - #9
Conversation
a62e342 to
41ef88a
Compare
| - Java 21 | ||
| - Maven 3.6+ | ||
| # Broadband label file Validator Service | ||
| 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. |
There was a problem hiding this comment.
Developed by [Evolved Binary](https://www.evolvedbinary.com/) -> Developed for [Comcast](https://www.comcast.com) by [Evolved Binary](https://www.evolvedbinary.com)
| 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. | ||
|
|
||
| ## Running the Application | ||
| 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. |
There was a problem hiding this comment.
Please link The National Archives to https://www.nationalarchives.gov.uk/
|
|
||
| * **HTTP REST API**: A robust API that exposes validation services to the internet. | ||
| * **Web Application**: A simple HTML5 interface allowing users to upload files or provide URLs for validation. | ||
| * **Multiple Input Methods**: Support for validating broadband label files via direct file upload or external URL retrieval. |
There was a problem hiding this comment.
broadband label should be capitalised throughout this README.md please
| ## Built With | ||
|
|
||
| * [Java 21](https://openjdk.org/projects/jdk/21/) - Programming Language | ||
| * [Micronaut 4](https://micronaut.io/) - The JVM-based framework used |
There was a problem hiding this comment.
The JVM-based framework used -> A Web Application framework
|
|
||
| * [Java 21](https://openjdk.org/projects/jdk/21/) - Programming Language | ||
| * [Micronaut 4](https://micronaut.io/) - The JVM-based framework used | ||
| * [Apache Velocity](https://velocity.apache.org/) - Template engine for the Web Views |
There was a problem hiding this comment.
Template engine for the Web Views -> Provides templating for the Web Pages.
| ``` | ||
|
|
||
| ## Using Docker: | ||
| Build the JAR |
There was a problem hiding this comment.
Build the JAR -> ### Building an Application Package
| ``` | ||
| Use the absolute path to the schemas directory when running the docker container. | ||
|
|
||
| Using Docker |
There was a problem hiding this comment.
This is both building the Docker Container and running the Docker Container - should be split into 2 separate L3 sections. Building it will be optional as we will publish it on Docker Hub. Also again, we need some information about what they are doing here and what the result is and how to use it please
|
|
||
| Web: https://www.evolvedbinary.com. | ||
|
|
||
| Phone: +44 (0)2032 397236 / +1 917 267-8787. No newline at end of file |
There was a problem hiding this comment.
Please remove the phone number.
| ## Contact and Support | ||
| Evolved Binary Limited | ||
|
|
||
| Email: admin@evolvedbinary.com. |
There was a problem hiding this comment.
Please remove the trailing .
|
|
||
| Email: admin@evolvedbinary.com. | ||
|
|
||
| Web: https://www.evolvedbinary.com. |
There was a problem hiding this comment.
Please remove the trailing .
2 participants
Create a Readme for the project with the intent to: