rapid_stack 1.0.0 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bdde5f7c51f17a733e104895a2ddf242d5101d5c9121c4e6b331efaca0b4848f
-  data.tar.gz: 8bd674820d89d181fc27ac5613ebdd98a4a570734033c54dbf6dfbf3fc9dfc51
+  metadata.gz: 91b7690fd2f6a9d4e41685ec37ae786895a82d6bcaf270f006299c1009db48de
+  data.tar.gz: ce7aa5e90726a083ec35f41fec2990a1dfcbdc051d3984f12082a26eca342594
 SHA512:
-  metadata.gz: 64139a37b7f925b1e1d6d134b16c6275198d5107f5e93dbe70901c4f6f5e26769836387443bf8309666924b86e18f86f6404244a5796233a5d7db8c2dba6726f
-  data.tar.gz: 6848bff035fbe44892fc7ff0e6e21329612eca7e8534e4a4e71f27ce0f15f38c293e1ae14e5deb3d6f32bf1948063baa996aafc77760e9b094445c417f706ecb
+  metadata.gz: 7a7cef8dc68caffab433ca60721ecb28f62acbe64ed9583e9d9b9d955259d9b603b576c07fd9d1dcb5c357f51d1129d9103cea73dd6a9b20b38bf46b821377c6
+  data.tar.gz: 24b34eaf4c38ba7062b156a064d56b555321757e0813688d27a3c1acb7cbf033c4de1d198ea303093ed4213bf762be5ef16ab234da7c08504386bcc1e35d7894

data/CHANGELOG.md

@@ -1,3 +1,15 @@
+## [1.0.2] - 2025-03-27
+### Changed
+- Changed wrong formatting on gemspec
+
+## [1.0.1] - 2025-03-27
+### Added
+- rapid init can now automatically install git and gh
+
+### Changed
+- Add automatic changelog to release script
+- Add commit message convention to README
+
 ## [1.0.0] - 2025-03-26
 ### Added
 - Make generators idempotent

data/README.md

@@ -56,10 +56,94 @@ Think of it as your development blueprint that ensures consistency, accelerates
 
 ## Prerequisites
 
+### Required Dependencies
+These must be installed before using RapidStack:
+
+- Unix-based system (Linux, MacOS)
+- At least 8GB of RAM (16GB recommended)
+- At least 25GB of free disk space
+- Modern web browser (Chrome, Firefox, Edge)
+- Git
 - Ruby 3.3.1
 - Node.js 20+
-- Docker and Docker Compose
+- Docker Desktop
+- Docker Compose
+- Digital Ocean account
+- DO CLI
+
+### Optional Dependencies
+These can be installed during the setup process:
+
+- Ruby on Rails 8+
+- MongoDB & MongoDB Compass
+- Angular CLI & Ionic CLI
+- GraphQL CLI tools
+- Terraform
+- Ansible
+- Nginx
+- HashiCorp Vault
+- Portainer
+- Graylog
+- RSpec
+- Jest
+- SCSS compiler
+- TypeScript compiler
+- Github CLI
+- Certbot
+- Insomnia
+- Apollo
+- Cursor/VSCode
+
+## System Requirements
+
+### Core Dev Tools
 - Git
+- Github CLI
+- Node.js 20+
+- npm
+- Angular CLI
+- Ionic CLI
+
+### Backend Development
+- Ruby on Rails 8+
+- MongoDB
+- GraphQL CLI tools
+- RSpec (for testing)
+- Ruby (3.3.1)
+- MongoDB Compass
+
+### Frontend Development
+- Angular
+- Ionic
+- SCSS compiler
+- Typescript compiler
+- Jest (for testing)
+
+### Devops & Infrastructure
+- Docker (Docker Desktop)
+- Docker Compose (for multi-container applications)
+- Terraform (for infrastructure as code)
+- Ansible (for configuration management)
+- Nginx (for reverse proxy)
+- HashiCorp Vault (for secrets management)
+- Portainer (for Docker)
+- Github Actions
+- Graylog (for logging)
+- Digital Ocean (for hosting)
+- DO CLI (for Digital Ocean)
+
+### Security & Secrets Management
+- HashiCorp Vault
+- Github Secrets
+- Certbot (for SSL certificates)
+
+### API Development
+- Insomnia
+- Apollo
+
+### Text Editors
+- Cursor
+- VSCode
 
 ## Installation
 
