Aftermath

This repository contains the core code for the Aftermath project.

Structure

• frontend/ – React (Next.js/Vite) frontend
• backend/ – Node.js/Express or FastAPI backend
• integrations/ – Connectors for ServiceNow, PagerDuty, JIRA, etc.
• plugins/ – Community-driven integrations
• docs/ – Documentation and API references

Architecture Overview

The project is split into a frontend and a backend.

• Backend: An Express server offers REST endpoints for incidents, postmortems, actions and metrics. It protects routes with JSON Web Tokens and role checks. A small /graphql endpoint lets clients search postmortems.
• Frontend: A React app built with Vite. The main App component shows a dashboard with tabs for Incidents, Postmortems, Actions, Metrics, Timeline and more. Data-fetching helpers keep API calls in one place.
• Integrations: Connectors for services like ServiceNow, PagerDuty and JIRA help the app talk to external tools.
• Plugins: A plugins folder lets the community add extra features or integrations.

Additional files:

• .env.example – Example environment variables for APIs
• docker-compose.yml – Docker Compose configuration

Installation

1. Install dependencies

   cd backend && npm install
   cd ../frontend && npm install
   cd ../integrations && npm install

2. Environment variables

   Copy the example file and update values as needed:

   cp .env.example .env

   Key variables:

   • PORT – backend server port (default: 5000)
   • BACKEND_URL – base URL for the backend (default: http://localhost:5000 in development)
   • FRONTEND_URL – base URL for the frontend (default: http://localhost:3000 in development)
   • JWT_SECRET – secret for signing JSON Web Tokens

   In development, the backend listens on port 5000 and the frontend on port 3000. Update these URLs if your production deployment uses different ports.

Running locally

Backend

cd backend
npm run dev

Frontend

cd frontend
npm run dev

Configuring integrations

Set the connector credentials and API URLs in your .env file:

• JIRA_ENDPOINT and JIRA_TOKEN
• PAGERDUTY_ENDPOINT and PAGERDUTY_TOKEN
• SERVICENOW_ENDPOINT and SERVICENOW_TOKEN

The JWT_SECRET key is also required for authentication.

Roles

JWT tokens include a role claim used for role-based access control. The sample backend defines admin and user roles. Endpoints like /actions and /metrics are limited to users with the admin role.

Documentation

• Integration connectors
• Deployment guide

Contributing

See CONTRIBUTING.md for guidelines on coding standards, pull requests, and testing.