A sophisticated React TypeScript application that leverages the power of Google's Gemini API to generate unique and creative names based on user-provided descriptions. This project showcases modern web development practices and integrates cutting-edge AI technology.
- Intuitive user interface for inputting descriptions
- Generates up to 12 unique and creative names
- Responsive design with a modern aesthetic using Tailwind CSS
- Real-time name generation with loading indicators
- Local storage integration for persisting generated names
- Error handling and user feedback
- Frontend:
- React 18
- TypeScript 5
- Tailwind CSS 3
- Vite (for fast builds and hot module replacement)
- Backend:
- Node.js
- Express.js
- API:
- Google Gemini API
- Model:
- gemini-1.5-flash (state-of-the-art language model)
-
Clone the repository:
git clone https://github.com/your-username/names-generator-AI.git cd names-generator-AI
-
Install dependencies for both client and server:
npm run install-all
-
Set up environment variables: Create a
.env
file in theserver
directory and add your Google API key:GOOGLE_API_KEY=your_api_key_here
You can obtain an API key from Google AI Studio.
-
Start the development servers:
npm run dev
This command will concurrently start both the backend server and the frontend development server.
- Open your browser and navigate to
http://localhost:5173
(or the port specified by Vite). - Enter a descriptive phrase or concept in the input field.
- Click the "Generate Names" button.
- View the list of unique, AI-generated names based on your input.
- Generated names are automatically saved and will persist across browser sessions.
We welcome contributions to improve the Name Generator AI! Here's how you can contribute:
- Fork the repository
- Create your feature branch (
git checkout -b feature/AmazingFeature
) - Commit your changes (
git commit -m 'Add some AmazingFeature'
) - Push to the branch (
git push origin feature/AmazingFeature
) - Open a Pull Request
Please ensure your code adheres to our coding standards and includes appropriate tests.
This project is licensed under the MIT License. See the LICENSE file for more details.
- React - A JavaScript library for building user interfaces
- TypeScript - Typed superset of JavaScript
- Tailwind CSS - A utility-first CSS framework
- Google Gemini API - Advanced language model API
- Vite - Next generation frontend tooling
- Express.js - Fast, unopinionated, minimalist web framework for Node.js
Developed with ❤️ by Abhishek
For any questions or support, please open an issue or contact us at [[email protected]].