create-sandbox

Create a local sandbox of a library you'd like to contribute!

Run it with npx create-sandbox <source>

It works on single project repositories that are using React.

When you run the create-sandbox command, the CLI will:

1. clone the source if it is a repository and does not exist locally;
2. create a React sandbox;
3. install the project dependencies;
4. install the project's peer dependencies in the sandbox;
5. link the project to the sandbox.

Now all you need to do is to start the sandboxed application, fire the development version of your project and let your ideas change the world!

Using a local folder

It's possible to use an already existing folder instead of cloning a Github repo. Just pass the folder name as the argument and you should be good to go!

TODO

• Simple repository with React sandbox
• Folder as project instead of repository
• Monorepo with React sandbox
• Package selection for monorepos
• Framework detector + adapter (e.g. Vue, Angular)

Contributing

Fork it and create PRs. They are welcome!

On creating issues, please make sure to specify the URL of the repository, along with your environment settings such as OS, package manager and NodeJS version.

Making create-sandbox

1. Clone the repository;
2. Install the packages;
3. Run the start script.

It will start the compiler in watch mode.

To test your changes, run the following script on the parent folder:

node --experimental-specifier-resolution=node create-sandbox/dist/index.js <source>

LICENSE

MIT