{"id":21377232,"url":"https://github.com/maruf-pfc/quickgen","last_synced_at":"2025-03-16T09:44:41.048Z","repository":{"id":263485314,"uuid":"889929954","full_name":"maruf-pfc/QuickGen","owner":"maruf-pfc","description":"QuickGen is a desktop app that lets users select tech stacks and generates project templates using socket-based communication. ","archived":false,"fork":false,"pushed_at":"2024-11-19T18:43:06.000Z","size":290,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-01-22T21:45:27.629Z","etag":null,"topics":["developer-tools","hacktoberfest","opensource","productivity-tools","quickgen","vite","web-development-tools"],"latest_commit_sha":null,"homepage":"","language":"CSS","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/maruf-pfc.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-11-17T15:50:51.000Z","updated_at":"2024-11-19T20:04:03.000Z","dependencies_parsed_at":"2024-11-19T06:01:24.633Z","dependency_job_id":null,"html_url":"https://github.com/maruf-pfc/QuickGen","commit_stats":null,"previous_names":["maruf-pfc/quickgen"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/maruf-pfc%2FQuickGen","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/maruf-pfc%2FQuickGen/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/maruf-pfc%2FQuickGen/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/maruf-pfc%2FQuickGen/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/maruf-pfc","download_url":"https://codeload.github.com/maruf-pfc/QuickGen/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243852432,"owners_count":20358270,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["developer-tools","hacktoberfest","opensource","productivity-tools","quickgen","vite","web-development-tools"],"created_at":"2024-11-22T09:19:40.976Z","updated_at":"2025-03-16T09:44:41.025Z","avatar_url":"https://github.com/maruf-pfc.png","language":"CSS","readme":"# Project Generator Desktop Application\n\nA powerful desktop application built with Java Swing that helps developers quickly scaffold new projects across multiple technologies through an intuitive graphical interface and socket-based backend.\n\n![QuickGen Project Generator Demo](./demo.png)\n\n## Features\n\n- 🚀 Quick project scaffolding for multiple technologies:\n\n  - React with JavaScript\n  - React with TypeScript\n  - Node.js MVC\n  - SCSS templates\n  - HTML/CSS projects\n\n- 💻 User-friendly desktop interface built with Java Swing\n- 🔄 Real-time project generation through socket communication\n- 📁 Custom project location selection\n- 📝 Automated README generation for new projects\n- 🎯 Pre-configured project templates following best practices\n\n## Prerequisites\n\nBefore running the application, ensure you have:\n\n- Java Development Kit (JDK) 8 or higher installed\n- Sufficient disk space for project generation\n- Network access for socket communication\n\n## Installation\n\n1. Clone the repository:\n\n```bash\n git clone https://github.com/maruf-pfc/QuickGen.git\n```\n\n2. Navigate to the project directory:\n\n```shellscript\n cd QuickGen\n```\n\n3. Compile the server:\n\n```shellscript\n javac QuickGenServer.java\n```\n\n1. Compile the client:\n\n```shellscript\n javac QuickGenClient.java\n```\n\n## Usage\n\n1. Start the server:\n\n```shellscript\n java QuickGenServer\n```\n\n2. Launch the desktop application:\n\n```shellscript\n java QuickGenClient\n```\n\n3. In the application:\n\n1. Select your desired technology\n1. Enter a project name\n1. Choose a directory for project creation\n1. Click \"Generate Project\"\n\n## Project Structure\n\n```plaintext\n📦QuickGen\n ┣ 📂quickgen\n ┃ ┣ 📂opt\n ┃ ┃ ┗ 📂quickgen\n ┃ ┃ ┃ ┣ 📜QuickGen.jar\n ┃ ┃ ┃ ┗ 📜icon.png\n ┃ ┗ 📂usr\n ┃ ┃ ┗ 📂share\n ┃ ┃ ┃ ┗ 📂applications\n ┣ 📂templates\n ┃ ┣ 📂html-css\n ┃ ┣ 📂nodejs-mvc\n ┃ ┣ 📂react-js\n ┃ ┣ 📂react-ts\n ┃ ┗ 📂scss\n ┣ 📜.gitignore\n ┣ 📜LICENSE\n ┣ 📜QuickGen.jar\n ┣ 📜QuickGenClient.java\n ┣ 📜QuickGenServer.java\n ┣ 📜README.md\n ┣ 📜create-deb.js\n ┣ 📜create-exe.js\n ┣ 📜demo.png\n ┣ 📜executable.md\n ┣ 📜launch4j-config.xml\n ┣ 📜manifest.txt\n ┣ 📜setup-launch4j.js\n ┗ 📜setup.js\n```\n\n## Make Executable File\n\n- Open this link [Create Executable File](./executable.md)\n\n## Template Structure\n\nEach technology template includes:\n\n- Basic project configuration\n- Required dependencies\n- Sample components/files\n- Development scripts\n- Generated README with setup instructions\n\n## Contributing\n\n1. Fork the repository\n2. Create your feature branch (`git checkout -b feature/AmazingFeature`)\n3. Commit your changes (`git commit -m 'Add some AmazingFeature'`)\n4. Push to the branch (`git push origin feature/AmazingFeature`)\n5. Open a Pull Request\n\n### Adding New Templates\n\n1. Create a new directory in `templates/` for your technology\n2. Include all necessary project files and configurations\n3. Update the technology mapping in `QuickGenServer.java`\n4. Add template-specific README instructions\n5. Submit a pull request with your changes\n\n## Error Handling\n\nThe application includes comprehensive error handling for:\n\n- Invalid project names\n- Directory access issues\n- Network communication errors\n- Template missing errors\n- Server connection problems\n\n## Development\n\nTo modify the application:\n\n1. Update GUI components in `QuickGenClient.java`\n2. Modify server logic in `QuickGenServer.java`\n3. Add/update templates in the `templates/` directory\n4. Recompile both client and server components\n\n## License\n\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.\n\n## Acknowledgments\n\n- Java Swing for the desktop interface\n- Socket programming for client-server communication\n- Various project template maintainers\n- Open source community\n\n## Support\n\nFor support, please:\n\n1. Check existing [Issues](https://github.com/yourusername/project-generator/issues)\n2. Create a new issue with detailed information\n3. Join our [Discord community](https://discord.gg/projectgenerator)\n\n## Roadmap\n\n- Additional technology templates\n- Custom template configuration\n- Project dependency updates\n- Multi-language support\n- Template versioning\n\n## Authors\n\n- **Your Name** - _Initial work_ - [YourUsername](https://github.com/yourusername)\n\nSee also the list of [contributors](https://github.com/yourusername/project-generator/contributors) who participated in this project.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmaruf-pfc%2Fquickgen","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmaruf-pfc%2Fquickgen","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmaruf-pfc%2Fquickgen/lists"}