nova-cli 0.2.4 → 0.2.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 53123f326f497bb337df7002d55935867e2f00fc9b19160cd9069c8a42fe4343
-  data.tar.gz: 4041e88ce82242013e0ca9099b042968cf287002b3e359b0491c08863913f939
+  metadata.gz: 151c2a58346e1260b2c7a2248e84e4fa89a72a9226ebcf2773b7b9e79f0a01f2
+  data.tar.gz: 9a43f7115da40d8be57576b01b733e747f2af8bac40cabc96875caca863220fc
 SHA512:
-  metadata.gz: 81696123b344b64628625ed5771a75fcfaa785757926ff78eb731d9c81f46ef0a5204095cccdbd14cf310f430c8001eddca915b7738a7fe03706f675d6041aa4
-  data.tar.gz: 4e966b66be6933036997e6e9c83783c0ea02dc62550f16a26b1a264f4a2a86293df3aad0a9a1de70f67f2f9282845eb3506bd919493595e060101cb0c9fe2b3c
+  metadata.gz: abc1c15c0e9ed2ab91e03febdf970a7fa5897adf4d85fd5e31eb1efba08fc911291cd349ff4e1de295cc5f2707bd791fa671367eed8073800f9567b49e003618
+  data.tar.gz: e41105ee6c2a22717f8f0c1196266304ec904e4363491bc842c0f903b3c0f1531e8d9fc9e45b8fb39377a04f682cdeade4ffcf99474554989f200f414ad8178c

data/README.md

@@ -14,23 +14,84 @@ The Nova process guides product development through a series of steps, each buil
 
 Each step has its own directory with instructions and examples to guide your work.
 
