Skip to content

Latest commit

Β 

History

History
65 lines (41 loc) Β· 1.58 KB

README.md

File metadata and controls

65 lines (41 loc) Β· 1.58 KB

πŸŽ‰ EmojAI - Emoji Recommender App πŸŽ‰

Welcome to the EmojAI! πŸ˜ƒβœ¨

Utilise the power of ✨AI ✨ to recommend emojis for your text, website or project.

Features 🌟

  • πŸ” Search Emojis: Enter any word, and get a list of matching emojis!
  • ⚑ Fast Results: Cached queries for instant recommendations.
  • πŸ€– AI-Powered: Uses Google Gemini 1.5 Flash fast and accurate suggestions.

How It Works πŸ› οΈ

  1. Type a Word: Enter a word in the search bar. ✏️
  2. Get Recommendations: Receive a list of relevant emojis. 🎁
  3. Enjoy!: Use the emojis in your messages, posts, and more! πŸ’¬

Technologies Used 🧰

  • Next.js 14: The React framework for building fast web applications. βš›οΈ
  • PostgreSQL: Database for caching queries. πŸ—„οΈ
  • Gemini 1.5: AI model for generating emoji recommendations. πŸ€–

Installation πŸ“¦

  1. Clone the Repository:

    git clone https://github.com/juliangra/emoj-ai.git
  2. Install Dependencies:

    cd emoj-ai
    npm install
  3. Set Up Environment Variables:

    Create a .env file and add the following environment variables:

    GOOGLE_GENERATIVE_AI_API_KEY=<your-API-key>
    POSTGRES_URL=<your-postgres-url>
  4. Run the App:

    npm run dev
    
    Navigate to http://localhost:3000 to start using the app! πŸŽ‰

Contributing 🀝

Contributions are welcome! Feel free to open issues or submit pull requests ❀️

License πŸ“„

This project is licensed under the MIT License.

πŸ§‘β€πŸ’» Developed by Julian Grande