Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 13 additions & 5 deletions CURRENT_STATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,7 @@ report exported. CLI and web inspector.
- ✅ `AnalysisResult` input type
- ✅ 11 tests (structure, failure inclusion, readability, metadata, severity)

### CLI Package (in progress — this PR)
### CLI Package (PR #41)

- ✅ `packages/cli/` — new package
- ✅ `ocpp-debugkit inspect <file>` — parse + analyze + output
Expand All @@ -118,16 +118,24 @@ report exported. CLI and web inspector.
- ✅ 17 integration tests (execa-based)
- ✅ Converted JSON fixtures to TS modules (fixes Node.js ESM JSON import issue)

### Next.js App Scaffold (in progress — this PR)

- ✅ `apps/web/` — single Next.js app (App Router)
- ✅ Tailwind CSS initialized
- ✅ Routes: `/` (placeholder), `/inspector` (placeholder), `/docs` (placeholder)
- ✅ Workspace dependencies on `@ocpp-debugkit/core`, `scenarios`, `reporter`
- ✅ `"private": true` (never publishable to npm)

## What's Next

1. **Issue #20** → complete (PR #33): data model + parser + normalizer
2. **Issue #21** → complete (PR #34): timeline + detection + summarizer + validator
3. **Issue #22** → complete (PR #35): public API export + package config
4. **Issue #23** → complete (PR #39): scenarios package (format + 5 initial scenarios)
5. **Issue #24** → complete (PR #40): reporter package (Markdown report generator)
6. **Issue #25** (this PR) → complete: CLI package (scaffold + inspect + report + scenario commands)
7. **Issue #26**: Next.js app scaffold (Next.js + Nextra + Tailwind + Shadcn)
8. **Issue #27**: Landing page
6. **Issue #25** → complete (PR #41): CLI package (scaffold + inspect + report + scenario commands)
7. **Issue #26** (this PR) → complete: Next.js app scaffold (Next.js + Tailwind, routes for /, /inspector, /docs)
8. **Issue #27**: Landing page (hero, features, architecture, quick start, footer)
9. **Issue #28**: Inspector (trace input + timeline + message inspector)

## Known Blockers / Decisions Pending
Expand All @@ -144,4 +152,4 @@ report exported. CLI and web inspector.
| `@ocpp-debugkit/cli` | in progress (inspect + report + scenario) | 0.0.0 |
| `@ocpp-debugkit/replay` | not started | — |
| `@ocpp-debugkit/react` | not started | — |
| `apps/web` | not started | — |
| `apps/web` | in progress (scaffold + routes) | — |
41 changes: 41 additions & 0 deletions apps/web/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.

# dependencies
/node_modules
/.pnp
.pnp.*
.yarn/*
!.yarn/patches
!.yarn/plugins
!.yarn/releases
!.yarn/versions

# testing
/coverage

# next.js
/.next/
/out/

# production
/build

# misc
.DS_Store
*.pem

# debug
npm-debug.log*
yarn-debug.log*
yarn-error.log*
.pnpm-debug.log*

# env files (can opt-in for committing if needed)
.env*

# vercel
.vercel

# typescript
*.tsbuildinfo
next-env.d.ts
36 changes: 36 additions & 0 deletions apps/web/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
This is a [Next.js](https://nextjs.org) project bootstrapped with [`create-next-app`](https://nextjs.org/docs/app/api-reference/cli/create-next-app).

## Getting Started

First, run the development server:

```bash
npm run dev
# or
yarn dev
# or
pnpm dev
# or
bun dev
```

Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.

You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file.

This project uses [`next/font`](https://nextjs.org/docs/app/building-your-application/optimizing/fonts) to automatically optimize and load [Geist](https://vercel.com/font), a new font family for Vercel.

## Learn More

To learn more about Next.js, take a look at the following resources:

- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.

You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js) - your feedback and contributions are welcome!

## Deploy on Vercel

The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js.

Check out our [Next.js deployment documentation](https://nextjs.org/docs/app/building-your-application/deploying) for more details.
18 changes: 18 additions & 0 deletions apps/web/eslint.config.mjs
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
import { defineConfig, globalIgnores } from 'eslint/config';
import nextVitals from 'eslint-config-next/core-web-vitals';
import nextTs from 'eslint-config-next/typescript';

const eslintConfig = defineConfig([
...nextVitals,
...nextTs,
// Override default ignores of eslint-config-next.
globalIgnores([
// Default ignores of eslint-config-next:
'.next/**',
'out/**',
'build/**',
'next-env.d.ts',
]),
]);

export default eslintConfig;
5 changes: 5 additions & 0 deletions apps/web/next.config.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
import type { NextConfig } from 'next';

const nextConfig: NextConfig = {/* config options here */};

export default nextConfig;
31 changes: 31 additions & 0 deletions apps/web/package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
{
"name": "web",
"version": "0.1.0",
"private": true,
"scripts": {
"dev": "next dev",
"build": "next build",
"start": "next start",
"lint": "eslint",
"typecheck": "tsc --noEmit",
"clean": "rm -rf .next .turbo"
},
"dependencies": {
"@ocpp-debugkit/core": "workspace:*",
"@ocpp-debugkit/scenarios": "workspace:*",
"@ocpp-debugkit/reporter": "workspace:*",
"next": "16.2.10",
"react": "19.2.4",
"react-dom": "19.2.4"
},
"devDependencies": {
"@tailwindcss/postcss": "^4",
"@types/node": "^20",
"@types/react": "^19",
"@types/react-dom": "^19",
"eslint": "^9",
"eslint-config-next": "16.2.10",
"tailwindcss": "^4",
"typescript": "^5"
}
}
7 changes: 7 additions & 0 deletions apps/web/postcss.config.mjs
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
const config = {
plugins: {
'@tailwindcss/postcss': {},
},
};

export default config;
1 change: 1 addition & 0 deletions apps/web/public/file.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions apps/web/public/globe.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions apps/web/public/next.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions apps/web/public/vercel.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions apps/web/public/window.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
12 changes: 12 additions & 0 deletions apps/web/src/app/docs/page.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
export default function DocsPage() {
return (
<main className="flex min-h-screen flex-col items-center justify-center p-8">
<div className="max-w-2xl text-center">
<h1 className="text-4xl font-bold tracking-tight">Documentation</h1>
<p className="mt-4 text-lg text-neutral-600 dark:text-neutral-400">
Documentation is under construction.
</p>
</div>
</main>
);
}
Binary file added apps/web/src/app/favicon.ico
Binary file not shown.
26 changes: 26 additions & 0 deletions apps/web/src/app/globals.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
@import 'tailwindcss';

:root {
--background: #ffffff;
--foreground: #171717;
}

@theme inline {
--color-background: var(--background);
--color-foreground: var(--foreground);
--font-sans: var(--font-geist-sans);
--font-mono: var(--font-geist-mono);
}

@media (prefers-color-scheme: dark) {
:root {
--background: #0a0a0a;
--foreground: #ededed;
}
}

body {
background: var(--background);
color: var(--foreground);
font-family: Arial, Helvetica, sans-serif;
}
13 changes: 13 additions & 0 deletions apps/web/src/app/inspector/page.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
export default function InspectorPage() {
return (
<main className="flex min-h-screen flex-col items-center justify-center p-8">
<div className="max-w-2xl text-center">
<h1 className="text-4xl font-bold tracking-tight">OCPP Inspector</h1>
<p className="mt-4 text-lg text-neutral-600 dark:text-neutral-400">
Inspect OCPP charging traces, view session timelines, and detect failures.
</p>
<p className="mt-2 text-sm text-neutral-500">The inspector UI is under construction.</p>
</div>
</main>
);
}
31 changes: 31 additions & 0 deletions apps/web/src/app/layout.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
import type { Metadata } from 'next';
import { Geist, Geist_Mono } from 'next/font/google';
import './globals.css';

const geistSans = Geist({
variable: '--font-geist-sans',
subsets: ['latin'],
});

const geistMono = Geist_Mono({
variable: '--font-geist-mono',
subsets: ['latin'],
});

export const metadata: Metadata = {
title: 'OCPP DebugKit',
description:
'Open-source DevTools for debugging OCPP charging sessions. Inspect traces, detect failures, and generate reports.',
};

export default function RootLayout({
children,
}: Readonly<{
children: React.ReactNode;
}>) {
return (
<html lang="en" className={`${geistSans.variable} ${geistMono.variable} h-full antialiased`}>
<body className="min-h-full flex flex-col">{children}</body>
</html>
);
}
28 changes: 28 additions & 0 deletions apps/web/src/app/page.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
export default function HomePage() {
return (
<main className="flex min-h-screen flex-col items-center justify-center p-8">
<div className="max-w-3xl text-center">
<h1 className="text-5xl font-bold tracking-tight">OCPP DebugKit</h1>
<p className="mt-6 text-xl text-neutral-600 dark:text-neutral-400">
Open-source DevTools for debugging OCPP charging sessions.
</p>
<div className="mt-8 flex gap-4 justify-center">
<a
href="/inspector"
className="rounded-lg bg-neutral-900 px-6 py-3 text-sm font-medium text-white hover:bg-neutral-800 dark:bg-white dark:text-black dark:hover:bg-neutral-200"
>
Try Inspector
</a>
<a
href="https://github.com/ocpp-debugkit/ocpp-debugkit"
target="_blank"
rel="noopener noreferrer"
className="rounded-lg border border-neutral-300 px-6 py-3 text-sm font-medium hover:bg-neutral-100 dark:border-neutral-700 dark:hover:bg-neutral-900"
>
View on GitHub
</a>
</div>
</div>
</main>
);
}
34 changes: 34 additions & 0 deletions apps/web/tsconfig.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
{
"compilerOptions": {
"target": "ES2017",
"lib": ["dom", "dom.iterable", "esnext"],
"allowJs": true,
"skipLibCheck": true,
"strict": true,
"noEmit": true,
"esModuleInterop": true,
"module": "esnext",
"moduleResolution": "bundler",
"resolveJsonModule": true,
"isolatedModules": true,
"jsx": "react-jsx",
"incremental": true,
"plugins": [
{
"name": "next"
}
],
"paths": {
"@/*": ["./src/*"]
}
},
"include": [
"next-env.d.ts",
"**/*.ts",
"**/*.tsx",
".next/types/**/*.ts",
".next/dev/types/**/*.ts",
"**/*.mts"
],
"exclude": ["node_modules"]
}
Loading
Loading