Add READMEs

Author: juecd

CODE_OF_CONDUCT.md

@@ -0,0 +1,131 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official email address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at <[email protected]>.
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

CONTRIBUTING.md

@@ -0,0 +1,93 @@
+# Contributing to Kernel
+
+First off, thank you for considering contributing to Kernel! It's people like you that make Kernel such a great tool.
+
+## Code of Conduct
+
+By participating in this project, you are expected to uphold our [Code of Conduct](./CODE_OF_CONDUCT.md). Please report unacceptable behavior to <[email protected]>.
+
+## Getting Started
+
+## Development Workflow
+
+1. **Fork the repository**
+   - Fork the repository on GitHub to your personal account
+   - Clone your fork locally: `git clone https://github.com/YOUR_USERNAME/kernel-images.git`
+   - Add upstream remote: `git remote add upstream https://github.com/original/kernel-images.git`
+
+2. **Create a new branch**
+   - Always branch from the up-to-date main branch
+   ```bash
+   git checkout main
+   git pull upstream main
+   git checkout -b feature/your-feature-name
+   ```
+
+3. **Make your changes**
+   - Write your code following our coding standards
+   - Ensure all tests pass: `npm test`
+   - Add tests for new functionality
+
+4. **Commit your changes**
+   - Use clear and meaningful commit messages
+   - Follow conventional commits format: `type(scope): message`
+   - Example: `feat(api): add new endpoint for user authentication`
+
+5. **Submit a pull request**
+   - Push to your fork: `git push origin feature/your-feature-name`
+   - Create a pull request from your branch to our main branch
+   - Fill out the PR template completely
+
+## Pull Request Process
+
+1. Update the README.md or documentation with details of changes if applicable
+2. The PR requires approval from at least one maintainer
+3. You may merge the PR once it has the required number of approvals
+
+## Coding Standards
+
+- **Linting**: We use ESLint to enforce coding standards
+  ```bash
+  npm run lint
+  ```
+- **Formatting**: We use Prettier for code formatting
+  ```bash
+  npm run format
+  ```
+- All PRs must pass our linting and formatting checks to be merged
+
+## Testing
+
+- Write unit tests for all new functionality
+- Ensure all tests pass before submitting a PR
+- Aim for at least 80% code coverage for new code
+
+## Documentation
+
+- Update documentation for any new or changed functionality
+- Document TypeScript interfaces, classes, and methods
+- Keep our guides and tutorials up to date
+
+## Reporting Issues
+
+- Use the GitHub issue tracker to report bugs
+- Check existing issues before opening a new one
+- Fill out the issue template completely
+- Include steps to reproduce, expected behavior, and actual behavior
+
+## Licensing
+
+- By contributing to Kernel, you agree that your contributions will be licensed under the project's license
+- For questions about licensing, please contact the project maintainers or <[email protected]>
+
+## Communication
+
+- GitHub Issues: Bug reports, feature requests, and discussions
+- [Discord](https://discord.gg/FBrveQRcud): For general questions and community discussions
+- Email: For security concerns or Code of Conduct violations
+
+## Recognition
+
+Contributors who make significant improvements may be invited to join as project maintainers.
+
+Thank you for contributing to Kernel! ❤️

README.md

@@ -1 +1,96 @@
-# create-kernel-app
+# create-kernel-app
+
+A CLI tool to create the scaffolding for a  new Kernel applications. This tool helps you get started with building browser automation applications using Kernel's platform.
+
+## Features
+
+- 🚀 Quick project scaffolding for Kernel applications
+- 🔄 Support for multiple programming languages:
+  - TypeScript
+  - Python
+- 📦 Multiple template options:
+  - Sample App: A basic template that extracts page titles using Playwright
+  - Browser Use: A template implementing the Browser Use SDK
+- ⚡️ Automatic dependency setup
+- 🫶 Interactive CLI with helpful prompts
+
+## Set-Up
+
+```bash
+npx @onkernel/create-kernel-app
+```
+
+## Usage
+
+Create a new Kernel application by running:
+
+```bash
+create-kernel-app [app-name] [options]
+```
+
+### Options
+
+- `-l, --language <language>`: Choose your programming language
+  - TypeScript: `typescript` or `ts`
+  - Python: `python` or `py`
+- `-t, --template <template>`: Select a template
+  - `sample-app`: Basic template with Playwright integration
+  - `browser-use`: Template with Browser Use SDK (Python only)
+
+### Examples
+
+Create a TypeScript application with a sample app:
+```bash
+npx create-kernel-app my-app --language typescript --template sample-app
+```
+
+Create a Python application with a sample app:
+```bash
+npx create-kernel-app my-app --language python --template sample-app
+```
+
+Create a Python application with Browser Use template:
+```bash
+npx create-kernel-app my-app --language python --template browser-use
+```
+
+## Next Steps
+
+After creating your application:
+
+1. Navigate to your project directory:
+   ```bash
+   cd my-app
+   ```
+
+2. Set up your environment:
+   - For TypeScript: `npm install`
+   - For Python: `uv venv && source .venv/bin/activate && uv sync`
+
+3. Set your Kernel API key:
+   ```bash
+   export KERNEL_API_KEY=<YOUR_API_KEY>
+   ```
+
+4. Deploy your application:
+   ```bash
+   kernel deploy index.ts  # for TypeScript
+   kernel deploy main.py   # for Python
+   ```
+
+5. Try out your application using the provided sample commands in the project README.
+
+## Documentation
+
+For more information about Kernel and its features, visit:
+- [Kernel Documentation](https://docs.onkernel.com/quickstart)
+- [Kernel Homepage](https://onkernel.com)
+
+## Contributing
+
+Contributions are welcome! Please feel free to submit a pull request. See [Contributing](CONTRIBUTING.md) and [Code of Conduct](CODE_OF_CONDUCT.md)
+
+## License
+
+MIT © [Kernel](https://onkernel.com)
+

index.ts

@@ -217,7 +217,9 @@ async function setupDependencies(appPath: string, language: LanguageKey): Promis
       console.log(`  cd ${path.basename(appPath)}`);
       console.log('  npm install');
     } else if (language === LANGUAGE_PYTHON) {
-      console.log(chalk.yellow('Please follow the manual setup instructions in the README.'));
+      console.log(chalk.yellow('\nPlease install dependencies manually:'));
+      console.log(`  cd ${path.basename(appPath)}`);
+      console.log('  uv venv && source .venv/bin/activate && uv sync');
     }
   }
 }

templates/python/browser-use/README.md

@@ -2,4 +2,10 @@
 
 This is a simple Kernel application that implements the Browser Use SDK.
 
-See the [docs](https://docs.onkernel.com/quickstart) for information.
+To set up your Python environment, run:
+
+```bash
+python -m venv venv && source venv/bin/activate && pip install -r requirements.txt
+```
+
+See the [docs](https://docs.onkernel.com/build/browser-frameworks) for information.

templates/typescript/sample-app/README.md

@@ -0,0 +1,5 @@
+# Kernel Typscript Sample App
+
+This is a simple Kernel application that extracts the title from a webpage.
+
+See the [docs](https://docs.onkernel.com/quickstart) for information.