Skip to content

josnin/create-scalpeljs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

28 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

create-scalpeljs

The official scaffolding tool for the ScalpelJS Framework.
Quickly bootstrap a high-performance Web Component project with a surgical focus on simplicity.


What's Inside?

When you generate a project with create-scalpeljs, you get a clean, zero-bloat boilerplate pre-configured with:

  • ScalpelJS Core: The latest version of the framework ready for use.
  • CDN Integration: Pre-configured CDN imports for rapid prototyping and deployment.
  • Minimalist Structure: A refined starting point without the overhead of heavy build tools.

Quick Start

No global installation required. Just run it using npx:

npx create-scalpeljs@latest


## Scaffolding Process:
The CLI will guide you through a three-step precision setup:
1. Project Name: Define your workspace directory.
2. Select Flavor:
js: Standard JavaScript (ESM) + Vite. Lightweight and fast.
ts: Professional TypeScript + Type-checking. Built for scale.

3. Select Template:
Blank: A clean slate for custom surgical builds.
Ecommerce: A full-stack sample (Catalog, Cart, Checkout) using the Scalpel Ecosystem.


## Development Workflow

Once your project is created, follow these steps to get running

```bash
# 1. Enter the project directory
cd my-scalpeljs-app

# 2. Install dependencies
npm install

# 3. Start the development server
npm run dev

Your app will be running at http://localhost:5173.

Help

Need help? Open an issue in: ISSUES

Contributing

Want to improve and add feature? Fork the repo, add your changes and send a pull request.

About

The official scaffolding tool for the ScalpelJS Framework. Quickly bootstrap a high-performance Web Component project with a surgical focus on simplicity.

Topics

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors