Skip to content

mohAhmadRaza/CulturalGenie-HackathonProject

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

9 Commits
 
 
 
 

Repository files navigation

Culture Genie 🌍

Culture Genie is a web application designed to bridge cultures through AI. It provides users with language translation and cultural insights, helping them navigate cross-cultural interactions effectively. Built with Streamlit and the Groq API, Culture Genie aims to foster understanding and respect among diverse cultures.

Features

  • Language Translation: Enter text to translate across multiple languages.
  • Cultural Insights: Get tips on greetings, dining etiquette, and business norms.
  • File Upload: Upload documents to extract relevant cultural information.
  • Cultural Etiquette Tips: Receive specific advice based on selected countries or regions.

Technologies Used

  • Streamlit: For building the web application interface.
  • Groq API: Accessing the LLaMA 3 model for language processing.
  • Python: Backend logic and API integration.
  • Git: Version control for project management.

Installation

To set up the project locally, follow these steps:

  1. Clone the repository:

    git clone https://github.com/yourusername/culture-genie.git
    cd culture-genie
  2. Create a virtual environment (optional but recommended):

    python -m venv venv
    source venv/bin/activate  # On Windows use `venv\Scripts\activate`
  3. Install dependencies:

    pip install -r requirements.txt
  4. Set up your Groq API key:

    • Create a .env file in the root directory and add your API key:

      GROQ_API_KEY=your_api_key_here
      

Usage

  1. Run the Streamlit app:

    streamlit run app.py
  2. Open your web browser and go to http://localhost:8501.

  3. Input text for translation or select a country for cultural insights.

  4. Upload documents to extract cultural information and receive etiquette tips.

Contributing

We welcome contributions! To contribute to the project:

  1. Fork the repository.
  2. Create a new branch:
    git checkout -b feature/YourFeature
  3. Make your changes and commit them:
    git commit -m "Add some feature"
  4. Push to the branch:
    git push origin feature/YourFeature
  5. Create a pull request.

License

This project is licensed under the MIT License. See the LICENSE file for details.

Acknowledgments

  • LLaMA 3 for its powerful language processing capabilities.
  • Streamlit for enabling rapid web app development.
  • The Groq API for its efficiency in handling language models.

Contact

For any inquiries, feel free to reach out:

Thank you for checking out Culture Genie! 🌏

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages