Skip to content

feat: prepare repo for public GitHub release#3

Merged
dawidope merged 22 commits intomainfrom
feat/public-release-prep
Feb 8, 2026
Merged

feat: prepare repo for public GitHub release#3
dawidope merged 22 commits intomainfrom
feat/public-release-prep

Conversation

@dawidope
Copy link
Contributor

@dawidope dawidope commented Feb 7, 2026

Add LICENSE (MIT), favicon, llms.txt, CI workflow, GitHub templates, .dockerignore, screenshot, and ecosystem links.

Add LICENSE (MIT), favicon, SEO metadata, llms.txt, CI workflow,
GitHub templates, .dockerignore, screenshot, and ecosystem links.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Prepares the repository for a public GitHub release by adding licensing, documentation, branding assets, and GitHub project hygiene (CI + templates), and by improving SEO/social metadata for the Next.js app.

Changes:

  • Add MIT license, expanded README/llms.txt documentation, and ecosystem links
  • Add branding assets (favicon + Apple touch icon) and richer Next.js metadata (OG/Twitter/icons)
  • Add GitHub CI workflow and contribution/issue/PR templates; add .dockerignore

Reviewed changes

Copilot reviewed 11 out of 14 changed files in this pull request and generated 2 comments.

Show a summary per file
File Description
src/app/layout.tsx Expands Next.js metadata for SEO and social sharing; adds icon metadata.
public/favicon.ico Adds repo favicon.
public/apple-touch-icon.png Adds Apple touch icon referenced by metadata.icons.
package.json Adds public-repo metadata (license, repo, homepage, keywords).
llms.txt Adds LLM-readable product/repo overview and links for public release.
README.md Adds badges, screenshot, contributing section, and ecosystem links.
LICENSE Adds MIT license file.
.github/workflows/ci.yml Adds CI to run npm ci, lint, and build on PRs/pushes.
.github/pull_request_template.md Adds PR template for consistent submissions.
.github/ISSUE_TEMPLATE/feature_request.md Adds feature request issue template.
.github/ISSUE_TEMPLATE/bug_report.md Adds bug report issue template.
.github/CONTRIBUTING.md Adds contribution guidelines and local setup instructions.
.dockerignore Adds Docker build context exclusions for smaller builds / fewer leaks.
Comments suppressed due to low confidence (1)

README.md:46

  • README states Node.js 18+ in the badges and prerequisites, but this repo’s tooling is pinned to Node 20 (CI uses Node 20, Dockerfile base image is node:20-alpine, and @types/node is 20.x). Either update the README to require Node 20+, or adjust CI/Docker/@types to match the intended minimum supported Node version (at least >=18.18.0 for Next.js 15).
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
[![Node.js 18+](https://img.shields.io/badge/Node.js-18%2B-green.svg)](https://nodejs.org/)
[![Next.js 15](https://img.shields.io/badge/Next.js-15-black.svg)](https://nextjs.org/)
[![Docker](https://img.shields.io/badge/Docker-ready-blue.svg)](https://www.docker.com/)

A local developer tool for testing [deAPI.ai](https://deapi.ai) endpoints — unified AI inference API for image generation, video creation, audio synthesis, and more.

> **What is deAPI?** A single API to access multiple AI models (Stable Diffusion, Flux, Kling, Minimax, etc.) for image generation, video creation, text-to-speech, transcription and more. Learn more at [deapi.ai](https://deapi.ai).

## Screenshot

![deAPI Tester — Dark Mode](docs/screenshot-dark.png)

## Features

- **Endpoint Browser** - Browse and select from all available deAPI endpoints organized by category
- **Dynamic Forms** - Automatically generated forms based on endpoint parameters with model-aware limits and defaults
- **Dynamic Models** - Model options, limits, defaults, voices, and languages auto-discovered from API (zero code changes to add models)
- **Async Job Tracking** - Real-time polling with SSE for async operations (image/video generation)
- **Request Inspector** - View raw request/response JSON for debugging
- **Job History** - Persistent history of all requests with status, cost, and results
- **Result Preview** - Inline previews for images, videos, and audio
- **Download Manager** - Save generated results to local directory
- **Output Picker** - Reuse previously downloaded images as input (e.g. use txt2img result in img2img)
- **Random Prompts** - Dice button fills in creative prompts for quick testing
- **Balance Display** - Track your deAPI credit balance
- **Multi-Profile Config** - Multiple API profiles for different environments (production, staging, etc.)
- **Light/Dark Theme** - Toggle between light and dark mode with system preference support
- **Price Calculator** - Pre-calculate costs before sending requests

## Tech Stack

- **Framework:** Next.js 15 (App Router)
- **Language:** TypeScript (strict mode)
- **Styling:** Tailwind CSS
- **Storage:** Local JSON files (no database required)

## Getting Started

### Prerequisites

- Node.js 18+
- npm
- deAPI account and API token from [deapi.ai](https://deapi.ai)

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot AI and others added 2 commits February 7, 2026 22:34
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Copy link
Contributor

Copilot AI commented Feb 7, 2026

@dawidope I've opened a new pull request, #4, to work on those changes. Once the pull request is ready, I'll request review from you.

Copilot AI and others added 2 commits February 7, 2026 22:37
Co-authored-by: dawidope <1847552+dawidope@users.noreply.github.com>
[WIP] WIP address feedback on preparing repo for public GitHub release
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 11 out of 14 changed files in this pull request and generated 7 comments.


💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

description:
'Test deAPI.ai endpoints locally with dynamic forms, async job tracking, price calculator and result preview.',
type: 'website',
url: 'https://github.com/deapi-ai/deapi-develop-tester',
Copy link

Copilot AI Feb 7, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The Open Graph URL points to deapi-ai/deapi-develop-tester, but the repository remote is https://github.com/deapi-ai/deapi-tester (.git/config). This will generate incorrect link previews; update the URL to the actual repo (or a canonical website URL if intended).

Suggested change
url: 'https://github.com/deapi-ai/deapi-develop-tester',
url: 'https://github.com/deapi-ai/deapi-tester',

Copilot uses AI. Check for mistakes.
package.json Outdated
Comment on lines +12 to +16
"url": "https://github.com/deapi-ai/deapi-develop-tester.git"
},
"homepage": "https://github.com/deapi-ai/deapi-develop-tester",
"bugs": {
"url": "https://github.com/deapi-ai/deapi-develop-tester/issues"
Copy link

Copilot AI Feb 7, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

repository.url, homepage, and bugs.url all point to deapi-ai/deapi-develop-tester, but the repo’s configured origin is https://github.com/deapi-ai/deapi-tester (.git/config). These fields will be wrong in npm metadata—please update them to the correct repo URLs.

Suggested change
"url": "https://github.com/deapi-ai/deapi-develop-tester.git"
},
"homepage": "https://github.com/deapi-ai/deapi-develop-tester",
"bugs": {
"url": "https://github.com/deapi-ai/deapi-develop-tester/issues"
"url": "https://github.com/deapi-ai/deapi-tester.git"
},
"homepage": "https://github.com/deapi-ai/deapi-tester",
"bugs": {
"url": "https://github.com/deapi-ai/deapi-tester/issues"

Copilot uses AI. Check for mistakes.
README.md Outdated
- [deAPI.ai](https://deapi.ai) — Unified AI inference API
- [API Documentation](https://docs.deapi.ai) — Full endpoint reference, auth, webhooks, WebSockets
- [Claude Code Skills](https://github.com/deapi-ai/claude-code-skills) — Use deAPI directly from Claude Code terminal (generate images, videos, audio, transcribe and more)
- [Report a Bug](https://github.com/deapi-ai/deapi-develop-tester/issues)
Copy link

Copilot AI Feb 7, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The “Report a Bug” link points to deapi-ai/deapi-develop-tester/issues, but the repository origin is https://github.com/deapi-ai/deapi-tester (.git/config). Update this so users land on the correct issue tracker.

Suggested change
- [Report a Bug](https://github.com/deapi-ai/deapi-develop-tester/issues)
- [Report a Bug](https://github.com/deapi-ai/deapi-tester/issues)

Copilot uses AI. Check for mistakes.
@dawidope
Copy link
Contributor Author

dawidope commented Feb 7, 2026

@copilot open a new pull request to apply changes based on the comments in this thread

Copy link
Contributor

Copilot AI commented Feb 7, 2026

@dawidope I've opened a new pull request, #5, to work on those changes. Once the pull request is ready, I'll request review from you.

Copilot AI and others added 2 commits February 7, 2026 22:47
Co-authored-by: dawidope <1847552+dawidope@users.noreply.github.com>
fix: correct repository URLs from deapi-develop-tester to deapi-tester
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 11 out of 14 changed files in this pull request and generated 2 comments.


💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@dawidope
Copy link
Contributor Author

dawidope commented Feb 7, 2026

@copilot open a new pull request to apply changes based on the comments in this thread

Copy link
Contributor

Copilot AI commented Feb 7, 2026

@dawidope I've opened a new pull request, #6, to work on those changes. Once the pull request is ready, I'll request review from you.

Copilot AI and others added 2 commits February 7, 2026 23:01
Co-authored-by: dawidope <1847552+dawidope@users.noreply.github.com>
fix: add OG/Twitter images and upgrade eslint-config-next to v15
@dawidope dawidope requested a review from Copilot February 7, 2026 23:07
Copilot AI and others added 3 commits February 7, 2026 23:16
Co-authored-by: dawidope <1847552+dawidope@users.noreply.github.com>
Co-authored-by: dawidope <1847552+dawidope@users.noreply.github.com>
[WIP] Address feedback on repo preparation for public release
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 12 out of 17 changed files in this pull request and generated 5 comments.


💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

description:
'Test deAPI.ai endpoints locally with dynamic forms, async job tracking, price calculator and result preview.',
type: 'website',
url: 'https://github.com/deapi-ai/deapi-tester',
Copy link

Copilot AI Feb 7, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

openGraph.url is hardcoded to the GitHub repository URL, which will cause og:url to be incorrect when the app is deployed (and inconsistent with metadataBase). Prefer using the actual site URL (or omit this field and let it derive from metadataBase).

Suggested change
url: 'https://github.com/deapi-ai/deapi-tester',

Copilot uses AI. Check for mistakes.
Comment on lines +6 to +8
metadataBase: new URL(
process.env.NEXT_PUBLIC_SITE_URL || 'http://localhost:3000'
),
Copy link

Copilot AI Feb 7, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

metadataBase: new URL(process.env.NEXT_PUBLIC_SITE_URL ...) will throw during build/runtime if NEXT_PUBLIC_SITE_URL is set but not a valid absolute URL (e.g., missing https://). Consider validating/normalizing the env var (or falling back) so a misconfigured value doesn’t crash metadata generation.

Copilot uses AI. Check for mistakes.
@dawidope
Copy link
Contributor Author

dawidope commented Feb 8, 2026

@copilot open a new pull request to apply changes based on the comments in this thread

Copy link
Contributor

Copilot AI commented Feb 8, 2026

@dawidope I've opened a new pull request, #8, to work on those changes. Once the pull request is ready, I'll request review from you.

Copilot AI and others added 4 commits February 8, 2026 11:31
- Remove hardcoded openGraph.url to let it derive from metadataBase
- Add validation for NEXT_PUBLIC_SITE_URL to ensure valid URL format
- Update README badge from Node.js 18+ to 18.18.0+
- Add engines.node field to package.json (>=18.18.0)
- Update CI workflow to use Node 18.18.x instead of 18.x

Co-authored-by: dawidope <1847552+dawidope@users.noreply.github.com>
Co-authored-by: dawidope <1847552+dawidope@users.noreply.github.com>
fix: align Node.js requirements and validate metadata URLs
Copy link
Contributor

Copilot AI commented Feb 8, 2026

@dawidope I've opened a new pull request, #9, to work on those changes. Once the pull request is ready, I'll request review from you.

Pin CI Node.js version to 18.18.x for Next.js 15 compatibility
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 12 out of 17 changed files in this pull request and generated 1 comment.


💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 12 out of 17 changed files in this pull request and generated no new comments.


💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@dawidope dawidope self-assigned this Feb 8, 2026
@dawidope dawidope requested a review from szwagros February 8, 2026 19:57
@dawidope dawidope merged commit c536fbc into main Feb 8, 2026
8 checks passed
@dawidope dawidope deleted the feat/public-release-prep branch February 8, 2026 19:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants