jira-pat 1.0.3 → 1.0.4

package/README.md

@@ -1,135 +1,120 @@
 # Jira Dashboard
 
-A fast, lightweight, and modern Jira Dashboard built with React, Vite, and Node.js. It avoids CORS and proxy issues by connecting directly to the Jira Cloud API using Basic Authentication within a dedicated Express backend.
-
-## Features
-
-1.  **Direct Jira Cloud Integration**: Connects to the Jira REST API securely via an Express backend.
-2.  **CLI Configuration**: Easy setup with the built-in `jira` CLI tool.
-3.  **Dynamic Filtering**: Filter by project, status, or keyword.
-4.  **Interactive Issue View**: 
-    - Full issue details in a side drawer or standalone page.
-    - Rich text rendering (Markdown/ADF to HTML).
-    - Proxying of Jira-hosted images and attachments.
-    - Status transitions and user assignment.
-    - File uploads directly to Jira tickets.
-5.  **Subtasks & Linked Issues**: Visualize and navigate between related tickets.
-6.  **Backend Caching**: 60-second in-memory caching for performance and API rate-limiting compliance.
-7.  **Fully Tested**: Comprehensive unit and integration tests for both frontend and backend.
-8.  **Error Handling**: Robust error boundaries and toast notifications for a smooth experience.
+View and manage your Jira tickets from a simple dashboard — no need to navigate Jira itself.
 
 ---
 
-## Getting Started
+## Before You Begin
 
-### Prerequisites
+You'll need three things set up before you can use the dashboard. This only takes about 5 minutes.
 
