1.0.1 โ€ข Published 5 months ago

create-webforge-app v1.0.1

Weekly downloads
-
License
MIT
Repository
github
Last release
5 months ago

๐ŸŒ WebForge - Create My App CLI ๐Ÿš€

Welcome to WebForge! ๐ŸŽ‰\ A powerful CLI tool crafted by whoviks to effortlessly scaffold your projects. From frontend to full-stack magic, WebForge has got you covered! ๐Ÿ”ฅ


๐Ÿ“‚ Project Structure

๐Ÿ“ฆ src
    โ”ฃ ๐Ÿ“œbackend.js
    โ”ฃ ๐Ÿ“œbanner.js
    โ”ฃ ๐Ÿ“œcli.js
    โ”ฃ ๐Ÿ“œfeatures.js
    โ”ฃ ๐Ÿ“œfrontend.js
    โ”— ๐Ÿ“œutils.js
 โ”ฃ ๐Ÿ“œpackage.json
 โ”— ๐Ÿ“œREADME.md

โœจ Key Features

โœ… Frontend Options: React (Vite) or Next.js\ โœ… Full-stack: MERN (MongoDB) or PERN (PostgreSQL)\ โœ… Backend Options: Express with MongoDB/PostgreSQL, plus optional EJS\ โœ… Bonus Goodies: Docker ๐Ÿณ, CORS ๐ŸŒ, GraphQL ๐Ÿ“Š, .env ๐Ÿ”‘\ โœ… Developer Delight: Auto-opens VS Code right into your new project! ๐ŸŽ‰


๐Ÿš€ Usage Example

To start scaffolding your next awesome project, simply run:

npm create webforge-app

Example Output

 โ–ˆโ–ˆโ•—    โ–ˆโ–ˆโ•—โ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ•—โ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ•— โ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ•— โ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ•— โ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ•—  โ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ•— โ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ•—
 โ–ˆโ–ˆโ•‘    โ–ˆโ–ˆโ•‘โ–ˆโ–ˆโ•”โ•โ•โ•โ•โ•โ–ˆโ–ˆโ•”โ•โ•โ–ˆโ–ˆโ•—โ–ˆโ–ˆโ•”โ•โ•โ•โ•โ•โ–ˆโ–ˆโ•”โ•โ•โ•โ–ˆโ–ˆโ•—โ–ˆโ–ˆโ•”โ•โ•โ–ˆโ–ˆโ•—โ–ˆโ–ˆโ•”โ•โ•โ•โ•โ• โ–ˆโ–ˆโ•”โ•โ•โ•โ•โ•  webforge cli
 โ–ˆโ–ˆโ•‘ โ–ˆโ•— โ–ˆโ–ˆโ•‘โ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ•—  โ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ•”โ•โ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ•—  โ–ˆโ–ˆโ•‘   โ–ˆโ–ˆโ•‘โ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ•”โ•โ–ˆโ–ˆโ•‘  โ–ˆโ–ˆโ–ˆโ•—โ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ•—    ver - 1.0.0
 โ–ˆโ–ˆโ•‘โ–ˆโ–ˆโ–ˆโ•—โ–ˆโ–ˆโ•‘โ–ˆโ–ˆโ•”โ•โ•โ•  โ–ˆโ–ˆโ•”โ•โ•โ–ˆโ–ˆโ•—โ–ˆโ–ˆโ•”โ•โ•โ•  โ–ˆโ–ˆโ•‘   โ–ˆโ–ˆโ•‘โ–ˆโ–ˆโ•”โ•โ•โ–ˆโ–ˆโ•—โ–ˆโ–ˆโ•‘   โ–ˆโ–ˆโ•‘โ–ˆโ–ˆโ•”โ•โ•โ•     ----------
 โ•šโ–ˆโ–ˆโ–ˆโ•”โ–ˆโ–ˆโ–ˆโ•”โ•โ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ•—โ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ•”โ•โ–ˆโ–ˆโ•‘     โ•šโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ•”โ•โ–ˆโ–ˆโ•‘  โ–ˆโ–ˆโ•‘โ•šโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ•”โ•โ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ•—    @ Whoviks
  โ•šโ•โ•โ•โ•šโ•โ•โ• โ•šโ•โ•โ•โ•โ•โ•โ•โ•šโ•โ•โ•โ•โ•โ• โ•šโ•โ•      โ•šโ•โ•โ•โ•โ•โ• โ•šโ•โ•  โ•šโ•โ• โ•šโ•โ•โ•โ•โ•โ• โ•šโ•โ•โ•โ•โ•โ•โ•

๐Ÿš€ Welcome to webforge by whoviks! Forge your web app with ease! ๐ŸŒŸ

? Enter your project name (press Enter or type '.' for 'npm-pack'): ๐Ÿ“ test-app

๐Ÿ“‚ Forging project at 'PATH/test-app'...

? Select your language: ๐Ÿ’ป JavaScript
? What type of web project do you want? ๐Ÿ› ๏ธ MERN Stack

๐ŸŒŸ Setting up frontend in '/PATH/test-app/frontend'...

> create-webforge-app@1.0.0 npx
> create-vite . --template react

โ”‚
โ—‡  Scaffolding project in PATH/test-app/frontend...
โ”‚
โ””  Done. Now run:

  npm install
  npm run dev

โœ” Vite setup completed!

๐ŸŒ Setting up backend in 'PATH/test-app/backend'...

โœ” package.json initialized!
โœ” Express installed!
โœ” MongoDB (mongoose) installed!
โœ” MongoDB configured!
โœ” Server file (server.js) created!
โœ” package.json scripts updated!
? Add extra features to your forge:
 ๐Ÿงฐ Docker ๐Ÿณ, CORS ๐ŸŒ, GraphQL ๐Ÿ“Š, Environment Variables (.env) ๐Ÿ”‘

โœ” Environment variables (.env) configured!
โœ” CORS installed and configured!
โœ” GraphQL installed and configured!
โœ” Docker configured!
โœ” Additional dependencies installed!
? Initialize a Git repository? ๐Ÿ“š Yes

โœ… Git repository initialized!

๐ŸŽ‰ Project 'test-app' forged successfully! ๐Ÿš€

**Instructions**:

- Frontend: cd test-app/frontend && npm install && npm run dev
- Backend: cd test-app/backend && npm install && npm run start

๐Ÿ‘จโ€๐Ÿ’ป Opening 'PATH/test-app' in VS Code...

โœ” VS Code opened successfully!

๐Ÿค Contributing

We โค๏ธ contributions! Whether it's fixing bugs, adding features, or improving documentation, your input is valuable.

How to Contribute

  1. Fork the repository
  2. Create a feature branch:
    git checkout -b feature/your-awesome-feature
  3. Commit your changes:
    git commit -m "Add: Your detailed message"
  4. Push to your branch:
    git push origin feature/your-awesome-feature
  5. Open a Pull Request

๐Ÿ’ก Future Roadmap

๐Ÿ”ฎ Add more frameworks like Svelte & Solid.js\ ๐Ÿ”ฎ Built-in template support for Tailwind & Chakra UI\ ๐Ÿ”ฎ Generate CI/CD pipelines (GitHub Actions) automatically


๐Ÿ“„ License

This project is licensed under the MIT License. See the LICENSE file for details.


Happy Building! ๐Ÿ’ปโœจ

1.0.1

5 months ago

1.0.0

5 months ago