Git Product home page Git Product logo

family-transcribe's Introduction

Family Transcribe

Table of Contents

Introduction

Family Transcribe is a web application designed to facilitate conversations within first-generation American families. It addresses the language barrier by simplifying complex documents such as college applications and financial forms. The app allows users to translate, summarize, and generate printable PDFs of these documents, making them more accessible to non-English-speaking parents.

Inspiration

The inspiration for Family Transcribe came from the challenges faced by first-generation American families in understanding and discussing critical documents with non-English-speaking family members. We aim to empower these families by providing a tool that eases communication.

Features

  • Translation: Translate text from one language to another using Google Translation APIs.
  • Summarization: Summarize complex documents with the help of OpenAI's text summarization capabilities.
  • PDF Generation: Convert summarized content into printable PDF files.
  • User Authentication: Protect sensitive documents with user authentication.
  • Multi-Language Support: Provide support for multiple languages to cater to a diverse user base.

Getting Started

To get started with Family Transcribe, follow these steps:

  1. Clone the Repository:

git clone https://github.com/your-username/family-transcribe.git

  1. Install Dependencies:

cd family-transcribe npm install

  1. Set up API Keys:
  • Obtain API keys for Google Translation and OpenAI.
  • Add these keys to the appropriate configuration files.
  1. Run the Application:

npm run dev

  1. Access the App: Open your web browser and navigate to http://localhost:3000 to access the app.

Technology Stack

  • Frontend: Next.js
  • Translation: Google Translation APIs
  • Summarization: OpenAI
  • PDF Generation: HTML to PDF conversion libraries

Usage

  1. Paste the text from the document you want to translate and summarize.
  2. Select the target language for translation.
  3. Click the "Translate and Summarize" button.
  4. Review the summarized content.
  5. Click "Generate PDF" to create a printable PDF of the summary.

Contributing

Contributions to Family Transcribe are welcome! If you'd like to contribute, please follow these steps:

  1. Fork the repository.
  2. Create a new branch for your feature or bug fix: git checkout -b feature-name.
  3. Make your changes and commit them: git commit -m 'Add feature-name'.
  4. Push to the branch: git push origin feature-name.
  5. Create a pull request.

License

This project is licensed under the MIT License.

As before, make sure to replace placeholders like your-username, API keys, and Authentication Library/Service with actual values and details specific to your project. Also, ensure that you have a LICENSE file in your repository and provide the appropriate license information.

family-transcribe's People

Contributors

ezchung avatar ari-denary avatar husekivrak avatar cli3338198 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.