-- Node.js (v18 or higher recommended)
-- An Atlassian account with a Jira Cloud instance
-- A Jira API Token ([Get one here](https://id.atlassian.com/manage-profile/security/api-tokens))
+### 1. Node.js (a behind-the-scenes engine)
 
-### Installation & Setup
+The dashboard needs Node.js installed on your computer to run. You don't need to know what it does — just think of it as a required engine.
 
-1.  **Download & Install**:
-    ```bash
-    git clone https://github.com/yourusername/jira-dashboard.git
-    cd jira-dashboard
-    npm install
-    ```
+**Check if you already have it:**
+1. Open **Terminal** (Mac) or **Command Prompt** (Windows)
+   - Mac: Press `Cmd + Space`, type *Terminal*, hit Enter
+   - Windows: Press `Win + R`, type *cmd*, hit Enter
+2. Type `node --version` and press Enter
+3. If you see something like `v18.0.0` or higher, you're all set ✅
 
-2.  **Configure your Account**:
-    Run the setup tool to connect your Jira account:
-    ```bash
-    npm link # Optional: allows you to just type 'jira'
-    jira config
-    ```
-    Follow the prompts to enter your **Jira URL**, **Email**, and **API Token**.
-
-3.  **Launch the App**:
-    ```bash
-    npm start
-    ```
-    Your browser should automatically open to `http://localhost:5000`.
+**If you don't have it:**
+1. Go to [nodejs.org](https://nodejs.org)
+2. Click the big **"LTS"** download button (LTS = most stable version)
+3. Install it like any other program
+4. Close and reopen your Terminal window before continuing
 
 ---
 
-## Using the Dashboard (User Guide)
+### 2. A Jira API Token (your secure password for the app)
+
+Instead of using your Jira password directly, you'll create a special token just for this app. It's safer and easy to remove if needed.
 
-Once the dashboard is open, here is how you can manage your work:
+**How to create one:**
+1. Go to [Atlassian API Token page](https://id.atlassian.com/manage-profile/security/api-tokens)
+2. Click **"Create API token"**
+3. Give it any name — for example, *Jira Dashboard*
+4. Click **"Create"**, then **copy the token** that appears
+5. Paste it somewhere safe (like a note on your computer) — you'll need it in the next section and **won't be able to see it again**
 
-### 1. Finding Your Work
-*   **Default View**: When you log in, you will see all issues currently assigned to you.
-*   **Search**: Use the search bar at the top to find specific tickets by typing their title or description. (Tip: Press `/` to jump to search).
-*   **Filters**: Use the **Project** and **Status** dropdowns to narrow down your list (e.g., only show "In Progress" tasks for project "ABC").
+---
 
-### 2. Viewing and Updating Issues
-*   **Open Details**: Click on any row in the table. A side panel will slide out with the full description and comments.
-*   **Change Status**: Inside the panel, click the status button (like "To Do") to move the ticket to a new stage (like "Done").
-*   **Reassign**: Click the user's name or avatar to search for and assign the ticket to someone else.
-*   **Add Attachments**: Drag and drop files directly onto the "Upload" area in the side panel to add them to the Jira ticket.
+### 3. Your Jira URL
 
-### 3. Creating New Issues
-*   Click the blue **+** button in the top right corner.
-*   Select the **Project** and **Issue Type** (e.g., Task, Bug).
-*   Enter a **Summary** and click **Create**. The ticket is instantly added to your Jira instance.
+This is the web address you normally type to get to Jira at work. It usually looks like one of these:
+- `https://yourcompany.atlassian.net`
+- `https://jira.yourcompany.com`
 
 ---
 
-## Development (Technical)
+## Setup & Launch
 
-### Running the Backend (API)
-```bash
-cd backend
-npm start
-```
-The API runs on `http://localhost:5000`.
+### Step 1 — Run the one-time setup
 
-### Running the Frontend (Vite)
+Open Terminal (or Command Prompt) and paste this, then press Enter:
 ```bash
-cd frontend
-npm run dev
+npx jira-pat config
 ```
-The frontend runs on `http://localhost:5173` (proxies `/api` to port 5000).
+
+It will ask you for three things:
+- **Jira URL** — the address from Step 3 above
+- **Email** — the email you use to log into Jira
+- **API Token** — the token you created in Step 2
+
+> 🔒 Your details are saved only on your computer and are never sent anywhere else.
+
+**Where your details are saved (for your reference):**
+- Mac/Linux: `~/.jira-dashboard-config.json`
+- Windows: `C:\Users\YourName\.jira-dashboard-config.json`
 
 ---
 
-## Testing
+### Step 2 — Start the dashboard
 
-### Run All Tests
+Each time you want to use the dashboard, run:
 ```bash
-npm test
+npx jira-pat
 ```
 
-### Backend Tests
-```bash
-cd backend
-npm test
+Your browser should open automatically. If it doesn't, open your browser and go to:
 ```
-
-### Frontend Tests
-```bash
-cd frontend
-npm test
+http://localhost:5173
 ```
 
 ---
 
-## Project Structure
+## Using the Dashboard
 
-```
-jira-dashboard/
-├── bin/                  # CLI setup and start scripts
-├── backend/              # Node.js + Express API Layer
-│   ├── routes/           # API Endpoints (Issues, Projects)
-│   ├── service/          # Jira API integration logic
-│   └── __tests__/        # Backend test suite
-│
-└── frontend/             # React + Vite UI
-    ├── src/
-    │   ├── components/   # React components (Table, Drawer, Modals)
-    │   ├── hooks/        # Custom React hooks (Data fetching, UI state)
-    │   └── __tests__/    # Frontend test suite
-```
+### Finding your tickets
+
+- When you open the dashboard, you'll see all tickets currently assigned to you.
+- Use the **search bar** at the top to look up a ticket by keyword. Tip: press `/` on your keyboard to jump straight to it.
+- Use the **Project** and **Status** dropdowns to filter the list down to what you need.
+
+### Viewing and updating a ticket
+
+- **Click any row** to open a side panel with the full details.
+- **Change the status** by clicking the status label (e.g. *In Progress*, *Done*).
+- **Reassign** a ticket by clicking the assignee's name and searching for someone else.
+- **Attach a file** by dragging and dropping it onto the side panel.
+
+### Creating a new ticket
+
+1. Click the blue **+** button in the top-right corner.
+2. Choose a **Project** and **Issue Type** (Task, Bug, Story, etc.).
+3. Write a short **Summary** and click **Create**.
+
+---
+
+## Something Not Working?
+
+| What you're seeing | What to try |
+|--------------------|-------------|
+| *"command not found"* | Node.js isn't installed — go back to Step 1 |
+| *"Cannot connect to Jira"* | Check your Jira URL, email, and API token — run `npx jira-pat config` again |
+| *"Port already in use"* | Close other apps or browser tabs that might be using ports 5000 or 5173 |
+| Browser doesn't open | Manually go to `http://localhost:5173` in your browser |
 
 ---
 

package/backend/index.js

@@ -46,18 +46,28 @@ app.get('/api/health', (req, res) => {
 });
 
 // Serve frontend static files
-const frontendDist = path.join(__dirname, '../frontend/dist');
+const frontendDist = path.resolve(__dirname, '..', 'frontend', 'dist');
+console.log('--- Static Assets Setup ---');
+console.log('Searching for frontend at:', frontendDist);
+
 if (require('fs').existsSync(frontendDist)) {
-    console.log('Serving frontend from:', frontendDist);
+    console.log('✅ Frontend dist found. Serving static files.');
     app.use(express.static(frontendDist));
     
-    // Catch-all for SPA: If no other route matches (and it's not an API call), serve index.html
     app.use((req, res, next) => {
         if (!req.path.startsWith('/api') && req.method === 'GET') {
-            return res.sendFile(path.join(frontendDist, 'index.html'));
+            const indexPath = path.resolve(frontendDist, 'index.html');
+            if (require('fs').existsSync(indexPath)) {
+                return res.sendFile(indexPath);
+            } else {
+                console.error('❌ Error: index.html not found even though dist exists!');
+                return res.status(404).send('Dashboard files missing (index.html)');
+            }
         }
         next();
     });
+} else {
+    console.warn('⚠️ Warning: frontend/dist directory NOT found at ' + frontendDist);
 }
 
 app.listen(PORT, () => {

package/package.json

@@ -1,8 +1,9 @@
 {
   "name": "jira-pat",
-  "version": "1.0.3",
+  "version": "1.0.4",
   "description": "Jira Dashboard",
   "author": "Rohith",
+  "license": "ISC",
   "workspaces": [
     "backend",
     "frontend"
@@ -20,6 +21,7 @@
     "test": "npm run test --workspace backend && npm run test:run --workspace frontend"
   },
   "bin": {
+    "jira-pat": "./bin/jira.js",
     "jira": "./bin/jira.js",
     "jira-config": "./bin/jira.js",
     "jira-update": "./bin/jira.js"