Skip to content

Conversation

@mieubrisse
Copy link

@mieubrisse mieubrisse commented Jul 3, 2025

I ended up building a devcontainer setup to work with this starter without needing to install anything on my local machine, so contributing it back here (along with some clarifications I wish the README had).

This PR:

  • Provides a one-click devcontainer setup that includes n8n with the example nodes already linked into place, so that folks can get going with minimal hassle
  • Adds package-lock.json
  • Adds more information to the README, specifically:
    • Tells the user what to look for after they clone this repo (a node called "Example Node")
    • Explicitly lays out what the dev loop looks like, both with devcontainers and without
    • Adds more detailed information on what's needed to publish (e.g. the specific fields

@CLAassistant
Copy link

CLAassistant commented Jul 3, 2025

CLA assistant check
All committers have signed the CLA.

@Joffcom
Copy link
Member

Joffcom commented Jul 3, 2025

Hey @mieubrisse

I like the idea, looking at the updated readme instructions it wants the shell script to be ran... is this needed and how would this work on Windows environments?

@mieubrisse
Copy link
Author

mieubrisse commented Jul 3, 2025

Hey @Joffcom ! The shell script will be run in the devcontainer and the container itself is based on the Node container (which is based on Linux) so it should work the same (all the translation will be handled by Docker).

If the user chooses not to use the devcontainer, then the way for running this is unchanged (though I think for everbody who's not Windows, the script would also work).

@mieubrisse
Copy link
Author

Hey @Joffcom just let me know if I can help with any more info!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants