Skip to content

Latest commit

 

History

History
73 lines (50 loc) · 4.26 KB

README.md

File metadata and controls

73 lines (50 loc) · 4.26 KB

Logo

This biz is serious.

Table of Contents

You deserve to know your rights.

According to the World Justice Project (WJP), the decline in the rule of law currently "represents almost 85% of the world's population", affecting our individual legal awareness. With the decline of legal awareness being at an all-time high, marks the birth of our inspiration that brought our team together to tackle an underrepresented challenge that affects our global society.

Another shared interest between our team is emerging technologies. With the exponential growth of the applications of artificial intelligence, our team found the opportunity to apply our existing AI knowledge and use it to addressing the worldwide decline of legal awareness.

Reading your legal biz.

ReadMyLegal.biz is a state-of-the-art GPT-3.5 Turbo powered legal document reader, designed to simplify your legal interactions and empower you with a comprehensive understanding of your rights and responsibilities, as well as those of the other.

Developed as part of the Knighthacks 2023 in Orlando, FL, ReadMyLegal.biz is designed to provide individuals an understanding of their rights and responsibilities. Navigating the intricacies of legal documents can be a daunting task, but with our advanced AI technology, you can effortlessly decode complex legal jargon and gain clarity on critical information by uploading a PDF document, pasting text into a box, or through audio transcription for accessible options*.

We built it with what?

ReadMyLegal.biz was built from the ground up as a web app in mind, making it accessible from almost every modern platform that has access to the internet. Utilizing Java as the backend and JavaScript as the front end, integrating OpenAI's GPT model was a simple task. The connection between the backend and the frontend was solved by creating a REST API to handle the task of processing complex legal documents and generating detailed responses.

Functional style.

The website has to be functional, easy-to-use, and stylish. We spiced it up with the latter. Leveraging React, we designed a precisely crafted interface that is not only extremely stylish but easy-to-use for everyone as well, including accessibility options.

The challenges?

  • Security.
    • A big focus was emphasized on masking the API token. We learned the best token security practices to keep those legal documents safe and sound.
  • The Environment
    • Setting up the environment from the domain to hosting the server and networking was a task.
      • We learned more about A, AAAA, CNAME, and other records in order to maintain and protect our domain as much as possible.
  • Design Philosophy
    • Held a group vote. We maintained a respectful manner with each other and collaborated well with each other, each of us playing a special role on the team.

What's next for ReadMyLegal.

We'll be developing more accessibility features in the future while providing support for more file types such as .doc, .docx. We will also continue to brush up on our software development knowledge and continue to advocate for the growth of legal awareness.

Let's set this up!

Here are instructions to run the server software backend and frontend.

Before you start the Java server, you must have assemblyai-token.txt and openai-token.txt in your working directory, the former containing an API token for AssemblyAI, the latter containing an API token for OpenAI.

Create and execute Java 17 Jar file

cd <repository directory>
cd backend-java
./gradlew shadowJar
java -jar ./app/build/libs/rml-backend.jar 5252 <password>

Initialize web interface with npm

cd <repository directory>
cd readmylegal
npm install
npm start # Will start on port 3000

License information

This project is licensed under the GNU General Public License v3.0 - see the LICENSE file for details.