Skip to content

Latest commit

 

History

History
49 lines (38 loc) · 1.53 KB

README.md

File metadata and controls

49 lines (38 loc) · 1.53 KB
Raw

Not Boring Design System Names

This project helps you generate unique and memorable names for your design system that reflects your brand characteristics and industry.

The name generation is done using the OpenAI GPT-3 language model, and you can customize the generated name by providing your company name, brand characteristics, and space.

Technologies Used

  • Next.js
  • React
  • Redux
  • Framer Motion
  • CSS Modules
  • OpenAI API

Getting Started

  1. Clone the repository:
git clone https://github.com/your-username/not-boring-design-system-names.git
  1. Install the dependencies:
cd not-boring-design-system-names
npm install
  1. Set up your OpenAI API key by creating a .env.local file in the root directory of the project and adding your API key:
OPENAI_API_KEY=YOU_API_KEY_HERE
  1. Run the development server:
npm run dev
  1. Open http://localhost:3000 with your browser to see the result.

Usage

  1. Enter your company name, brand characteristics, and industry space in the input fields provided on the page.
  2. Click on the "Generate name" button to generate a unique name for your design system.
  3. Wait for the name to be generated. This may take a few seconds.
  4. Once the name is generated, it will be displayed on the page along with an explanation of why it is a good fit for your design system.

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

License

MIT