+## Getting Started
+
+### Prerequisites for Product Managers
+
+Before installing Nova, you'll need to set up your development environment. Don't worry - we'll walk you through each step!
+
+#### 1. Install Cursor (Your AI-Powered Code Editor)
+
+1. Download Cursor from [cursor.com/downloads](https://www.cursor.com/downloads)
+2. Choose the version for **Mac Universal** (works on all Macs)
+3. Open the downloaded file and drag Cursor to your Applications folder
+4. Launch Cursor from your Applications
+
+#### 2. Set Up Ruby & Node on Your Mac
+
+Nova requires Ruby to run. Follow this excellent guide to set up your Mac:
+
+**→ [gorails.com/setup/macos/15-sequoia](https://gorails.com/setup/macos/15-sequoia)**
+
+The guide will walk you through:
+- Installing Homebrew (a package manager for Mac)
+- Setting up Ruby with all necessary dependencies
+- Installing Node.js (optional but recommended)
+- Verifying everything is working correctly
+
+> **💡 Pro tip**: The guide takes about 30 minutes to complete. Each step has clear instructions and command examples that you can copy and paste into your Terminal.
+
+That's it! Once you've completed the GoRails setup guide, your Mac will be ready for Nova. 
+
 ## Installation
 
-You can install the gem directly from RubyGems:
+Once you've completed the prerequisites above, you're ready to install Nova!
 
-```bash
-gem install nova-cli
-```
+### Installing Nova
+
+1. **Open Terminal in Cursor**:
+   - In Cursor, press ``Control+` `` to open the integrated terminal
+   - Or go to View → Terminal
 
-Once installed, you can run the command `nova` from your terminal.
+2. **Install the Nova gem**:
+   ```bash
+   gem install nova-cli
+   ```
 
+3. **Verify installation**:
+   ```bash
+   nova --version
+   ```
+
+That's it! Nova is now installed and ready to use. 🚀
 
 ## Usage
 
-```bash
-# Create a new project structure
-nova new [app_name]
-```
+### Creating Your First Nova Project
+
+1. **Navigate to where you want to create your project**:
+   - In Cursor's terminal, navigate to your desired folder
+   - For example, to create projects in your Documents folder:
+     ```bash
+     cd ~/Documents
+     ```
+
+2. **Create a new Nova project**:
+   ```bash
+   nova new my_awesome_app
+   ```
+   Replace `my_awesome_app` with your actual project name (use underscores instead of spaces)
+
+3. **Open your new project in Cursor**:
+   ```bash
+   cd my_awesome_app
+   ```
+   Then in Cursor: File → Open Folder → Select your project folder
+
+4. **Start shaping your product**:
+   - Begin with `shape/1_big-picture/` to define your vision
+   - Work through each step in the Nova process
+   - Let Cursor's AI assist you at every stage!
 
 ## Generated Structure
 
@@ -97,28 +158,28 @@ The AI will understand the Nova workflow and help you maintain proper documentat
 
 ## Mermaid Flowcharts
 
-Nova includes support for creating flowcharts using Mermaid syntax in Markdown. To view and edit these flowcharts in VS Code, you need to install the [Markdown Preview Mermaid Support](https://open-vsx.org/vscode/item?itemName=bierner.markdown-mermaid) extension:
+Nova includes support for creating flowcharts using Mermaid syntax in Markdown. To view and edit these flowcharts, you need to install the [Markdown Preview Mermaid Support](https://open-vsx.org/vscode/item?itemName=bierner.markdown-mermaid) extension:
 
-1. Open VS Code
-2. Go to the Extensions view (Ctrl+Shift+X or Cmd+Shift+X)
+1. Open Cursor
+2. Go to the Extensions view (Cmd+Shift+X)
 3. Search for "Markdown Preview Mermaid Support"
 4. Click Install
 
-You can also install it directly from the VS Marketplace:
-[Markdown Preview Mermaid Support](https://open-vsx.org/vscode/item?itemName=bierner.markdown-mermaid)
-
 With this extension installed, you'll be able to preview Mermaid diagrams in the `flowchart.md` file and any other Markdown files containing Mermaid syntax.
 
-## License
+Keyboard shortcut to open a preview: cmd+shift+v 
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
 
-## Best Practices
+## Cursor Settings
+To be as effective as possible in the Nova process, enable the below settings:
+1. Enable Auto-run Mode: https://share.zight.com/ApuWPA1K
+2. Enable "Play sound on finish": https://share.zight.com/rRuKBlJZ
+3. Include project structure: https://share.zight.com/xQumQDen
+
 
-- **Start with Why**: Always begin by understanding the strategic purpose behind the project from the PRD.
-- **Focus on User Value**: Keep the user's needs (from user stories) at the center of all planning and implementation.
-- **Task Granularity**: Break down features into small, manageable tasks.
-- **Iterate and Refine**: The process is iterative. Revisit and update documents in `shape/` and `progress.md` as you learn and make changes during development.
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
 
 ---
 

data/lib/nova/generator.rb

@@ -51,6 +51,7 @@ module Nova
     def generate
       create_main_directories
       create_all_files_and_directories
+      initialize_shape_git_repo
       display_success_message
     end
 
@@ -149,5 +150,33 @@ module Nova
         create_file_from_template(File.join(app_name, file_entry[:path]), file_entry[:template])
       end
     end
+
+    def initialize_shape_git_repo
+      shape_path = File.join(app_name, 'shape')
+      
+      # Initialize git repository in shape directory
+      Dir.chdir(shape_path) do
+        system('git init', out: File::NULL, err: File::NULL)
+        
+        # Configure git user for initial commit (using system defaults)
+        # This ensures the commit works even if global git config is not set
+        system('git config user.email "nova-cli@example.com"', out: File::NULL, err: File::NULL)
+        system('git config user.name "Nova CLI"', out: File::NULL, err: File::NULL)
+        
+        # Add all files
+        system('git add .', out: File::NULL, err: File::NULL)
+        
+        # Make initial commit
+        system('git commit -m "Initial nova shape documentation structure"', out: File::NULL, err: File::NULL)
+        
+        # Remove the local git config so user's global config takes over
+        system('git config --unset user.email', out: File::NULL, err: File::NULL)
+        system('git config --unset user.name', out: File::NULL, err: File::NULL)
+      end
+      
+      puts "\n✓ Git repository initialized in shape/ directory with initial commit"
+    rescue => e
+      puts "\n⚠ Warning: Could not initialize git repository in shape/ directory: #{e.message}"
+    end
   end
 end

data/lib/nova/templates/nova.mdc

@@ -14,12 +14,17 @@ alwaysApply: true
 You are working in a Nova project that follows a structured product development workflow from abstract ideas to concrete implementation.
 
 ## Project Structure
-- `shape/` - Product documentation (no code here)
+- `shape/` - Product documentation (no code here) - **Has its own git repository**
   - `1_big-picture/` - PRD, flowchart
   - `2_user-stories/` - User stories and their acceptance criteria  
   - `3_design-system/` - UI/UX standards and components
   - `4_tasks/` - Implementation tasks with progress tracking
-- `code/` - Application implementation
+- `code/` - Application implementation - **Each app within has its own git repository**
+
+## Git Repository Structure
+- The `shape/` folder maintains its own git repository for tracking product documentation changes
+- Each application within the `code/` folder has its own separate git repository
+- This separation allows for independent version control of documentation and individual applications
 
 ## Workflow
 1. **Big Picture**: Define PRD and flowchart
@@ -34,7 +39,7 @@ You are working in a Nova project that follows a structured product development
 - Don't write code - documentation only
 - Use Mermaid for diagrams
 - Reference previous sections for traceability
-- Delete example.md files once real files are generated in a given section
+- Delete the example.md file in the current section once a real file is generated in that specific section (e.g., delete example.md in 1_big-picture/ when prd.md is created)
 - Do not advance to the next section until told to do so
 
 ### When in code/ (Implementation)

data/lib/nova.rb

@@ -2,5 +2,5 @@ require_relative 'nova/cli'
 require_relative 'nova/generator'
 
 module Nova
-  VERSION = '0.2.4'
+  VERSION = '0.2.6'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nova-cli
 version: !ruby/object:Gem::Version
-  version: 0.2.4
+  version: 0.2.6
 platform: ruby
 authors:
 - Ryan Francis