nova-cli 0.1.0

data/lib/nova/templates/prompts_example.md

@@ -0,0 +1,134 @@
+# Project Implementation Tasks
+
+A list of implementation tasks for the Customer Portal Application.
+
+## 1. Rails Application Setup
+Initialize a Rails 8 application with PostgreSQL, Tailwind CSS, Rspec, and Flowbite. 
+
+```
+rails _8.0.2_ new app_name --database=postgresql --css=tailwind
+cd app_name
+bundle exec rails tailwindcss:install
+bundle exec rails db:create db:migrate
+bundle exec rails rspec:install
+```
+
+Create a Hello World page that is styled with Tailwind CSS and Flowbite (simple tooltip) so we can confirm both are working.
+
+### Flowbite Setup
+Importmap is the default way of handling JavaScript in Rails. In order to support turbo load from importmaps you have to pin the flowbite.turbo.js file from a CDN where the turbo:load event listeners are added instead of load.
+
+Add the following line inside your importmap.rb file:
+pin "flowbite", to: "https://cdn.jsdelivr.net/npm/flowbite@3.1.2/dist/flowbite.turbo.min.js"
+Then you need to import flowbite inside your application.js file:
+import 'flowbite';
+This will enable the interactive elements like dropdowns, modals, and navbars work by hooking the event listeners and actions to the data attributes whenever a new page is loaded in your application.
+
+### Gems
+- Figaro for env variables
+- Decanter for handling incoming params: https://github.com/LaunchPadLab/decanter
+- Active Storage (for file attachments)
+
+Testing:
+- Factory Bot for testing
+- Faker
+- DatabaseCleaner
+- Shoulda Matchers
+- RSpec Rails
+- Capybara
+- SimpleCov
+
+**Related Artifacts:**
+- [PRD](../1_big-picture/prd.md)
+
+## 2. Authentication System
+Implement user registration, login functionality, password reset, and role-based permissions using Devise.
+
+**Related Artifacts:**
+- [Authentication Requirements](../1_big-picture/prd_example.md#authentication)
+- [User Flow](../1_big-picture/flowchart.md#authentication-flow)
+- [Login User Story](../2_user-stories/authentication.md#user-login)
+- [Registration User Story](../2_user-stories/authentication.md#user-registration)
+
+## 3. Core Database Structure
+Design the database schema, create models with associations, set up validations, and implement seed data for development.
+
+**Related Artifacts:**
+- [Data Model Overview](../1_big-picture/prd_example.md#data-model)
+- [Entity Relationship Diagram](../1_big-picture/flowchart.md#entity-relationships)
+- [Data Requirements](../2_user-stories/data_requirements.md)
+
+## 4. Dashboard Implementation
+Create a responsive dashboard with quick stats widgets, activity feed, and notification system.
+
+**Related Artifacts:**
+- [Dashboard Requirements](../1_big-picture/prd_example.md#dashboard)
+- [Dashboard User Story](../2_user-stories/dashboard.md)
+
+## 5. Customer Management
+Build CRUD operations for customer data with search, filtering, detailed views, and history tracking.
+
+**Related Artifacts:**
+- [Customer Management Requirements](../1_big-picture/prd_example.md#customer-management)
+- [Customer User Stories](../2_user-stories/customers.md)
+
+## 6. Document Management
+Implement document upload, versioning, PDF generation for invoices, and document sharing capabilities.
+
+**Related Artifacts:**
+- [Document Management Requirements](../1_big-picture/prd_example.md#document-management)
+- [Document Flow](../1_big-picture/flowchart.md#document-flow)
+- [Document User Stories](../2_user-stories/documents.md)
+
+## 7. Reporting System
+Create report templates with data aggregation, visual charts, and export functionality.
+
+**Related Artifacts:**
+- [Reporting Requirements](../1_big-picture/prd_example.md#reporting)
+- [Report User Stories](../2_user-stories/reports.md)
+
+## 8. API Integration
+Design API endpoints with authentication, third-party integrations, and webhook functionality.
+
+**Related Artifacts:**
+- [API Requirements](../1_big-picture/prd_example.md#api-integration)
+- [Integration Flow](../1_big-picture/flowchart.md#integration-flow)
+- [API User Stories](../2_user-stories/api.md)
+
+## 9. Real-time Features
+Implement WebSocket connections for real-time notifications, collaborative editing, and chat functionality.
+
+**Related Artifacts:**
+- [Real-time Requirements](../1_big-picture/prd_example.md#real-time-features)
+- [Real-time Communication Flow](../1_big-picture/flowchart.md#real-time-flow)
+- [Chat User Story](../2_user-stories/real_time.md#chat)
+- [Notification User Story](../2_user-stories/real_time.md#notifications)
+
+## 10. Performance Optimization
+Implement caching, optimize database queries, set up background job processing, and conduct load testing.
+
+**Related Artifacts:**
+- [Performance Requirements](../1_big-picture/prd_example.md#performance)
+- [System Load Estimates](../1_big-picture/prd_example.md#load-estimates)
+
+## 11. Security Hardening
+Perform security audit, implement security measures, set up monitoring and logging.
+
+**Related Artifacts:**
+- [Security Requirements](../1_big-picture/prd_example.md#security)
+- [Privacy Requirements](../1_big-picture/prd_example.md#privacy)
+- [Security User Stories](../2_user-stories/security.md)
+
+## 12. Deployment & Launch
+Finalize production environment, create deployment scripts, develop rollback procedures, and execute launch.
+
+**Related Artifacts:**
+- [Deployment Strategy](../1_big-picture/prd_example.md#deployment)
+- [Launch Plan](../1_big-picture/prd_example.md#launch-plan)
+- [Rollback Procedures](../1_big-picture/prd_example.md#rollback)
+
+### Production Gems
+- Redis (for caching)
+- Sidekiq (for background jobs)
+- Sentry (for error tracking)
+- Aws S3 (for file storage)

data/lib/nova/templates/prompts_examples/01_generate_app.md

@@ -0,0 +1,94 @@
+# Generate Application
+
+This prompt is for the initial setup of the Rails application with the core dependencies required for the project.
+
+## Task Description
+
+Initialize a Rails 8 application with PostgreSQL, Tailwind CSS, Rspec, Flowbite, and Cypress.
+
+### Steps
+
+1. Create a new Rails application with the following command:
+```
+rails _8.0.2_ new app_name --database=postgresql --css=tailwind
+cd app_name
+bundle exec rails tailwindcss:install
+bundle exec rails db:create db:migrate
+bundle exec rails rspec:install
+```
+
+**Tailwind Note**: Please read the latest v4 docs here before trying to work with Tailwind as a lot has changed since v3 such as the ability to load colors in global.css instead of needing a tailwind config file: https://tailwindcss.com/blog/tailwindcss-v4
+
+Make sure rspec works: `bundle exec rspec`
+
+2. Set up the following gems in the Gemfile:
+
+#### Core Gems
+- Figaro (for environment variables)
+- Decanter (for handling incoming params): https://github.com/LaunchPadLab/decanter
+- Active Storage (for file attachments)
+
+#### Testing Gems
+- Factory Bot Rails
+- Faker
+- DatabaseCleaner
+- Shoulda Matchers
+- RSpec Rails
+- Capybara
+- SimpleCov
+
+#### Production Gems
+- Redis (for caching)
+- Sidekiq (for background jobs)
+- Sentry (for error tracking)
+- AWS S3 SDK (for file storage)
+
+3. Set up Flowbite for interactive components:
+   
+   Importmap is the default way of handling JavaScript in Rails. To support turbo load:
+   
+   Add the following line inside your importmap.rb file:
+   ```ruby
+   pin "flowbite", to: "https://cdn.jsdelivr.net/npm/flowbite@3.1.2/dist/flowbite.turbo.min.js"
+   ```
+   
+   Then import flowbite inside your application.js file:
+   ```javascript
+   import 'flowbite';
+   ```
+
+4. Create a Hello World page with Tailwind CSS and Flowbite to confirm both are working properly:
+   - Include a simple styled page
+   - Add a simple Flowbite component (tooltip) for testing
+
+5. Set up Cypress for headless E2E testing:
+   ```bash
+   yarn add cypress --dev
+   ```
+   
+   Create a simple E2E test for the Hello World page:
+   ```javascript
+   // cypress/e2e/hello_world_spec.cy.js
+   describe('Hello World Page', () => {
+     it('successfully loads', () => {
+       cy.visit('http://localhost:3000')
+       cy.contains('Hello World')
+       cy.get('[data-tooltip-target]').should('exist')
+     })
+   })
+   ```
+   
+   Add script to package.json for headless testing:
+   ```json
+   "scripts": {
+     "test:e2e": "cypress run"
+   }
+   ```
+   
+   Run the test headlessly:
+   ```bash
+   yarn test:e2e
+   ```
+
+## Related Artifacts
+- [PRD](../1_big-picture/prd.md)

data/lib/nova/templates/prompts_examples/02_generate_styleguide.md

@@ -0,0 +1,26 @@
+# Generate Static Styleguide
+
+This prompt is for creating a static styleguide application based on the design system decisions, user stories, PRD, and flowchart.
+
+## Task Description
+
+Using the design decisions from `../3_design-system/design_decisions.md`, create a styleguide within the application (in the code/ directory) that showcase the colors, typography, componentry, and example forms. Please nest all pages within this under /styleguide route as follows:
+- Styleguide Home: /styleguide
+- Colors: /styleguide/colors
+- Typography: /styleguide/typography
+- Componentry: /styleguide/componentry
+- Forms: /styleguide/forms
+- Authenticated Layout: /styleguide/authenticated
+- Unauthenticated Layout: /styleguide/unauthenticated
+
+Create the static styleguide with:
+   - Tailwind CSS for utility-based styling
+   - Flowbite for interactive components (modals, tooltips, etc.)
+   - HTML structure that follows the design system
+
+**Tailwind Note**: Please read the latest v4 docs here before trying to work with Tailwind as a lot has changed since v3 such as the ability to load colors in global.css instead of needing a tailwind config file: https://tailwindcss.com/blog/tailwindcss-v4
+
+## Related Artifacts
+- [PRD](../1_big-picture/prd.md)
+- [Flowchart](../1_big-picture/flowchart.md)
+- [Design Decisions](../3_design-system/design_decisions.md)

data/lib/nova/templates/prompts_examples/03_generate_static_pages.md

@@ -0,0 +1,26 @@
+# Generate Static Front-end Pages
+
+This prompt is for creating the static front-end pages based on the design system, user stories, PRD, and flowchart.
+
+## Task Description
+
+Implement the core static front-end pages for the application using the design system styleguide as a reference.
+
+Using the design system styleguide and flowchart from the big picture directory, implement the following pages:
+- Create the main pages defined in the flowchart
+- Implement layouts using Tailwind CSS classes consistent with the styleguide
+- Add Flowbite components for interactive elements
+- Ensure all pages are responsive and follow the design patterns
+
+For each page:
+- Include proper routing
+- Set up navigation between pages
+- Create placeholder content where dynamic data will eventually be used
+- Implement form structures (without actual functionality yet)
+- Connect the pages with a consistent navigation structure as defined in the flowchart
+
+## Related Artifacts
+- [PRD](../1_big-picture/prd.md)
+- [Design System](../3_design-system/design_decisions.md)
+- [Flowchart](../1_big-picture/flowchart.md)
+- [User Stories](../2_user-stories/)

data/lib/nova/templates/prompts_examples/04_authentication_feature.md

@@ -0,0 +1,41 @@
+# Authentication Feature Implementation
+
+This prompt is for implementing the authentication system for the application.
+
+## Task Description
+
+Implement a complete user authentication system with registration, login, password reset, and role-based permissions using Devise.
+
+### Steps
+
+1. Add and configure Devise gem for Rails authentication:
+   - Install Devise
+   - Generate User model with appropriate attributes
+   - Configure Devise modules (registerable, recoverable, rememberable, validatable)
+   - Set up role-based authorization
+
+2. Customize authentication views to match the application design:
+   - Override Devise default views
+   - Apply the design system styles from the styleguide
+   - Implement form validations with appropriate error messages
+
+3. Implement additional authentication features:
+   - Email verification
+   - Password reset flow
+   - Remember me functionality
+   - Session management
+
+4. Add role-based access controls:
+   - Create role-based permissions system
+   - Implement policies for different user types
+   - Add authorization checks to controllers and views
+
+5. Create user profile management:
+   - Profile editing functionality
+   - Account settings
+   - Password change forms
+
+## Related Artifacts
+- [Authentication Requirements](../1_big-picture/prd.md#authentication)
+- [User Flow](../1_big-picture/flowchart.md#authentication-flow)
+- [Design System](../3_design-system/design_decisions.md)

data/lib/nova/templates/prompts_readme_template.md

@@ -0,0 +1,27 @@
+# Development Prompts
+
+This directory contains a list of development prompts for implementing your application based on the planning documents.
+
+## Purpose
+
+Development prompts help create a logical sequence for building your application, making it easier to communicate implementation needs to developers or AI assistants.
+
+## How to Use
+
+1. Create separate prompt files for each major development phase:
+    - `01_generate_app.md` - Initial application setup with core dependencies
+    - `02_generate_styleguide.md` - Design system implementation
+    - `03_generate_static_pages.md` - Core pages based on the flowchart in the big picture directory
+    - Feature-specific prompts (e.g., `04_authentication.md`, `05_dashboard.md`, etc.)
+2. For each prompt file:
+    - Follow the structure in the examples directory
+    - Reference the PRD for technology stack guidance and requirements
+    - Link relevant artifacts within each prompt so that the AI Agent can understand the context and dependencies
+3. When ready to implement, use each prompt file individually with the AI Agent
+4. If an issue occurs during the implementation, work with the AI Agent to correct the documentation and prompt, then re-prompt the AI Agent
+
+Note: for 01_generate_app, 02_generate_styleguide, and 03_generate_static_pages prompts, follow the examples provided exactly unless the user explicitly tells you otherwise.
+
+## Example
+
+See `prompts_example.md` in this directory for an example of how to structure your development task list.

data/lib/nova/templates/readme_template.md

@@ -0,0 +1,74 @@
+# Product Development Workflow
+
+Welcome to the Product Documentation for [project name]! This repository contains a structured workflow for planning, designing, and implementing product features.
+
+---
+
+## The Nova Process
+
+The Nova process guides product development through a series of steps, each building on the previous one to create a comprehensive plan for implementation:
+
+1. **Big Picture** → Define the strategic vision and goals
+2. **User Stories** → Break down the vision into specific user needs
+3. **Design System** → Establish the visual language and UI components
+4. **AI Dev Prompts** → Create development prompts for AI-assisted development
+
+Each step has its own directory with specialized templates and examples to guide your work.
+
+---
+
+## Directory Structure
+
+```
+[project_name]/
+├── nova/
+│   ├── README.md
+│   ├── 1_big-picture/
+│   │   ├── README.md
+│   │   ├── prd_example.md
+│   │   ├── flowchart.md
+│   ├── 2_user-stories/
+│   │   ├── README.md
+│   │   └── example.md
+│   ├── 3_design-system/
+│   │   ├── README.md
+│   │   └── design_decisions.md
+│   ├── 4_prompts/
+│   │   ├── README.md
+│   │   └── example.md
+├── code/
+```
+
+---
+
+## Getting Started
+
+1. Start with the **1_big-picture** directory to define the project's foundation
+2. Work through each numbered step in sequential order
+3. Each directory contains:
+   - **README.md**: Instructions and best practices for that step
+   - **template.md**: A starting point for creating new documents
+   - **example.md**: A reference showing how completed documents should look
+
+Follow the guidance in each README to create a comprehensive product development plan.
+
+---
+
+## Best Practices
+
+- **Start with Why**: Always begin by understanding the strategic purpose behind the project
+- **Focus on User Value**: Keep the user's needs at the center of all planning
+- **Be Specific**: Include enough detail for implementation but avoid over-specification
+- **Maintain Traceability**: Ensure each document references related documents from previous steps
+- **Collaborate Across Disciplines**: Involve all relevant team members in the appropriate steps
+- **Iterate and Refine**: The process is not strictly linear - revisit and update documents as you learn
+
+---
+
+## Additional Resources
+
+- **Nova Gem Documentation**: [Link to documentation]
+- **Product Planning Best Practices**: [Link to resources]
+- **AI Development Guidelines**: [Link to guidelines]
+
+For questions or suggestions to improve this process, please contact Ryan Francis (ryan@launchpadlab.com).