Skip to content

Commit dacd493

Browse files
author
Ives van Hoorne
committed
Add @CompuIves as a contributor
1 parent 484ea88 commit dacd493

File tree

2 files changed

+82
-1
lines changed

2 files changed

+82
-1
lines changed

β€Ž.all-contributorsrcβ€Ž

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
{
2+
"projectName": "CodeSandbox",
3+
"projectOwner": "CompuIves",
4+
"files": [
5+
"README.md"
6+
],
7+
"imageSize": 100,
8+
"commit": true,
9+
"contributors": [
10+
{
11+
"login": "CompuIves",
12+
"name": "Ives van Hoorne",
13+
"avatar_url": "https://avatars0.githubusercontent.com/u/587016?v=3",
14+
"profile": "http://ivesvh.com",
15+
"contributions": [
16+
"question",
17+
"blog",
18+
"bug",
19+
"code",
20+
"design",
21+
"doc",
22+
"example",
23+
"infra",
24+
"review",
25+
"test",
26+
"tool"
27+
]
28+
}
29+
]
30+
}

β€ŽREADME.mdβ€Ž

Lines changed: 52 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,54 @@
1-
# CodeSandbox
1+
# [CodeSandbox](https://codesandbox.io)
2+
[![All Contributors](https://img.shields.io/badge/all_contributors-1-orange.svg?style=flat-square)](#contributors)
23

4+
An online code editor with a focus on React.
35
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

Comments
Β (0)