Codesandbox-client: Docs on how to create synced github examples

[Andarist]

I would like to incorporate sandboxes as live examples in redux-saga, but as those were not generated by CRA, I'm not 100% sure what are the exact requirements.

Would be great if the list of requirements would be listed in the main README.

[CompuIves]

That's a good point! We need more documentation for CodeSandbox in general, this would fit right in. Thanks for the feedback.

As temporary solution, this is what I check for:

1. package.json in root
2. src folder
3. src/index.js

Not very strict, if you put have public/index.html we will also import the index.html separately.

[Andarist]

what about webpack/babel configs?

[CompuIves]

Babel/webpack configs are not parsed yet, because CRA apps don't expose these files. Support for this is the next thing on my list though, it will come with templating + ejecting support.

[Andarist]

so only stock CRA configs r supported right now?

[CompuIves]

Yes, which loaders are you missing?

[Andarist]

Oh, maybe none :P was just asking, so I would know in advance what to expect

[CompuIves]

Okies! Let me know when you need a loader, I can keep it in mind for the templates later on.

[jthegedus]

Are there plans to support arbitrary directory structures in repos?

@CompuIves a friendly ping, sorry if you're busy or on holidays :sweat_smile:
For context, I want to remedy the problem of rendering GitHub repo files on Medium. CodeSandbox seems like a good solution, but imposing a specific repo structure restricts the types of repos that can be imported to CodeSandbox and therefore synced with a Medium post through the embeds. Is this planned to be addressed in the future?

[CompuIves]

Hey @jthegedus, I'm sorry for the late response. I missed your reply.

I'm deploying an update today or tomorrow that will allow arbitrary directory structures, we will attach a custom template for those sandboxes 😄

[CompuIves]

Oh, and this issue can be closed, the documentation is here now: https://codesandbox.io/docs

[jthegedus]

:100: Thanks!