nova-cli 0.2.3 → 0.2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b37fc476c794b5d8ef65085970ceda162fb4e3be7460c621572f4196c2123706
-  data.tar.gz: b301b2eaa9dbf98f9bc788353a7b6f124c3674a428a4692d2c9ca14fd7f1e5b5
+  metadata.gz: 4a92ecdbd773eb5b3be48411c1a947ad1cb8696f4ceeecba783c42cb2f740f1a
+  data.tar.gz: bc9a5f7ef3cdecac0c9b2083f131e5fdad280f918b3e9540a3aeab713a301416
 SHA512:
-  metadata.gz: 4e3b7441eec4ee00b6fe79e63cc510fa40c75661401505ff1d8f0fac4bf270d393525abf2f94f7aa1c4f8196bb9a8db8702ec8ef3b1d9c0562a7cbd6bf7565e7
-  data.tar.gz: 4fe249bd630cc14c9d8d7d42e80cc5313dff4a751bd0fb93464b7c501ba8718ae28197611280ef41e6f299781c9a2edc540ce79ee9020a3c82e69ae506035a35
+  metadata.gz: f4272e18a33a4e86617e7a433bff71c973b3d0f5e015ca1ae85bd430e94408bc3e4723c6f811a9fde0376631580bc32506c1500a3282e4a0b9d93aafdd4d90ef
+  data.tar.gz: 1d4da4a7794282337336560a1e79c5b73a75f11a54bf26db04e0ccc9278a89803bcc1094783acfcf7465434e2935b8de99bd7b739b03ef4b18cf0012ece8a696

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
 
@@ -60,7 +121,7 @@ When you run `nova new [app_name]`, it creates the following structure:
 Nova now includes two foundational tasks by default:
 
 ### Task 1: Generate Application
-- Sets up Rails 8 with PostgreSQL, Tailwind CSS, RSpec, and Cypress
+- Sets up Rails 8 with PostgreSQL, Tailwind CSS, RSpec, and Capybara
 - Configures Flowbite for UI components
 - Creates a hello world page to verify setup
 - Based on battle-tested Rails application setup
@@ -97,34 +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
-
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+Keyboard shortcut to open a preview: cmd+shift+v 
 
-## Best Practices
 
-- **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.
+## 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
 
----
 
-## Prompt Library
+## License
 
-Explore a collection of example prompts for various development tasks in our [Prompt Library](./prompt-library/). These can be adapted for use with AI assistants to help with common setup and generation tasks.
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
 
 ---
 

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)
@@ -49,7 +54,7 @@ You are working in a Nova project that follows a structured product development
 - Keep methods under 10 lines (use POROs if needed)
 - Name POROs as verbs with single `call` method
 - Components should follow design system
-- Write E2E tests with Cypress
+- Write E2E tests with Capybara
 
 ### Task Management
 - Work through tasks sequentially in /tasks

data/lib/nova/templates/tasks_examples/1_generate_application.md

@@ -1,7 +1,7 @@
 # Generate Rails Application
 
 ## Task Overview
-In the code/ directory generate a Rails 8 application with PostgreSQL, Tailwind CSS, Rspec, Flowbite, and Cypress to serve as the foundation for the project.
+In the code/ directory generate a Rails 8 application with PostgreSQL, Tailwind CSS, Rspec, Flowbite, and Capybara to serve as the foundation for the project.
 
 ## Prerequisites
 - Review PRD and technical requirements in ../1_big-picture/
@@ -39,14 +39,14 @@ In the code/ directory generate a Rails 8 application with PostgreSQL, Tailwind
   - [ ] 4.4 Add Flowbite tooltip component to test integration
   - [ ] 4.5 Verify page loads at `http://localhost:3000/hello`
 
-- [ ] 5.0 Set up Cypress for E2E Testing
-  - [ ] 5.1 Install Cypress: `yarn add cypress start-server-and-test --dev`
-  - [ ] 5.2 Create simple E2E test for Hello World page
-  - [ ] 5.3 Add test scripts to package.json
-  - [ ] 5.4 Verify tests run: `yarn test:e2e:open`
+- [ ] 5.0 Set up Capybara for E2E Testing
+  - [ ] 5.1 Configure Capybara in `spec/rails_helper.rb`
+  - [ ] 5.2 Create simple system test for Hello World page in `spec/system/hello_world_spec.rb`
+  - [ ] 5.3 Add selenium-webdriver to Gemfile if not present: `bundle add selenium-webdriver --group test`
+  - [ ] 5.4 Verify tests run: `bundle exec rspec spec/system`
 
 - [ ] 6.0 Final Setup & Verification
-  - [ ] 6.1 Verify all tests pass (RSpec and Cypress)
+  - [ ] 6.1 Verify all tests pass (RSpec including system tests)
   - [ ] 6.2 Verify server starts cleanly: `bin/dev`
   - [ ] 6.3 Create git commit for baseline setup
 
@@ -60,13 +60,13 @@ In the code/ directory generate a Rails 8 application with PostgreSQL, Tailwind
 | `app/javascript/application.js` | JS entry point | 3.2 | ⏳ |
 | `app/controllers/pages_controller.rb` | Static pages controller | 4.1 | ⏳ |
 | `app/views/pages/hello.html.erb` | Hello world view | 4.3 | ⏳ |
-| `cypress/e2e/hello_world_spec.cy.js` | E2E test | 5.2 | ⏳ |
-| `package.json` | Node.js scripts | 5.3 | ⏳ |
+| `spec/system/hello_world_spec.rb` | System test | 5.2 | ⏳ |
 
 ### Files to Modify
 | File Path | Changes | Task Ref | Status |
 |-----------|---------|----------|--------|
 | `config/routes.rb` | Add hello route | 4.2 | ⏳ |
+| `spec/rails_helper.rb` | Configure Capybara | 5.1 | ⏳ |
 
 ## Notes
 - Follow Tailwind v4 documentation as many conventions have changed from v3

data/lib/nova/templates/tasks_examples/2_generate_static_pages.md

@@ -105,7 +105,7 @@ These are NOT throwaway prototype pages. Create production-ready routes, control
 - [ ] 10.0 Testing and Validation
   - [ ] 10.1 Write controller tests
   - [ ] 10.2 Create system tests for user flows
-  - [ ] 10.3 Add E2E tests with Cypress
+  - [ ] 10.3 Add E2E tests with Capybara
   - [ ] 10.4 Test all responsive breakpoints
   - [ ] 10.5 Validate accessibility
 

data/lib/nova.rb

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

metadata

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