@jatinmourya/ng-init 1.0.0

package/CHANGELOG.md

@@ -0,0 +1,129 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [1.0.0] - 2026-01-30
+
+### Added
+
+#### Core Features
+- System environment check displaying Node.js, npm, nvm, and Angular CLI versions
+- Interactive Angular version selection from npm registry
+- Node.js compatibility checking with selected Angular version
+- Smart Node version management with nvm support
+- Node.js installation assistant for systems without nvm
+- Project location configuration (current or custom directory)
+- Complete project initialization with Angular CLI
+
+#### Advanced Features
+- Pre-configured project templates (Basic, Enterprise, PWA, Material, Testing, Standalone)
+- Interactive library search with npm registry autocomplete
+- Real-time package validation and metadata display
+- Popular library bundles (UI Framework, State Management, Forms, Testing, etc.)
+- Configuration presets (TypeScript strict mode, ESLint, Prettier, Husky)
+- Automatic project structure generation (core, shared, features folders)
+- Git repository initialization with .gitignore
+- Documentation generation (README.md, CHANGELOG.md)
+- Profile management system (save, load, export, import configurations)
+
+#### CLI Commands
+- `ng-init` - Main interactive project creation
+- `ng-init create` - Alias for main command
+- `ng-init check` - System version check
+- `ng-init profile list` - List saved profiles
+- `ng-init profile show <name>` - Show profile details
+- `ng-init profile delete <name>` - Delete a profile
+- `ng-init profile export <name> <output>` - Export profile to file
+- `ng-init profile import <file>` - Import profile from file
+- `ng-init examples` - Show usage examples
+
+#### Utility Modules
+- Version checker for system components
+- npm registry search and validation
+- Compatibility checking and resolution
+- Package installation management
+- Interactive prompt handlers
+- File operations and utilities
+- Profile management system
+
+#### Templates & Bundles
+- 6 pre-configured project templates
+- 8 popular library bundles
+- 3 configuration presets
+- Standard and domain-driven project structures
+- Git configuration templates
+- Documentation templates
+
+### Technical Details
+
+#### Dependencies
+- @inquirer/prompts: ^7.10.1
+- axios: ^1.6.5
+- chalk: ^5.3.0
+- commander: ^13.1.0
+- execa: ^9.6.1
+- inquirer: ^9.2.12
+- inquirer-autocomplete-prompt: ^3.0.1
+- lodash.debounce: ^4.0.8
+- ora: ^8.0.1
+- semver: ^7.5.4
+
+#### Supported Platforms
+- Windows (with nvm-windows support)
+- macOS (with nvm support)
+- Linux (with nvm support)
+
+#### Node.js Requirements
+- Minimum: Node.js v18.0.0
+- Recommended: Node.js v18.19.0 or v20.11.0 (LTS)
+
+### Documentation
+- Comprehensive README.md with usage examples
+- Detailed PROJECT_DOCUMENTATION.md with architecture
+- CONTRIBUTING.md with contribution guidelines
+- LICENSE (MIT)
+
+### Initial Release Notes
+
+This is the initial release of Angular Project Automator, a comprehensive CLI tool designed to streamline Angular project initialization with:
+
+- **80% reduction** in project setup time
+- **Zero environment errors** with guided Node.js version management
+- **Intelligent library search** with npm registry integration
+- **Reusable profiles** for team standardization
+- **Best practices** built-in with pre-configured templates
+
+The tool automates the entire project setup process, from checking system prerequisites to creating a fully-configured Angular project with all necessary libraries and tooling.
+
+### Known Limitations
+
+- Windows: Direct Node.js installation requires winget
+- Network required for npm registry access
+- Some features require nvm for full functionality
+
+### Future Plans
+
+#### Phase 2 (Planned)
+- Enhanced library bundles
+- More project templates
+- Additional configuration presets
+- Improved documentation generation
+
+#### Phase 3 (Planned)
+- Advanced Git integration
+- Enhanced profile management
+- Migration assistant
+- Multi-language support
+
+#### Phase 4 (Planned)
+- Dashboard/Analytics
+- Update notifications
+- Cloud sync features
+- Team collaboration features
+
+---
+
+[1.0.0]: https://github.com/jatinmourya/ng-init/releases/tag/v1.0.0

package/CONTRIBUTING.md

