/EasyAgreement

Primary LanguageJavaScriptMIT LicenseMIT

Easy Agreement

Easy Agreement is a web-based application designed to simplify the understanding of legal contracts. The application allows users to upload legal contracts in PDF format and generate summarized versions, making the complex language more accessible and easier to comprehend.

Features

  • Contract Summarization: Upload legal contracts in PDF format and generate concise summaries of the most important points within the document.
  • Accessibility Options: Customize font size, utilize the read-aloud feature, and translate the summary into preferred languages to enhance accessibility for all users.
  • User-Friendly Interface: Easy-to-use web interface that simplifies the process of uploading, generating, and accessing summarized legal contracts.

Getting Started

To use Easy Agreement locally, follow these steps:

  1. Clone the repository: git clone https://github.com/ri-tae-ka/EasyAgreement.git
  2. Navigate to the project directory: cd easy-agreement
  3. Install dependencies in root folder as well as client folder: npm install
  4. Create a .env file ~ server/config/config.env as .env.sample
  5. Create another .env file in the /client folder as .env.sample
  6. Start the server side: npm run dev
  7. Start the client side in another terminal: cd client and npm start
  8. Access the application in your web browser at http://localhost:3000

Technologies Used

Built Using:

Frontend: React HTML5 CSS3

Backend: NodeJS

Database: MongoDB

Linter: ESLint

Built Using: GitHub Git Visual Studio Code


IMPORTANT NOTE -

This project does not have a mongoDB connection setup. Setup the connection based on the environments below.

  • local development: create a config file (make sure to name it config.env) in the config folder, which exports your db.uri connection. An example is provided, server/config/config.env This file will be ignored by git so your db credentials will be kept safe when the app is deployed.

  • production: Make sure you name the environement variable "DB_URI".

  • MERN Stack:

    • MongoDB: Database for storing user data and contract summaries.
    • Express.js: Backend framework for handling HTTP requests and routing.
    • React: Frontend library for building the user interface.
    • Node.js: JavaScript runtime environment for server-side code.

Contributing

Contributions to Easy Agreement are welcome! If you have suggestions for new features or improvements, please submit a pull request. For major changes, please open an issue first to discuss the proposed changes.

License

This project is licensed under the MIT License.

Acknowledgements

We would like to thank the developers and contributors who have made their libraries, frameworks, and resources available, enabling us to build Easy Agreement.