@@ -73,7 +157,6 @@ gem install rapid_stack
 rapid_stack_setup
 ```
 
-
 ## Using Generators
 
 After installing the generators, you can use the following commands:
@@ -96,10 +179,37 @@ rapid
 
 1. Fork the repository
 2. Create your feature branch (`git checkout -b feature/amazing-feature`)
-3. Commit your changes (`git commit -am 'Add some amazing feature'`)
+3. Commit your changes following the commit message conventions below
 4. Push to the branch (`git push origin feature/amazing-feature`)
 5. Open a Pull Request
 
+### Commit Message Conventions
+
+When contributing to RapidStack, follow these commit message conventions to ensure proper changelog generation:
+
+```bash
+# Format: <type>: <description>
+
+# Examples of git commit commands:
+git commit -m "feat: Add new GraphQL mutation for user creation"
+git commit -m "fix: Resolve authentication token expiration issue"
+git commit -m "change: Update Docker configuration for better performance"
+git commit -m "remove: Remove deprecated API endpoint"
+```
+
+The commit message types and their corresponding changelog sections:
+
+- `feat:` - New features (Added section)
+- `fix:` - Bug fixes (Fixed section)
+- `change:` - Changes and improvements (Changed section)
+- `remove:` - Removed features (Removed section)
+
+When you run `release.rb`, it will automatically:
+1. Collect all commits since the last tag
+2. Parse commit messages following these conventions
+3. Generate appropriate changelog entries
+4. Show you the changes it found for confirmation
+
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/rapid_stack/generators/generator-rapid/generators/init/index.js

@@ -1,13 +1,166 @@
 const Generator = require('yeoman-generator');
 const path = require('path');
 const fs = require('fs');
+const VersionChecker = require('./lib/version-checker');
+const GitInstaller = require('./lib/git-installer');
+const GitHubCliInstaller = require('./lib/github-cli-installer');
+const PackageManager = require('./lib/package-manager');
+const yaml = require('js-yaml');
 
 module.exports = class extends Generator {
   constructor(args, opts) {
     super(args, opts);
+    this.versionChecker = new VersionChecker();
+    this.gitInstaller = new GitInstaller();
+    this.githubCliInstaller = new GitHubCliInstaller();
+    this.packageManager = new PackageManager();
   }
 
   async prompting() {
+    // Check if running on a Unix-like system
+    if (process.platform === 'win32') {
+      console.log('\n❌ Error: This tool requires a Unix-like operating system (macOS, Linux, or WSL)');
+      console.log('\nTo use this tool on Windows, you have two options:');
+      console.log('1. Use Windows Subsystem for Linux (WSL)');
+      console.log('   - Install WSL from: https://docs.microsoft.com/en-us/windows/wsl/install');
+      console.log('   - Run this tool from within WSL');
+      console.log('\n2. Use a virtual machine');
+      console.log('   - Install VirtualBox or VMware');
+      console.log('   - Create a virtual machine with Ubuntu or macOS');
+      console.log('   - Run this tool from within the virtual machine');
+      
+      const { retry } = await this.prompt([
+        {
+          type: 'confirm',
+          name: 'retry',
+          message: 'Would you like to try again after setting up a Unix-like environment?',
+          default: true
+        }
+      ]);
+
+      if (!retry) {
+        process.exit(1);
+      }
+      return;
+    }
+
+    // Check for GitHub account
+    let hasGitHubAccount = false;
+    while (!hasGitHubAccount) {
+      const { hasAccount } = await this.prompt([
+        {
+          type: 'confirm',
+          name: 'hasAccount',
+          message: 'Do you have a GitHub account?',
+          default: true
+        }
+      ]);
+
+      if (!hasAccount) {
+        console.log('\n⚠️ A GitHub account is required to use this tool.');
+        console.log('\nPlease create a GitHub account:');
+        console.log('1. Visit https://github.com/signup');
+        console.log('2. Follow the signup process');
+        console.log('3. Return here to continue');
+        
+        const { retry } = await this.prompt([
+          {
+            type: 'confirm',
+            name: 'retry',
+            message: 'Would you like to try again after creating a GitHub account?',
+            default: true
+          }
+        ]);
+
+        if (!retry) {
+          process.exit(1);
+        }
+      } else {
+        hasGitHubAccount = true;
+      }
+    }
+
+    // Display version comparison
+    this.versionChecker.displayVersionComparison();
+
+    // Check and update Git if needed
+    const gitVersion = this.gitInstaller.getCurrentVersion();
+    if (!gitVersion || !this.versionChecker.compareVersions(gitVersion, this.versionChecker.minVersions.git)) {
+      console.log('\n⚠️ Git version check failed');
+      const { updateGit } = await this.prompt([
+        {
+          type: 'confirm',
+          name: 'updateGit',
+          message: 'Would you like to update Git?',
+          default: true
+        }
+      ]);
+
+      if (updateGit) {
+        const result = await this.gitInstaller.update();
+        if (!result.success) {
+          console.log('\n⚠️ Git update failed:', result.error);
+          if (result.needsManualUpdate) {
+            console.log('Please update Git manually from https://git-scm.com/downloads');
+          }
+          process.exit(1);
+        }
+      } else {
+        console.log('\n⚠️ Git update skipped. Please update Git manually from https://git-scm.com/downloads');
+        process.exit(1);
+      }
+    }
+
+    // Check and update GitHub CLI if needed
+    const ghVersion = this.githubCliInstaller.getCurrentVersion();
+    if (!ghVersion) {
+      console.log('\n⚠️ GitHub CLI is not installed');
+      const { installGh } = await this.prompt([
+        {
+          type: 'confirm',
+          name: 'installGh',
+          message: 'Would you like to install GitHub CLI?',
+          default: true
+        }
+      ]);
+
+      if (installGh) {
+        const result = await this.githubCliInstaller.install();
+        if (!result.success) {
+          console.log('\n⚠️ GitHub CLI installation failed:', result.error);
+          console.log('Please install GitHub CLI manually from https://cli.github.com/');
+          process.exit(1);
+        }
+      } else {
+        console.log('\n⚠️ GitHub CLI installation skipped. Please install GitHub CLI manually from https://cli.github.com/');
+        process.exit(1);
+      }
+    } else if (!this.versionChecker.compareVersions(ghVersion, this.versionChecker.minVersions.gh)) {
+      console.log('\n⚠️ GitHub CLI version check failed');
+      const { updateGh } = await this.prompt([
+        {
+          type: 'confirm',
+          name: 'updateGh',
+          message: 'Would you like to update GitHub CLI?',
+          default: true
+        }
+      ]);
+
+      if (updateGh) {
+        const result = await this.githubCliInstaller.update();
+        if (!result.success) {
+          console.log('\n⚠️ GitHub CLI update failed:', result.error);
+          if (result.needsManualUpdate) {
+            console.log('Please update GitHub CLI manually from https://cli.github.com/');
+          }
+          process.exit(1);
+        }
+      } else {
+        console.log('\n⚠️ GitHub CLI update skipped. Please update GitHub CLI manually from https://cli.github.com/');
+        process.exit(1);
+      }
+    }
+
     let fullPath;
     let confirmed = false;
 
@@ -94,45 +247,16 @@ module.exports = class extends Generator {
     const folderName = path.basename(fullPath);
     const configPath = path.join(rapidStackDir, `${folderName}_project.yml`);
 
-    if (fs.existsSync(configPath)) {
-      const confirmOverwrite = await this.prompt([
-        {
-          type: 'confirm',
-          name: 'overwrite',
-          message: 'Configuration file already exists. Do you want to proceed with the existing configuration?',
-          default: true
-        }
-      ]);
-
-      if (confirmOverwrite.overwrite) {
-        // Skip file creation and show next steps
-        console.clear();
-        console.log('\n' + '='.repeat(80));
-        console.log('✨ Using existing configuration!');
-        console.log('='.repeat(80));
-        
-        console.log('\n📁 Project Directory:');
-        console.log(`   ${fullPath}`);
-        
-        console.log('\n📋 Next Steps:');
-        console.log('1. Change to your project directory:');
-        console.log(`   cd ${fullPath}`);
-        console.log('\n2. Build your backend application:');
-        console.log('   yo rapid:build-backend');
-        
-        console.log('\n' + '='.repeat(80) + '\n');
-        process.exit(0);
-      }
-    }
-
     // Store all answers
     this.answers = { 
       fullPath,
-      app_name: appAnswer.app_name
+      app_name: appAnswer.app_name,
+      configPath,
+      usingExistingConfig: fs.existsSync(configPath)
     };
   }
 
-  writing() {
+  async writing() {
     const homeDir = process.env.HOME || process.env.USERPROFILE;
     const rapidStackDir = path.join(homeDir, '.rapid_stack');
     
@@ -142,6 +266,57 @@ module.exports = class extends Generator {
       this.log(`Created .rapid_stack directory: ${rapidStackDir}`);
     }
 
+    // Display version comparison
+    const issues = this.versionChecker.displayVersionComparison();
+
+    // If there are issues, ask if user wants help installing
+    const hasIssues = issues.missing.length > 0 || issues.outdated.length > 0;
+    if (hasIssues) {
+      const answers = await this.prompt([
+        {
+          type: 'confirm',
+          name: 'installMissing',
+          message: 'Would you like me to help you install missing or outdated tools?',
+          default: true
+        }
+      ]);
+
+      if (answers.installMissing) {
+        // Handle Git updates first
+        const gitVersion = this.versionChecker.getCommandVersion('git');
+        const minGitVersion = this.versionChecker.minVersions.git;
+        
+        if (gitVersion === 'N/A') {
+          this.log('\n❌ Git is not installed. Please install Git first.');
+        } else if (!this.versionChecker.compareVersions(gitVersion, minGitVersion)) {
+          this.log(`\n⚠️ Git version ${gitVersion} is outdated. Minimum required version is ${minGitVersion}`);
+          const gitUpdateResult = await this.gitInstaller.update();
+          if (!gitUpdateResult.success) {
+            this.log('\n⚠️ Failed to update Git. Please update it manually.');
+          }
+        }
+      }
+    }
+
+    // If using existing config, show appropriate message
+    if (this.answers.usingExistingConfig) {
+      console.log('\n' + '='.repeat(80));
+      console.log('✨ Using existing configuration!');
+      console.log('='.repeat(80));
+      
+      console.log('\n📁 Project Directory:');
+      console.log(`   ${this.answers.fullPath}`);
+      
+      console.log('\n📋 Next Steps:');
+      console.log('1. Change to your project directory:');
+      console.log(`   cd ${this.answers.fullPath}`);
+      console.log('\n2. Build your backend application:');
+      console.log('   yo rapid:build-backend');
+      
+      console.log('\n' + '='.repeat(80) + '\n');
+      return;
+    }
+
     // Create project directory if it doesn't exist
     if (!fs.existsSync(this.answers.fullPath)) {
       fs.mkdirSync(this.answers.fullPath, { recursive: true });
@@ -152,20 +327,16 @@ module.exports = class extends Generator {
     process.chdir(this.answers.fullPath);
     this.log(`Changed to directory: ${this.answers.fullPath}`);
 
-    const folderName = path.basename(this.answers.fullPath);
-    const configPath = path.join(rapidStackDir, `${folderName}_project.yml`);
-
     // Use Yeoman's templating system
     this.fs.copyTpl(
       this.templatePath('project.yml'),
-      this.destinationPath(configPath),
+      this.destinationPath(this.answers.configPath),
       {
         app_name: this.answers.app_name
       }
     );
 
     // Show success message
-    console.clear();
     console.log('\n' + '='.repeat(80));
     console.log('✨ Project initialized successfully!');
     console.log('='.repeat(80));
@@ -174,7 +345,7 @@ module.exports = class extends Generator {
     console.log(`   ${this.answers.fullPath}`);
     
     console.log('\n📝 Configuration File Location:');
-    console.log(`   ${configPath}`);
+    console.log(`   ${this.answers.configPath}`);
     
     console.log('\n📋 Next Steps:');
     console.log('1. Open the configuration file in your preferred text editor');