Create Lit project locally

Community
1

Creating an Alpha plugin requires ones to be able to create a lit web component.
It becomes much easier to create, build and test a lit web component then move/convert it to Alpha plugins.

Need to have: Node.js version ≥ 18.0.0

Below are steps to create and run lit project locally:

  1. Create lit project

       * npm create vite@latest

  2. Answer prompts

      * Project name ? my-lit-app

  * Select a framework ? Vanilla

  * Select variant ? TypeScript

  3. Move into project folder

     * cd my-lit-app

  4. Install dependencies

    * npm install

  5. Install Lit

    • npm install lit

  6. Run development server

    * npm run dev

If you have any question, thought or comment please drop it below and let engage.

3 Likes
2

@Simphiwe Thanks for sharing this great overview on setting up Lit projects!

If you’re working with the Neutrinos Alpha Platform, we strongly recommend using our official tool — the Alpha CLI — built specifically to simplify and standardize the creation of Lit-based plugins for Alpha.

:hammer_and_wrench: Alpha CLI is purpose-built and fully aligned with Alpha’s architecture. It supports:

  • Component scaffolding with Alpha-compatible decorators
  • Attribute and event generation with proper field mappings
  • One-command builds and publishing directly to the platform

:package: Install globally:

npm install -g @jatahworx/alpha-cli

:blue_book: Full documentation available here: npm package - alpha cli

Since this is our own CLI, it integrates deeply with the Alpha ecosystem and ensures long-term compatibility and support. Highly recommend using it for all plugin development within Alpha.

Feel free to reach out if you’d like any guidance or support getting started with Alpha CLI.

2 Likes
3

Thank you @Shamnad_KS :folded_hands: for following up with the Alpha CLI documentation. It’s definitely helpful when creating Alpha plugins and the only way of creating Plugins in the Neutrinos Alpha Platform.

2 Likes