README.md

Codewind

Build high-quality cloud-native applications for Kubernetes, regardless of your IDE or language.

Codewind enables you to create applications from a template or sample and includes support for launching, updating, testing, and debugging in Docker containers on the desktop. Codewind also supports these features on Kubernetes. You can use Codewind to move existing applications to Docker and Kuberenetes. Codewind provides validation to ensure that applications follow best practices.

Getting started

Use the following instructions to install Codewind with your choice of editor:

1. VS Code extension
2. Eclipse plugin
3. Eclipse Che plugin

Feedback and community

Have any questions or comments on Codewind? Want to get involved? You can get in touch with the team:

• Support: Ask questions, report bugs, and request features with GitHub issues.
• Public chat: Join the public eclipse-codewind and eclipse-codewind-dev Mattermost channels.
• Twitter: Follow Codewind on Twitter at @EclipseCodewind.
• Mailing list: Join the mailing list from [email protected].
• Weekly meetings: The Codewind team holds weekly calls every Tuesday and Thursday at 9:00 AM Eastern Time / 14:00 UTC.

Contributing

We welcome submitting issues and contributions.

• 🐛 Submit bugs.
• ✏️ Contribute.
• 🔎 View the API documentation.
• 📝 Improve the docs.
• 🏗️ View the Codewind architecture.
• See the Codewind repositories.
• ✨ Check out good first issues for new contributors.

Building Codewind from the source

1. Clone the codewind repository.
2. Run the ./script/build.sh script to run the Codewind build, or run the ./run.sh script to build and start Codewind.

After you build Codewind with the build scripts, you can build one of the IDEs for Codewind:

• For Eclipse, see "Building" in the codewind-eclipse repository.
• For VS Code, see "Building Codewind from the source" in the codewind-vscode repository.

Developing - Attaching a Node.js debugger in VSCode

Codewind contains two debugging tools for VSCode in the .vscode/launch.json file. To use these you should:

1. Clone the codewind repository.
2. Copy the src/pfe/devbuild-example.env file to src/pfe/devbuild.env to turn on the Node.js inspect (See src/pfe/portal/package.json).
3. Run the ./run.sh script to build and start Codewind.
4. Open the Codewind directory in VSCode (Something like code github/codewind).
5. Open the debugging tab and select one of the debugging options.

License

EPL 2.0