also looking at this
chore(deps): update dependency @actions/github to v6
#11
4 files
+230
-92
| @@ -1,10 +1,8 @@ | ||
| 1 | <p align="center"><img src="https://github.com/stacksjs/rpx/blob/main/.github/art/cover.jpg?raw=true" alt="Social Card of this repo"></p> | |
| 1 | <p align="center"><img src="https://github.com/stacksjs/launchpad/blob/main/.github/art/cover.jpg?raw=true" alt="Social Card of Launchpad"></p> | |
| 2 | 2 | |
| 3 | 3 | # Introduction |
| 4 | 4 | |
| 5 | > For a better developer experience. | |
| 6 | ||
| 7 | Launchpad is a lightweight package manager built on top of [pkgx](https://pkgx.sh), designed to simplify package installation and management. It provides a clean, intuitive interface with powerful features that make working with development tools and packages easier. | |
| 5 | > A lightweight package manager built on top of pkgx to simplify package installation and management. | |
| 8 | 6 | |
| 9 | 7 | ## What is Launchpad? |
| 10 | 8 | |
| @@ -19,13 +17,13 @@ At its core, Launchpad leverages pkgx, a next-generation package runner that all | ||
| 19 | 17 | |
| 20 | 18 | ## Key Features |
| 21 | 19 | |
| 22 | - �� **Package Management** _Install and manage packages directly using pkgx_ | |
| 23 | - �� **Executable Shims** _Create executable shims for packages automatically_ | |
| 24 | - ��️ **pkgx Installation** _Install and manage the pkgx utility itself_ | |
| 25 | - �� **Dev Environment** _Dedicated command for the dev package for development environments_ | |
| 26 | - �� **Auto-updates** _Configure automatic updates for pkgx_ | |
| 27 | - �� **PATH Integration** _Automatically add installation directories to your PATH_ | |
| 28 | - �� **Cross-platform** _Support for macOS, Linux, and Windows systems_ | |
| 20 | - �� **Package Management** — Install and manage packages directly using pkgx | |
| 21 | - �� **Executable Shims** — Create executable shims for packages automatically | |
| 22 | - ��️ **pkgx Installation** — Install and manage the pkgx utility itself | |
| 23 | - �� **Dev Environment** — Dedicated command for the dev package for development environments | |
| 24 | - �� **Auto-updates** — Configure automatic updates for pkgx | |
| 25 | - �� **PATH Integration** — Automatically add installation directories to your PATH | |
| 26 | - �� **Cross-platform** — Support for macOS, Linux, and Windows systems | |
| 29 | 27 | |
| 30 | 28 | ## How It Works |
| 31 | 29 | |
| @@ -38,56 +36,50 @@ Launchpad works by managing the installation of pkgx and creating shims (executa | ||
| 38 | 36 | |
| 39 | 37 | Whether you're setting up a new development machine, working on multiple projects with different tooling requirements, or just want a cleaner way to manage your packages, Launchpad offers a streamlined experience for modern developers. |
| 40 | 38 | |
| 41 | ## Get Started | |
| 39 | ## Quick Example | |
| 42 | 40 | |
| 43 | It's rather simple to get your package development started: | |
| 41 | Here's a simple example of how to use Launchpad: | |
| 44 | 42 | |
| 45 | 43 | ```bash |
| 46 | # you may use this GitHub template or the following command: | |
| 47 | bunx degit stacksjs/ts-starter my-pkg | |
| 48 | cd my-pkg | |
| 49 | ||
| 50 | # if you don't have pnpm installed, run `npm i -g pnpm` | |
| 51 | bun i # install all deps | |
| 52 | bun run build # builds the library for production-ready use | |
| 44 | # Install Launchpad | |
| 45 | bun add -g @stacksjs/launchpad | |
| 53 | 46 | |
| 54 | # after you have successfully committed, you may create a "release" | |
| 55 | bun run release # automates git commits, versioning, and changelog generations | |
| 56 | ``` | |
| 47 | # Install Node.js | |
| 48 | launchpad install node | |
| 57 | 49 | |
| 58 | _Check out the package.json scripts for more commands._ | |
| 50 | # Create shims for Node.js | |
| 51 | launchpad shim node | |
| 59 | 52 | |
| 60 | ### Developer Experience (DX) | |
| 61 | ||
| 62 | This Starter Kit comes pre-configured with the following: | |
| 53 | # Now 'node' is available in your PATH | |
| 54 | node --version | |
| 55 | ``` | |
| 63 | 56 | |
| 64 | - [Powerful Build Process](https://github.com/oven-sh/bun) - via Bun | |
| 65 | - [Fully Typed APIs](https://www.typescriptlang.org/) - via TypeScript | |
| 66 | - [Documentation-ready](https://vitepress.dev/) - via VitePress | |
| 67 | - [CLI & Binary](https://www.npmjs.com/package/bunx) - via Bun & CAC | |
| 68 | - [Be a Good Commitizen](https://www.npmjs.com/package/git-cz) - pre-configured Commitizen & git-cz setup to simplify semantic git commits, versioning, and changelog generations | |
| 69 | - [Built With Testing In Mind](https://bun.sh/docs/cli/test) - pre-configured unit-testing powered by [Bun](https://bun.sh/docs/cli/test) | |
| 70 | - [Renovate](https://renovatebot.com/) - optimized & automated PR dependency updates | |
| 71 | - [ESLint](https://eslint.org/) - for code linting _(and formatting)_ | |
| 72 | - [GitHub Actions](https://github.com/features/actions) - runs your CI _(fixes code style issues, tags releases & creates its changelogs, runs the test suite, etc.)_ | |
| 57 | With just a few commands, you've installed Node.js and made it available in your PATH. Launchpad handles all the complexity for you. | |
| 73 | 58 | |
| 74 | ## Changelog | |
| 59 | ## Why Choose Launchpad? | |
| 75 | 60 | |
| 76 | Please see our [releases](https://github.com/stacksjs/stacks/releases) page for more information on what has changed recently. | |
| 61 | Launchpad offers several advantages over traditional package managers: | |
| 77 | 62 | |
| 78 | ## Stargazers | |
| 63 | - **Speed**: Installing packages is significantly faster | |
| 64 | - **Isolation**: Changes to one package don't affect others | |
| 65 | - **Simplicity**: Clean, consistent interface across platforms | |
| 66 | - **Integration**: Automatic PATH management and environment configuration | |
| 67 | - **Flexibility**: Works with project-specific development environments | |
| 79 | 68 | |
| 80 | [](https://starchart.cc/stacksjs/ts-starter) | |
| 69 | ## Next Steps | |
| 81 | 70 | |
| 82 | ## Contributing | |
| 71 | Ready to get started with Launchpad? Check out these guides: | |
| 83 | 72 | |
| 84 | Please review the [Contributing Guide](https://github.com/stacksjs/contributing) for details. | |
| 73 | - [Installation Guide](./install.md) — Install Launchpad on your system | |
| 74 | - [Basic Usage](./usage.md) — Learn the basic commands | |
| 75 | - [Configuration](./config.md) — Customize Launchpad to your needs | |
| 76 | - [Why Launchpad?](./why.md) — More details on the advantages of Launchpad | |
| 85 | 77 | |
| 86 | 78 | ## Community |
| 87 | 79 | |
| 88 | 80 | For help, discussion about best practices, or any other conversation that would benefit from being searchable: |
| 89 | 81 | |
| 90 | [Discussions on GitHub](https://github.com/stacksjs/stacks/discussions) | |
| 82 | [Discussions on GitHub](https://github.com/stacksjs/launchpad/discussions) | |
| 91 | 83 | |
| 92 | 84 | For casual chit-chat with others using this package: |
| 93 | 85 | |