Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/codesandbox/codesandboxer

Deploy any component directly to codesandbox from anywhere
https://github.com/codesandbox/codesandboxer

Last synced: 3 months ago
JSON representation

Deploy any component directly to codesandbox from anywhere

Host: GitHub
URL: https://github.com/codesandbox/codesandboxer
Owner: codesandbox
License: mit
Created: 2018-02-02T03:48:00.000Z (almost 7 years ago)
Default Branch: master
Last Pushed: 2023-10-29T10:51:31.000Z (about 1 year ago)
Last Synced: 2024-05-22T00:04:01.905Z (6 months ago)
Language: JavaScript
Homepage:
Size: 6.19 MB
Stars: 527
Watchers: 13
Forks: 80
Open Issues: 10
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

awesome-github-star - codesandboxer

README

# Codesandboxer

[![All Contributors](https://img.shields.io/badge/all_contributors-8-orange.svg?style=flat-square)](#contributors-)

Export a component to codesandboxer:

![react-codesandboxer-example](./docs/react-codesandboxer-example.gif)

Codesandboxer is a tool to allow you to deploy to go from an 'entry' file, and
deploy that file and all related files to CodeSandbox. Its goal is to allow you
to do this from any component written anywhere, from code you are viewing on
github through to code running locally on your machine, as well as build making
this easy into your own websites.

To allow its use in multiple contexts, it has been split into a monorepo.

The major use-case for codesandboxer is to allow you to easily share examples
with others, or to link to editable versions of examples from a documentation
website.

## Cool Stuff

With an entry file, we work to only upload the files you need, and the
dependencies you use from your project, making lighter sandbox uploads.

Since we wrap the file we are given, codesandboxer can allow you to quickly open
any react component in CodeSandbox, even if you are not set up to start editing
it immediately.

## Core Bits

The core packages, [codesandboxer](/packages/codesandboxer) allows you to fetch
files from github or bitbucket, given a git entry file.

[codesandboxer-fs](/packages/codesandboxer-fs) allows you to do the same kinds
of actions from your terminal, and can be installed as a CLI. See its
documentation for how to use it.

## Other packages

- [react-codesandboxer](/packages/react-codesandboxer) is a react wrapper around
`codesandboxer` allowing you to easily render a button to open an example in
codesandbox.
- [vs-codesandboxer](/packages/vs-codesandboxer) is a visual studio code
extension to allow you to take an open file in vs-code and deploy it to
codesandboxer.
- [atom-codesandboxer](https://github.com/noviny/atom-codesandboxer) is an atom
extension to allow you to take an open file in atom and deploy it to
codesandboxer (IN DEVELOPMENT).
- [bitbucket-codesandboxer](/packages/bitbucket-codesandboxer)

![vs-codesandboxer-example](./docs/vs-codesandboxer-example.gif)

## Desired future packages

Extend codesandboxer to support non-react sandboxes.

## Contributors ✨

Thanks goes to these people ([emoji key][emojis]):

_{Ben Conolly}
🐛 💻 📖 🤔 🚇 🚧 ⚠️ 🔧

_{Joss Mackison}
💻

_{Dominik Wilkowski}
🖋

_{lukebatchelor}
💻

_{Ives van Hoorne}
💻 ⚠️ 📖

_{Gilles De Mey}
💻

_kangweichan
💻

_{Michaël De Boey}
🚧 🔧