@@ -0,0 +1,210 @@
+# Contributing to Angular Project Automator
+
+Thank you for your interest in contributing to Angular Project Automator! This document provides guidelines and instructions for contributing.
+
+## 🌟 How to Contribute
+
+### Reporting Bugs
+
+If you find a bug, please create an issue on GitHub with the following information:
+
+- **Description**: Clear description of the bug
+- **Steps to Reproduce**: Step-by-step instructions
+- **Expected Behavior**: What should happen
+- **Actual Behavior**: What actually happens
+- **Environment**: OS, Node.js version, npm version
+- **Screenshots**: If applicable
+
+### Suggesting Features
+
+We welcome feature suggestions! Please create an issue with:
+
+- **Feature Description**: Clear description of the feature
+- **Use Case**: Why this feature would be useful
+- **Proposed Implementation**: If you have ideas on how to implement it
+- **Examples**: Similar features in other tools
+
+### Pull Requests
+
+1. **Fork the Repository**
+   ```bash
+   git clone https://github.com/jatinmourya/ng-init.git
+   cd ng-init
+   ```
+
+2. **Create a Branch**
+   ```bash
+   git checkout -b feature/your-feature-name
+   ```
+
+3. **Make Your Changes**
+   - Write clean, readable code
+   - Follow existing code style
+   - Add comments for complex logic
+   - Update documentation if needed
+
+4. **Test Your Changes**
+   ```bash
+   npm link
+   ng-init
+   ```
+
+5. **Commit Your Changes**
+   ```bash
+   git add .
+   git commit -m "Add: feature description"
+   ```
+
+   Commit message format:
+   - `Add:` for new features
+   - `Fix:` for bug fixes
+   - `Update:` for updates to existing features
+   - `Docs:` for documentation changes
+   - `Refactor:` for code refactoring
+
+6. **Push to Your Fork**
+   ```bash
+   git push origin feature/your-feature-name
+   ```
+
+7. **Create Pull Request**
+   - Go to the original repository
+   - Click "New Pull Request"
+   - Select your branch
+   - Fill in the PR template
+
+## 📝 Code Style Guidelines
+
+### JavaScript/Node.js
+
+- Use ES6+ syntax
+- Use `import`/`export` for modules
+- Use `async`/`await` for asynchronous operations
+- Use meaningful variable and function names
+- Add JSDoc comments for functions
+- Keep functions small and focused
+
+### Example:
+
+```javascript
+/**
+ * Get package details from npm registry
+ * @param {string} packageName - The name of the package
+ * @returns {Promise<Object|null>} Package details or null if not found
+ */
+export async function getPackageDetails(packageName) {
+    try {
+        const response = await axios.get(`${NPM_REGISTRY_URL}/${packageName}`);
+        return response.data;
+    } catch (error) {
+        return null;
+    }
+}
+```
+
+### File Organization
+
+- Place utilities in `src/utils/`
+- Place templates in `src/templates/`
+- Place command handlers in `src/commands/` (if applicable)
+- Keep related functionality together
+
+## 🧪 Testing
+
+Before submitting a PR:
+
+1. Test the main flow:
+   ```bash
+   ng-init
+   ```
+
+2. Test all commands:
+   ```bash
+   ng-init check
+   ng-init profile list
+   ng-init examples
+   ```
+
+3. Test edge cases:
+   - Invalid inputs
+   - Network errors
+   - Missing dependencies
+
+## 📚 Documentation
+
+- Update README.md if you add features
+- Update PROJECT_DOCUMENTATION.md for architectural changes
+- Add inline comments for complex code
+- Update examples if behavior changes
+
+## 🎯 Areas We Need Help With
+
+- **Templates**: More project templates
+- **Bundles**: Additional library bundles
+- **Testing**: Unit tests and integration tests
+- **Documentation**: Better examples and guides
+- **Platform Support**: Better support for Linux/macOS
+- **Performance**: Optimization and caching
+- **UI/UX**: Better interactive prompts
+
+## 🔍 Code Review Process
+
+1. PRs will be reviewed by maintainers
+2. Feedback will be provided as comments
+3. Make requested changes
+4. Once approved, PR will be merged
+
+## 📋 Development Setup
+
+1. **Clone the repository**
+   ```bash
+   git clone https://github.com/jatinmourya/ng-init.git
+   cd ng-init
+   ```
+
+2. **Install dependencies**
+   ```bash
+   npm install
+   ```
+
+3. **Link for local testing**
+   ```bash
+   npm link
+   ```
+
+4. **Test the CLI**
+   ```bash
+   ng-init
+   ```
+
+5. **Unlink when done**
+   ```bash
+   npm unlink -g ng-init
+   ```
+
+## 🐛 Debugging
+
+Add debug logs:
+```javascript
+console.log(chalk.yellow('[DEBUG]'), 'Your debug message', variable);
+```
+
+Run with verbose output to see all logs.
+
+## 📜 License
+
+By contributing, you agree that your contributions will be licensed under the MIT License.
+
+## 💬 Questions?
+
+- Create an issue for questions
+- Join discussions in GitHub Discussions
+- Contact maintainers directly for sensitive issues
+
+## 🙏 Thank You!
+
+Your contributions make this project better for everyone. Thank you for taking the time to contribute!
+
+---
+
+**Happy Contributing! 🚀**