codesandbox-client README

The project's README from github.com/codesandbox/codesandbox-client. As one markdown file: README.md.

 

All Contributors CircleCI BrowserStack Status PRs Welcome first-timers-only Friendly lerna

An instantly ready, full-featured online IDE for web development on any device with a browser. Enabling you to start new projects quickly and prototype rapidly. With CodeSandbox, you can create web apps, experiment with code, test ideas, and share creations easily.

Other CodeSandbox repositories

CodeSandbox consists of several separate servers, some of which are open sourced.

Documentation

You can find our documentation on our website

Contributors ✨

Thanks goes to these wonderful people (emoji key):

Ives van Hoorne
Ives van Hoorne

💬 📝 🐛 💻 🎨 📖 💡 🚇 👀 ⚠️ 🔧
Donavon West
Donavon West

💻
Jeff Allen
Jeff Allen

💻
Ben Gummer
Ben Gummer

💻
James Gillmore
James Gillmore

💻 🐛
Ade Viankakrisna Fadlil
Ade Viankakrisna Fadlil

💻
Tushar Sonawane
Tushar Sonawane

💬 💻 📖 🤔
Johann Hubert Sonntagbauer
Johann Hubert Sonntagbauer

🐛 💻
Joachim Seminck
Joachim Seminck

💻
Subramanya Chakravarthy
Subramanya Chakravarthy

💻
Robert (Robby) O'Connor
Robert (Robby) O'Connor

🚇
Bogdan Luca
Bogdan Luca

🐛 💻
Divjot Singh
Divjot Singh

💻
Jason Nall
Jason Nall

💻
Lionel
Lionel

💻 🎨
Philipp Brumm
Philipp Brumm

💻
Valentin Hervieu
Valentin Hervieu

💻 🐛
Anenth
Anenth

💻 🎨 🤔
Dony Sukardi
Dony Sukardi

🐛 💻
Geoffrey Dhuyvetters
Geoffrey Dhuyvetters

🎨 💻
Eswar Yaganti
Eswar Yaganti

💻 🚇
Frank Tan
Frank Tan

💻
Bilal Budhani
Bilal Budhani

💻
El Juli
El Juli

💻
Arthur Denner
Arthur Denner

💻 📖
Radi Cho
Radi Cho

🐛 💻 🤔
Xiaoyi Chen
Xiaoyi Chen

💻
Gautam Arora
Gautam Arora

💻 🤔
Haroen Viaene
Haroen Viaene

💻 🎨
Nick Nisi
Nick Nisi

💻
Abhishek Jakhotiya
Abhishek Jakhotiya

💻 🐛
Tom Kühl
Tom Kühl

💻
br1anchen
br1anchen

💻
Daniel Hsing
Daniel Hsing

💻
Maciej Kasprzyk
Maciej Kasprzyk

💻
Robert Heessels
Robert Heessels

📖
Ryan P. C. McQuen
Ryan P. C. McQuen

💻
Chris
Chris

💻
Drew Smith
Drew Smith

💻
Eric Berry
Eric Berry

💻
Hum4n01d
Hum4n01d

💻
Malachi Willey
Malachi Willey

💻

codesandbox-client (codesandbox/codesandbox-client)

Searching Database…

What is this?CodeSandbox is an online IDE for rapid web development: an instantly ready, full-featured coding environment that runs in the browser on any device, so you can start web projects and prototype quickly without local setup.
Is it a website I use or something I install on my machine?It is a web application: you use it in a browser on any device and install nothing. This repository contains the source code of that web client.
How do I get started with it?Open CodeSandbox in your browser and start a new project — the IDE is ready instantly, and the documentation lives on the project website. To work on the client code itself, clone this repository and build it with Node.js 16 and yarn.
What do I need to run the client locally if I want to hack on it?Node.js 16 (the repo pins ^16.0.0) and yarn: the client is a Lerna monorepo, so you install and build packages from the root. A Dockerfile is included if you prefer running it in a container.
Can I run my own copy of the whole CodeSandbox platform from this repo?No — this repository is only the client. CodeSandbox consists of several separate servers and only some are open sourced: alongside this web app there are a Phoenix API server, Nginx configs, a Git Extractor and the CLI, each in its own repository.
How old and how popular is the project?It has been on GitHub since December 2016 and counts about 13.6k stars, so it is a long-running, widely used codebase rather than a weekend experiment.
What can I actually do inside a sandbox?Create web apps, experiment with code, test ideas, and share creations easily — all from the browser, per the project's own description.
How heavy is building the client from source?Fairly heavy: the production build raises Node's memory heap to 4 GB, compiles every monorepo package through Lerna and then copies assets.
Size
786.8 MB
Stars
13.7K
Age
9y
Commits · 90 Days