Create Spin App 🌀

Create Spin App is a command-line interface (CLI) tool that is based on the Atro CLI. It allows you to easily generate a new application using different templates:

○ Standalone webapp, powered by Astro ○ Astro Frontend app (Astro / React) ○ Micro-frontend app (React) ○ Micro-frontend app (VanillaJS) ○ Micro-frontend app (Shell) ○ Next Frontend app ( Next SSG ) ○ Next Frontend app ( Next SSR ) ○ Remix Frontend app ( Remix js SSR ) ○ Astro Frontend app (Astro / React SSR) ○ Static website (with Caddy) ○ Static website (with nginx)

Usage

To use Create Spin App, you need to have Node.js and npm (Node Package Manager) installed on your machine.

To create a new application using Create Spin App, you can run the following command:

npx create-spin-app@latest

• This will launch the CLI and prompt you to choose a template for your application. Simply select the desired template and follow the instructions to generate your new application.

• create spin runs in interactive mode by default, but it also provides the option to specify additional templates from a remote repository by passing the URL

  npx create-spin-app@latest -- --additional-template https://github.com/mdn/html-examples

Design

꩜ Spin is a common platform for developing, delivering and hosting frontends.

Templates / Starter kits

• Create Spin App provides a set of templates that are designed to enhance the developer experience (DX) by providing a ready-to-use project structure with essential configurations.

• By leveraging these templates, developers can quickly set up their projects with essential tools and configurations, allowing them to focus on building their applications.

Check out the full list of example templates, available on GitHub.

Implementation

We try to bring this codebase to some high standards.

ℹ️ Spin development key criteria are: functional, performant & elegant.

Part of the codebase structure and code has been borrowed from the amazing Astro project.

CLI Flags

May be provided in place of prompts

| Name | Description | |:-----------------------------|:-------------------------------------------------------| | --additionnalTemplate | Specify url of remote repository. | | --template <name> | Specify your template. | | --install / --no-install | Install dependencies (or not). | | --git / --no-git | Initialize git repo (or not). | | --yes (-y) | Skip all prompt by accepting defaults. | | --no (-n) | Skip all prompt by declining defaults. | | --dry-run | Walk through steps without executing. | | --skip-houston | Skip Houston animation. | | --typescript <option> | TypeScript option: strict / strictest / relaxed. |