Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/lvqq/cap

⚡ Create awesome project by one command
https://github.com/lvqq/cap

create-app template tsup typescript vite vitest

Last synced: about 1 month ago
JSON representation

⚡ Create awesome project by one command

Host: GitHub
URL: https://github.com/lvqq/cap
Owner: lvqq
License: mit
Created: 2022-09-02T15:10:01.000Z (about 2 years ago)
Default Branch: main
Last Pushed: 2024-04-13T20:03:57.000Z (7 months ago)
Last Synced: 2024-04-13T20:57:30.407Z (7 months ago)
Topics: create-app, template, tsup, typescript, vite, vitest
Language: TypeScript
Homepage:
Size: 1.32 MB
Stars: 20
Watchers: 0
Forks: 1
Open Issues: 11
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE

Awesome Lists containing this project

README

# cap

[![npm version](https://img.shields.io/npm/v/create-cap.svg)](https://www.npmjs.com/package/create-cap) ![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/lvqq/cap/ci.yml?branch=main) [![Coverage Status](https://coveralls.io/repos/github/lvqq/cap/badge.svg?branch=main)](https://coveralls.io/github/lvqq/cap?branch=main) ![node-current (scoped)](https://img.shields.io/node/v/create-cap) ![GitHub](https://img.shields.io/github/license/lvqq/cap)

cap means **create awesome project**, it has some common engineering configurations built in. You can create a project with one line of command.

## Usage
```bash
# npm
npm create cap my-cap-app
# yarn
yarn create cap my-cap-app
# pnpm
pnpm create cap my-cap-app
```

You can also directly specify the template:

```bash
# npm
npm create cap my-cap-app --template react-ts
# yarn
yarn create cap my-cap-app --template react-ts
# pnpm
pnpm create cap my-cap-app --template react-ts
```

Supported templates: `ts`, `react-ts`, `vue-ts`, `svelte-ts`, `astro-ts`

## Common configurations
- `TypeScript`
- `ESLint`
- `Prettier`
- `Husky`
- `Lint-Staged`
- `Vitest`
- `Github Workflow`

## Templates
We have the following templates:

### ts
Use `tsup` to build project using only `TypeScript`

### react-ts
Use `vite` to build project using `React18` and `TypeScript`

### vue-ts
Use `vite` to build project using `Vue3` and `TypeScript`

### svelte-ts
Use `vite` to build project using `Svelte3` and `TypeScript`

### astro-ts
Project based on `astro` and `TypeScript`

# Development
First run install
```bash
pnpm install
```

Link cli after build
```bash
pnpm build && pnpm --dir ./packages/create-cap link --global
```

Make changes, run build or watch mode
```bash
# run build
pnpm build-create

# run dev watch
pnpm dev-create
```

Run all test
```bash
pnpm test && pnpm test:template
```

# Publish
## latest
```bash
npm run publish --filter=
```

## beta
```bash
npm run publish:beta --filter=
```

# License
[MIT](https://github.com/lvqq/cap/blob/main/LICENSE)