Skip to content

kyw219/CreatorDeal

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

7 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

CreatorDeal - Forge App

Atlassian Forge application that transforms creator contract documents into executable Jira workflows.

Project Structure

.
├── src/
│   ├── ui/          # React UI components
│   ├── backend/     # Backend processing modules
│   ├── types/       # TypeScript type definitions
│   ├── tests/       # Test files
│   └── index.ts     # Main entry point with Forge resolvers
├── manifest.yml     # Forge app manifest
├── package.json     # Dependencies and scripts
├── tsconfig.json    # TypeScript configuration
└── jest.config.js   # Jest testing configuration

Setup

  1. Install dependencies:
npm install
  1. Build the TypeScript code:
npm run build
  1. Run tests:
npm test
  1. Configure Jira Boards (Recommended):
    • See JIRA_BOARD_SETUP.md for detailed instructions
    • Set up Active Tasks, Blocked Tasks, and Timeline views
    • Optimize user experience with proper filters

Development

  • npm run build - Compile TypeScript
  • npm test - Run Jest tests
  • npm run test:watch - Run tests in watch mode
  • npm run lint - Run ESLint

Forge Commands

  • forge deploy - Deploy the app to development environment
  • forge install - Install the app in a Jira site
  • forge tunnel - Start development tunnel for live updates

Requirements

  • Node.js 18+
  • Forge CLI (install with npm install -g @forge/cli)
  • Atlassian account with Forge app development access

Testing & Demo

Comprehensive testing and demo materials are available:

Quick Start Testing

For a quick 15-minute validation:

# 1. Deploy the app
forge deploy

# 2. Install in your Jira site
forge install

# 3. Follow QUICK_TEST_REFERENCE.md for rapid testing

Demo Preparation

To prepare for a demo:

  1. Review DEMO_SCRIPT.md
  2. Use sample data from TEST_DATA.md
  3. Practice the 7-minute demo flow

See TESTING_SUMMARY.md for complete testing documentation overview.

Privacy Policy

CreatorDeal is committed to protecting your privacy. This section outlines how the app handles data:

Data Collection and Storage

  • Contract Drafts: Temporarily stored in Forge storage to enable auto-save functionality. Drafts are associated with your Jira user account and can be deleted at any time.
  • App Configuration: Stores LLM API keys (Gemini/OpenAI) and Confluence settings in Forge storage. This data is encrypted and only accessible by app administrators.
  • No Personal Data Collection: The app does not collect, store, or transmit personal information beyond what's necessary for Jira/Confluence integration.

Data Usage

  • Contract text and extracted variables are processed in-memory and used solely to create Jira workflows
  • Optional LLM processing (Gemini/OpenAI) sends contract text to third-party APIs only when explicitly enabled
  • Email notifications use SendGrid API and only send data you explicitly approve

Data Retention

  • Draft contracts: Retained until manually deleted or overwritten
  • App configuration: Retained until manually updated or app is uninstalled
  • No data is retained after app uninstallation

Third-Party Services

When enabled, the app may interact with:

  • Google Gemini API: For semantic contract analysis
  • OpenAI API: For semantic contract analysis
  • SendGrid API: For email notifications
  • Atlassian APIs: For Jira/Confluence integration

Your Rights

  • You can delete draft contracts at any time through the app interface
  • You can update or remove API keys through the configuration page
  • Uninstalling the app removes all stored data

For questions or concerns, contact the app owner listed in the Forge distribution page.

Terms of Service

By using CreatorDeal, you agree to the following terms:

Acceptable Use

  • The app is designed for managing creator contract workflows in Jira
  • You are responsible for the accuracy of contract data entered into the app
  • You must have appropriate permissions to create Jira issues and Confluence pages in your workspace

API Keys and External Services

  • You are responsible for obtaining and managing your own API keys (Gemini, OpenAI, SendGrid)
  • API usage and costs are your responsibility
  • The app owner is not liable for third-party service availability or costs

Limitations of Liability

  • The app is provided "as is" without warranties of any kind
  • The app owner is not responsible for data loss, workflow errors, or integration issues
  • You are responsible for validating extracted contract data before creating workflows

Support and Updates

  • Support is provided on a best-effort basis through the contact listed in the distribution page
  • The app may be updated without notice to fix bugs or add features
  • Breaking changes will be communicated through release notes

Termination

  • You may stop using the app at any time by uninstalling it
  • The app owner reserves the right to discontinue the app with reasonable notice

For questions about these terms, contact the app owner listed in the Forge distribution page.


Last Updated: December 22, 2025

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published