Skip to content

Mario2334/startgen

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

38 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

🚀 Welcome to StartGen! 🌟

StartGen is your AI-powered buddy that brings your project ideas to life—effortlessly! Tired of starting from scratch? Just describe your idea in plain English, and let StartGen handle the rest. No fuss, no hassle. 💡


What Can StartGen Do for You? 🛠️

  • 👨‍💻 Plain English Prompts: Simply describe your project in one sentence, and voila!
  • 🎯 No Clutter: Get a clean, well-organized project scaffold.
  • ✨ Instant Files: Automatic directory and file creation—ready for your magic touch.

🚧 Installation & Setup 🛠️

🔑 Set Your Environment Variables:

export OPENAI_API_KEY=your_openai_api_key_here

Using Brew

Install From brew

   brew tap Mario2334/startgen
   brew install startgen

Using Binary

  1. 🔽 Download the Executable:

    • Grab the startgen binary for your system.
  2. 🏗️ Make It Executable:

    chmod +x ./startgen
  3. 📚 Need Help?

    ./startgen --help

⚙️ How to Use StartGen 🎉

Run StartGen with a simple, fun prompt:

startgen -o "<dir>" "A React app with a Flask backend and PostgreSQL database."

What Happens Next?

🧠 StartGen uses your description to create:

  • A React frontend with components and pages.
  • A Flask backend with REST API boilerplate.
  • Database setup scripts for PostgreSQL.

Options 🛠️

  • -o <path>:
    Specify where your project files will live.
    Example:
    ./startgen startgen -o "<dir>" "A Node.js CLI tool that converts CSV to JSON"

🚀 Example Workflow: Bring Your Ideas to Life! 🌈

  1. 💡 Dream Up a Project:
    “I want a Python-based data pipeline to process weather data!”

  2. 🤖 Run StartGen:

    startgen "A Python-based data pipeline to process weather data"
  3. 📂 Check Your Project Files:
    Your new project is ready for you to start coding. Easy-peasy lemon squeezy! 🍋


Need a Laugh? 😄

Try a silly prompt:

startgen "A Python script to help my dog learn to code."

🐶 You’ll still get a valid project scaffold… paw-some!


Troubleshooting Tips 🛠️

  • No Output or Errors?
    👉 Check your environment variables (OPENAI_API_KEY and PROJECT_PATH).

  • Weird Layouts?
    📝 Make sure your prompt is clear and descriptive.

  • Not What You Expected?
    ✍️ Refine your prompt and try again!


Support & Feedback ❤️

💌 Got questions or suggestions? Open an issue on our GitHub repository. We’d love to hear from you!


StartGen: Where ideas meet reality, one project at a time. Happy coding! 🎉

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages