Documentation
Learn about why Codeship was built, how it works under the hood, and how to get the most out of it.
Why Codeship?
As developers, we spend hours grinding on LeetCode to prepare for interviews and sharpen our skills. But having an empty GitHub contribution graph while working hard on problem-solving is frustrating.
Manually copying and pasting solutions, formatting file names, writing commit messages, and pushing to GitHub is tedious. Codeship was built to eliminate this friction. It automatically captures your accepted submissions and syncs them to your repository, giving you a beautiful, effortless portfolio of your algorithmic journey.
How It Works
Codeship uses a hybrid approach, combining a browser extension for capturing client-side events and a Next.js backend for secure data processing.
Event Interception
The Chrome Extension injects a script into LeetCode that monitors network requests and DOM changes to detect when a submission is successfully accepted.
Secure Payload Relay
The extension gathers the problem details, runtime metrics, and your exact code, then securely relays this payload to our authenticated Next.js API.
GitHub API Commits
Our backend utilizes your encrypted Personal Access Token (PAT) to interact with the GitHub REST API, creating or updating files with precision.
Tech Stack
Next.js 14
App Router for robust serverless APIs and seamless server-side rendering.
Prisma & PostgreSQL
Type-safe database operations storing user settings securely.
Framer Motion
Fluid, premium animations and layout transitions across the interface.
Chrome APIs
Manifest V3 architecture for efficient background processing.
Usage Guide
- 1. Authenticate with GitHubLog in to the Codeship dashboard using your GitHub account via NextAuth.
- 2. Configure Your SettingsGenerate a classic Personal Access Token (PAT) with
repopermissions. Enter it in the dashboard along with the name of the repository you want to sync your solutions to. - 3. Install the ExtensionDownload and load the Codeship Chrome Extension locally in developer mode (or install from the Chrome Web Store if available).
- 4. Solve ProblemsHead over to LeetCode, solve a problem, and hit Submit. Once accepted, Codeship handles the rest automatically in the background!