|
1 | | -# CodeSandbox |
| 1 | +# [CodeSandbox](https://codesandbox.io) |
| 2 | +[](#contributors) |
2 | 3 |
|
| 4 | +An online code editor with a focus on React. |
3 | 5 | This project was bootstrapped with [Create React App](https://github.com/facebookincubator/create-react-app). |
| 6 | + |
| 7 | +The JavaScript community has sharing as its selling point. It has the biggest open source community and every day new ideas and proposals are shared on Twitter. This is great and a really strong point, but the side effect of this is that there are a lot of tools and configurations to consider before you can start building. |
| 8 | + |
| 9 | +CodeSandbox aims to solve this by allowing developers to simply go to a URL in their browser to start building. This not only makes it easier to get started, it also makes it easier to share. You can just share your created work by sharing the URL, others can then (without downloading) further develop on these sandboxes. |
| 10 | + |
| 11 | +## β οΈ Warning β οΈ |
| 12 | + |
| 13 | +I built CodeSandbox as a fun project when I was bored during lectures, therefore the client code is a bit of a mess. I've done some refactoring after release, but we're not there yet. It's missing: |
| 14 | + |
| 15 | +- Tests |
| 16 | +- Flowtype compliance |
| 17 | +- Linting compliance |
| 18 | +- Documentation |
| 19 | +- Some reusability between components |
| 20 | +- Some more things |
| 21 | + |
| 22 | +This means it's sometimes a bit hard to navigate through the code, but no worries! I'm here to help, just open an issue and I'll help you out + adjust the documentation. |
| 23 | + |
| 24 | +## Organization |
| 25 | + |
| 26 | +The CodeSandbox client is currently divided in to 5 parts. |
| 27 | + |
| 28 | +- `app`: The editor and profile page |
| 29 | +- `sandbox`: The preview pane of the editor |
| 30 | +- `embed`: The embedded version of CodeSandbox (which you can embed on medium) |
| 31 | +- `common`: The common parts between `sandbox`, `embed` and `app` |
| 32 | +- `homepage`: Homepage! |
| 33 | + |
| 34 | +This version of CodeSandbox is using the production server as source of truth, this is specified by the environment variable `LOCAL_SERVER`. It's not yet possible to sign in in this version, I haven't figured this out yet. |
| 35 | + |
| 36 | +## Installation |
| 37 | + |
| 38 | +To install the project you need to have `yarn` and `node`, to start: |
| 39 | + |
| 40 | +```bash |
| 41 | +yarn |
| 42 | +yarn start |
| 43 | +``` |
| 44 | + |
| 45 | +## Contributors |
| 46 | + |
| 47 | +Thanks goes to these wonderful people ([emoji key](https://github.com/kentcdodds/all-contributors#emoji-key)): |
| 48 | + |
| 49 | +<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section --> |
| 50 | +| [<img src="https://avatars0.githubusercontent.com/u/587016?v=3" width="100px;"/><br /><sub>Ives van Hoorne</sub>](http://ivesvh.com)<br />[π¬](#question-CompuIves "Answering Questions") [π](#blog-CompuIves "Blogposts") [π](https://github.com/CompuIves/CodeSandbox/issues?q=author%3ACompuIves "Bug reports") [π»](https://github.com/CompuIves/CodeSandbox/commits?author=CompuIves "Code") [π¨](#design-CompuIves "Design") [π](https://github.com/CompuIves/CodeSandbox/commits?author=CompuIves "Documentation") [π‘](#example-CompuIves "Examples") [π](#infra-CompuIves "Infrastructure (Hosting, Build-Tools, etc)") [π](#review-CompuIves "Reviewed Pull Requests") [β οΈ](https://github.com/CompuIves/CodeSandbox/commits?author=CompuIves "Tests") [π§](#tool-CompuIves "Tools") | |
| 51 | +| :---: | |
| 52 | +<!-- ALL-CONTRIBUTORS-LIST:END --> |
| 53 | + |
| 54 | +This project follows the [all-contributors](https://github.com/kentcdodds/all-contributors) specification. Contributions of any kind welcome! |
0 commit comments