piyushdotcomm/Editron
piyushdotcomm/Editron has 67 GitHub stars and 114 forks. GitHot measured 0 stars in 24 hours, 0 in 7 days, and 0 in 15 days. Last checked 2026-11-15 16:40 UTC. Last push 2026-11-01.
Measured star growth
- in 24h
- 0
- in 7 days
- 0
- in 15 days
- 0
- in 1 month
- Update delayed
Net star changes over overlapping periods, not daily totals. Missing measurements are left blank. Stars measure attention, not software quality.
About
Editron - A browser-based development environment powered by WebContainers, Monaco Editor, and integrated AI. Build,run, and collaborate on full-stack projects without local setup.
Developer ToolsREADME.md
Original
Editron
Editron is a browser-based development environment built with Next.js, WebContainers, Monaco Editor, and an integrated AI assistant. It lets users start from curated starter templates, edit code in the browser, run projects in an in-browser terminal, and preview the result without installing a local toolchain for each project.
[!NOTE] Editron is being maintained as an open-source project. Contributor-friendly docs, issue templates, PR templates, and repository checks are included so first-time and returning contributors can work with a predictable workflow.
Screenshots

What Editron Does
- Runs full-stack starter projects in the browser with the WebContainer API.
- Supports a large starter catalog across frontend, backend, full-stack, and tooling-focused templates.
- Provides Monaco-based file editing (with automatic Prettier formatting), terminal access, live preview, theme switching, resizable workspace panels, and full project ZIP export.
- Includes an AI chat/completion layer with provider switching for Gemini, Groq, and Mistral.
- Supports authentication with NextAuth and persistence through Prisma with MongoDB.
- Ships a standalone Yjs collaboration server for real-time collaborative editing.
Core Features
Browser IDE Experience
- Monaco editor with multiple files, syntax highlighting, and theme support.
- Live preview through a dedicated preview route.
- xterm.js terminal running inside WebContainers.
- File explorer and project-scoped editing controls.
- Collaborative editing primitives powered by Yjs.
Starter Template System
The editron-starters/ directory contains the project templates that power new playground creation. The current catalog includes:
- Frontend: React, React TS, Vue, Angular, Qwik, Quasar, TresJS, Bootstrap, Expo, Remotion, Slidev
- Full-stack: Next.js, Next.js + shadcn/ui, Vite + React + TS, Vite + shadcn/ui, SvelteKit, Astro + shadcn/ui, TutorialKit
- Backend and APIs: Express, Hono, Hono Node.js, Koa, Egg, GraphQL, JSON Server, JSON GraphQL Server
- Tooling and sandbox projects: Static HTML/CSS/JS, JavaScript, TypeScript, Node, Nodemon, RxJS, Web Platform, Blank
AI Workflows
/api/chatstreams AI coding assistance and tool calls./api/completionis used for code completion workflows.- Providers can be selected between Gemini, Groq, and Mistral.
- User-provided API keys are supported in-app, with optional server fallback keys from environment variables.
Architecture At A Glance
Main application areas
app/: Next.js App Router routes, API endpoints, layouts, and user-facing pagesmodules/: feature modules grouped by domain such as auth, dashboard, playground, profile, and WebContainerscomponents/: shared UI primitives and cross-feature componentslib/: template mapping, database access, auth helpers, API utilities, and collaboration token helpersserver/: standalone collaboration server for Yjs/WebSocket synceditron-starters/: starter project inventory used when creating playgroundsprisma/: MongoDB Prisma schema and generated client configurationtests/: repository-level smoke tests and future automated checks
Data model
The current Prisma schema centers around:
User: authenticated account with role and profile metadataAccount: OAuth provider linkage for NextAuthPlayground: saved project metadata and selected starter templateTemplateFile: persisted serialized project file contentStarMark: user-to-playground favorite state
Collaboration flow
- The Next.js app proxies
/api/collab/:path*to a standalone collaboration server. - The collaboration server runs from
server/collab.ts. - Yjs document sync is handled between the editor layer and the WebSocket server.
Local Development
Prerequisites
- Node.js 20 or newer recommended
- npm 9 or newer
- MongoDB instance, local or hosted
- OAuth applications for GitHub and Google if you want full sign-in support
Install
git clone https://github.com/piyushdotcomm/Editron.git
cd Editron
npm install
cp .env.example .env
Environment variables
Create a .env file in the repository root.
DATABASE_URL="mongodb://localhost:27017/editron"
AUTH_SECRET="replace-with-a-random-secret"
AUTH_GITHUB_ID=""
AUTH_GITHUB_SECRET=""
AUTH_GOOGLE_ID=""
AUTH_GOOGLE_SECRET=""
GEMINI_API_KEY=""
GROQ_API_KEY=""
MISTRAL_API_KEY=""
NEXT_PUBLIC_COLLAB_SERVER_URL=""
What each variable is for
| Variable | Required | Purpose |
|---|---|---|
DATABASE_URL |
Yes | Prisma MongoDB datasource |
AUTH_SECRET |
Yes for auth flows | NextAuth session and token signing |
AUTH_GITHUB_ID / AUTH_GITHUB_SECRET |
Optional locally | GitHub OAuth login |
AUTH_GOOGLE_ID / AUTH_GOOGLE_SECRET |
Optional locally | Google OAuth login |
GEMINI_API_KEY |
Optional | Server fallback for Gemini |
GROQ_API_KEY |
Optional | Server fallback for Groq |
MISTRAL_API_KEY |
Optional | Server fallback for Mistral |
NEXT_PUBLIC_COLLAB_SERVER_URL |
Optional | Explicit collaboration server URL override |
[!IMPORTANT] Do not commit
.envfiles, secrets, access tokens, or provider credentials. Use GitHub repository secrets for CI or deployment environments.
Start the app
npx prisma generate
npx prisma db push
npm run dev
This starts:
- the Next.js app
- the standalone collaboration server via
npm run start:collab
Open http://localhost:3000 after startup.
Scripts
| Command | Description |
|---|---|
npm run dev |
Starts Next.js in development and the collab server in parallel |
npm run build |
Creates a production build |
npm run start |
Starts production mode and the collab server |
npm run start:collab |
Runs the standalone Yjs collaboration server |
npm run lint |
Runs repository ESLint checks |
npm test |
Runs repository smoke tests |
npx prisma generate |
Generates the Prisma client |
npx prisma db push |
Pushes schema changes to MongoDB |
Quality Gates
GitHub Actions currently runs three baseline checks:
linttestbuild
The current lint configuration is intentionally practical rather than perfect:
- application code is linted
- vendored starter templates under
editron-starters/are excluded from maintainer CI - legacy lint debt still exists and appears as warnings in several areas
This keeps the repository enforceable for contributions while still leaving space for incremental cleanup.
Deployment Notes
Main app
The main application is designed for platforms that support Next.js App Router deployments, such as Vercel.
Collaboration server
Two deployment-oriented files already exist for the standalone collaboration service:
render.yamlDockerfile.collab
If you deploy collaboration separately from the web app, make sure:
- the collab server can reach the same MongoDB instance if persistence is enabled
NEXT_PUBLIC_COLLAB_SERVER_URLpoints to the public collaboration endpoint
Known Project Realities
- TypeScript and ESLint are not fully clean across the whole codebase yet.
- Several advanced editor and AI flows are still evolving.
- Starter templates are treated as bundled assets for user projects, not as first-class application source modules.
- The repository contains both the main app and a sizable starter template catalog, so scope discipline matters during contributions.
Where New Contributors Usually Start
Good first areas to understand:
app/playground/[id]/page.tsxfor the editor shellmodules/playground/for file editing, AI, and workspace logicmodules/webcontainers/for browser runtime behaviorapp/api/chat/route.tsfor AI orchestrationlib/template.tsandlib/constants/templates.tsfor starter-template mapping
For contributor workflow, standards, and pull request expectations, read CONTRIBUTING.md. For security reporting, read SECURITY.md.
Community & Contact
We use Element (Matrix) for real-time communication and contributor support.
- Join our Element Channel: Click here to join
- GitHub Discussions: For non-urgent questions and architectural ideas.
- Issues: For bug reports and feature requests.
Contributors
Thanks to everyone who has contributed to Editron!
Mentors
Thanks to our amazing mentors for guiding the contributors!
License
This project is licensed under the MIT License - see the LICENSE file for details.





































