diff --git a/README.md b/README.md index 4768398..9c6fb5d 100644 --- a/README.md +++ b/README.md @@ -1,46 +1,109 @@
- CoderScreen Logo - -

CoderScreen

- -

- The modern technical hiring platform. + CoderScreen Logo + +

CoderScreen

+ +

+ The open-source platform for technical hiring.
+ Live coding interviews, auto-graded assessments, and take-homes — in one place you can actually host yourself. +

+ +

+ Website · + Self-host · + Community

- -
- - coderscreen.com » + +

+ + License: GPLv3 + + + GitHub stars + + + PRs welcome -

- -
- Join our Discord + Discord -
+


-CoderScreen is a collaborative code interview platform that enables real-time technical assessments with live code execution, multi-language support, and seamless candidate experience. + +

+ CoderScreen product screenshot +

+ +
+ +## Why we built this + +Hiring engineers is hard enough without fighting your tools. Most interview platforms are closed boxes: you can't see how they run candidate code, you can't shape them to your process, and you're stuck stitching together one tool for live interviews, another for take-homes, and a spreadsheet for everything else. + +We wanted something different — a single platform that does live interviews, async screening, and take-homes, that runs candidate code transparently, and that you can read, fork, and host on your own infrastructure. So we built CoderScreen and made it open source. + +If you've ever spent an evening reading through half-finished take-homes, or run an hour-long interview with someone who couldn't get past FizzBuzz, this is for you. + +## What you get + +**A real-time editor candidates actually enjoy.** Multiplayer editing with live cursors, powered by Yjs. Candidates join from a link — no accounts, no downloads, no "can you share your screen?" + +**Code that runs, right there.** Execute in a secure sandbox and see `stdout`, `stderr`, and exit codes instantly. 20+ languages including TypeScript, Python, Go, Rust, Java, and C++, with multi-file projects and live browser previews for React, Vue, and Svelte. + +**Screening that grades itself.** Build a coding assessment once, send candidates a link, and get scored results back automatically. Reuse questions from a shared library, weight the hard ones so they count for more, and get a single clear score per candidate — no rubric-wrangling. + +**A window into how they think.** Replay every keystroke with code playback to see how a candidate got to their answer, not just where they landed. And since AI is part of real work now, you can watch how they prompt and iterate with the built-in assistant. + +**Made yours.** Add your logo and colors, then track hiring metrics and spot where your process slows down. + +## Self-hosting + +CoderScreen is fully open source and self-hostable on Cloudflare. Grab the code and follow the **[Quick Start guide](QUICK_START.md)** to get an instance running locally or in production. + +```bash +git clone https://github.com/CoderScreen/coderscreen.git +cd coderscreen +pnpm install +``` + +Self-hosting is something we're actively polishing, so if you hit a snag, come say hi in [Discord](https://discord.gg/THxVTKtcZy) — we're happy to help you get unstuck. + +## Tech stack + +CoderScreen is a [pnpm](https://pnpm.io) monorepo built with React, TypeScript, Cloudflare Workers, PostgreSQL, Drizzle ORM, and TailwindCSS. + +### Apps + +| App | What it is | +| ----------- | ------------------------------------------------------------------ | +| `web` | [React](https://reactjs.org) app with TanStack Router. | +| `api` | [Cloudflare Workers](https://workers.cloudflare.com) API with Hono.| +| `marketing` | [Next.js](https://nextjs.org) marketing site. | -# Self Hosting +### Packages -CoderScreen is available to self-host on Cloudflare. [See our quick start guide](QUICK_START.md) for more details. +| Package | What it is | +| ------------- | ------------------------------------------------------------------------------ | +| `ui` | Shared [React](https://reactjs.org) component library. | +| `db` | Shared [Drizzle ORM](https://orm.drizzle.team/) schema and client. | +| `email` | Shared email templates. | +| `common` | Shared utilities and types. | +| `scripts` | Operational and maintenance scripts. | +| `sandbox-sdk` | Code execution SDK for the sandbox (a fork of Cloudflare's sandbox-sdk). | -# Monorepo App Architecture +## Contributing -We use a combination of React, TypeScript, Cloudflare Workers, PostgreSQL, Drizzle (ORM), TailwindCSS throughout this pnpm powered monorepo. +We'd genuinely love your help — bug fixes, new features, better docs, or just telling us where things are confusing. -### Apps: +1. Fork the repo and branch off `main`. +2. Follow the [Quick Start guide](QUICK_START.md) to get set up. +3. Open a pull request and tell us what you changed and why. -- `web`: A [React](https://reactjs.org) web app with TanStack Router. -- `api`: A [Cloudflare Workers](https://workers.cloudflare.com) API with Hono.js. -- `marketing`: A [Next.js](https://nextjs.org) marketing site. +Got an idea or a question first? Start a [discussion](https://github.com/CoderScreen/coderscreen/discussions) or drop into our [Discord](https://discord.gg/THxVTKtcZy). And if the project is useful to you, a ⭐ goes a long way. -### Packages: +## License -- `ui`: A [React](https://reactjs.org) Shared component library. -- `db`: A [Drizzle ORM](https://orm.drizzle.team/) Shared database library. -- `common`: Shared utilities and types. -- `sandbox-sdk`: Code execution SDK for the sandbox environment. Fork of cloudflare's sandbox-sdk package. \ No newline at end of file +CoderScreen is licensed under the [GNU General Public License v3.0](LICENSE).