🚀 Speedrun Init

A modern, lightning-fast project initializer that creates beautiful JavaScript and TypeScript projects with all the modern tooling you need. Think npm init but supercharged! ⚡

✨ Features

• 🎯 Multiple Templates: API servers and Hello World starters
• 🔧 Language Support: Both JavaScript and TypeScript
• 📝 VS Code Ready: Pre-configured settings and extensions
• 🎨 Code Quality: ESLint and Prettier pre-configured
• 📚 Documentation: Beautiful README files generated
• 🛡️ Error Handling: Robust error handling patterns
• ⚡ Fast Setup: Get coding in seconds, not minutes

🚀 Quick Start

Global Installation

npm install -g speedrun-init
speedrun-init

One-time Use (npx)

npx speedrun-init

Short Command

# After global install, you can use the short alias
sri

🎮 Usage

Simply run the command and follow the interactive prompts:

$ speedrun-init

🚀 Welcome to Project Initializer!
Let's create your new project with modern tooling.

📁 Project name: my-awesome-project
🔧 Language (js/ts) [ts]: ts
📋 Template (api/hello-world) [hello-world]: api

🎯 Creating TS api project: my-awesome-project
✓ Created directory: my-awesome-project
✓ Created directory: my-awesome-project/src
✓ Created directory: my-awesome-project/.vscode
✓ Created file: my-awesome-project/package.json
✓ Created file: my-awesome-project/tsconfig.json
✓ Created file: my-awesome-project/.prettierrc.json
✓ Created file: my-awesome-project/.eslintrc.json
✓ Created file: my-awesome-project/.vscode/settings.json
✓ Created file: my-awesome-project/.vscode/extensions.json
✓ Created file: my-awesome-project/.gitignore
✓ Created file: my-awesome-project/README.md
✓ Created file: my-awesome-project/src/index.ts

🎉 Project created successfully!

📋 Next steps:
   cd my-awesome-project
   npm install
   npm run dev

🌐 Your API will be available at: http://localhost:3000

✨ Happy coding!

📋 Templates

Hello World Template

Perfect for learning or simple scripts:

• Clean, commented starter code
• Error handling examples
• Modern JavaScript/TypeScript patterns

API Template

Production-ready REST API with:

• Express.js server
• Security middleware (Helmet, CORS)
• Request logging (Morgan)
• Health check endpoint
• Robust error handling
• Type-safe responses (TypeScript)

🏗️ Generated Project Structure

TypeScript Project

my-project/
├── src/
│   └── index.ts          # Main application file
├── .vscode/
│   ├── settings.json     # VS Code settings
│   └── extensions.json   # Recommended extensions
├── .eslintrc.json        # ESLint configuration
├── .prettierrc.json      # Prettier configuration
├── tsconfig.json         # TypeScript configuration
├── .gitignore           # Git ignore rules
├── package.json          # Dependencies and scripts
└── README.md            # Project documentation

JavaScript Project

my-project/
├── index.js              # Main application file
├── .vscode/
│   ├── settings.json     # VS Code settings
│   └── extensions.json   # Recommended extensions
├── .eslintrc.json        # ESLint configuration
├── .prettierrc.json      # Prettier configuration
├── .gitignore           # Git ignore rules
├── package.json          # Dependencies and scripts
└── README.md            # Project documentation

🛠️ What's Included

Development Tools

• ESLint: Code linting with sensible defaults
• Prettier: Code formatting that actually works
• TypeScript: Full type safety (TS projects)
• Nodemon: Auto-restart during development

VS Code Integration

• Format on save: Automatic code formatting
• Extension recommendations: Best extensions for your stack
• Optimized settings: Perfect workspace configuration
• IntelliSense: Full autocomplete and type checking

Scripts Ready to Use

{
  "scripts": {
    "dev": "Development server with hot reload",
    "build": "Production build (TypeScript)",
    "start": "Run production build",
    "watch": "Watch mode compilation"
  }
}

🎯 Why Speedrun Init?

Feature	npm init	create-react-app	Speedrun Init
Speed	❌ Manual setup	❌ Heavy/slow	✅ Lightning fast
VS Code Ready	❌ No config	❌ Minimal	✅ Fully configured
Multiple Templates	❌ Basic only	❌ React only	✅ API + more
TypeScript	❌ Manual setup	⚠️ Complex setup	✅ One command
Error Handling	❌ None	❌ Basic	✅ Production ready
Code Quality	❌ Manual setup	⚠️ Basic	✅ ESLint + Prettier

🔧 API Template Features

The API template includes everything you need for a production-ready REST API:

Security

• Helmet.js: Sets security headers
• CORS: Cross-origin resource sharing
• Request size limits: Prevents abuse

Logging & Monitoring

• Morgan: HTTP request logging
• Health check endpoint: /health for monitoring
• Uptime tracking: Built-in metrics

Developer Experience

• Beautiful error responses: Consistent error format
• Environment aware: Different behavior for dev/prod
• Type-safe APIs: Full TypeScript support

Example API Response

{
  "message": "Hello, API World! 🌍",
  "version": "1.0.0",
  "timestamp": "2025-07-02T10:30:00.000Z"
}

🚀 Development

Want to contribute or modify the CLI?

git clone https://github.com/rajuX75/speedrun-init.git
cd speedrun-init
npm link  # Makes it available globally for testing

📝 License

MIT License - feel free to use this in your projects!

🤝 Contributing

1. Fork the repository
2. Create your feature branch (git checkout -b feature/amazing-feature)
3. Commit your changes (git commit -m 'Add some amazing feature')
4. Push to the branch (git push origin feature/amazing-feature)
5. Open a Pull Request

🐛 Issues

Found a bug? Have a feature request? Please open an issue on GitHub!

---

Made with ❤️ for developers who want to start coding, not configuring.