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.
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.
- 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.
To get started with Family Transcribe, follow these steps:
- Clone the Repository:
git clone https://github.com/your-username/family-transcribe.git
- Install Dependencies:
cd family-transcribe npm install
- Set up API Keys:
- Obtain API keys for Google Translation and OpenAI.
- Add these keys to the appropriate configuration files.
- Run the Application:
npm run dev
- Access the App:
Open your web browser and navigate to
http://localhost:3000
to access the app.
- Frontend: Next.js
- Translation: Google Translation APIs
- Summarization: OpenAI
- PDF Generation: HTML to PDF conversion libraries
- Paste the text from the document you want to translate and summarize.
- Select the target language for translation.
- Click the "Translate and Summarize" button.
- Review the summarized content.
- Click "Generate PDF" to create a printable PDF of the summary.
Contributions to Family Transcribe are welcome! If you'd like to contribute, please follow these steps:
- Fork the repository.
- Create a new branch for your feature or bug fix:
git checkout -b feature-name
. - Make your changes and commit them:
git commit -m 'Add feature-name'
. - Push to the branch:
git push origin feature-name
. - Create a pull request.
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.