local-setup.md

Local Setup

Table of Contents

• Recommended IDE Setup
• Environment Variables
• Customize Configuration
• Project Setup
  • Start Development Server
  • Compile and Minify for Production
  • Run Unit Tests with Vitest
  • Lint with ESLint

Recommended IDE Setup

VSCode + Volar (and disable Vetur).

Environment Variables

S.P.A.R.K. requires the following environment variables to be set in the config/.env file. You can use the config/.env.example file as a guide.

• COPY_AI_TOKEN: Token for accessing CopyAI services.
• COPY_AI_WORKFLOW_ID: ID of the workflow to be used in CopyAI.
• GITHUB_OWNER: The owner of the GitHub repository.
• GITHUB_REPO: The name of the GitHub repository.
• GITHUB_TOKEN: PAT for accessing GitHub services.
• JIRA_TOKEN: PAT for accessing JIRA services.
• JIRA_EMAIL: Email associated with the JIRA account.
• JIRA_DOMAIN: Domain of the JIRA instance.
• JIRA_PROJECT_KEY: Key of the JIRA project.
• JIRA_TEAM_NAMES: Comma-separated list of team names in JIRA.
• JIRA_VERSION_FILTER_PREFIX: Prefix to filter JIRA versions on.
• SPARK_ENABLE_REALTIME_DATA: Flag to enable real-time data fetching.

Customize Configuration

See Vite Configuration Reference.

Project Setup

npm install

Start Server + Client

npm run dev

This command spins up both the Express server and the client application for development, with hot-reload enabled.

Compile and Minify for Production

npm run build

Run Unit Tests with Vitest

npm run test:unit

Lint with ESLint

npm run lint