1.0.27 • Published 1 year ago

create-candle-app v1.0.27

Weekly downloads
-
License
MIT
Repository
github
Last release
1 year ago

create-candle-app

create-candle-app is a CLI tool that helps you set up a Next.js project with a predefined template, including TypeScript, TailwindCSS, Heroicons, and ShadCN.

Features

  • Next.js 14
  • TypeScript
  • TailwindCSS
  • Heroicons
  • ShadCN
  • Preconfigured scripts

Installation

To install create-candle-app , ensure you have Node.js and npm installed, then run:

npm install -g create-candle-app

Usage

To create a new project, use the following command:

npx create-candle-app <project-name>

Replace <project-name> with the name of your new project. For example:

npx create-candle-app my-new-app

This command will:

  1. Copy the template files to the new project directory.
  2. Install the required dependencies.

Project Structure

The generated project will have the following structure:

my-new-app/
├── node_modules/
├── public/
├── src/
│   ├── components/
│   ├── hooks/
│   ├── pages/
│   ├── styles/
│   ├── types/
│   ├── utils/
│   └── ...
├── .eslintrc.json
├── .gitignore
├── next.config.js
├── package.json
├── postcss.config.js
├── tailwind.config.js
├── tsconfig.json
└── README.md

Scripts

The following scripts are available:

  • dev: Runs the Next.js development server.
  • build: Builds the application for production.
  • start: Starts the production server.
  • lint: Runs ESLint. To run these scripts, use:
npm run <script>

For example, to start the development server:

npm run dev

Customizing the Template

You can customize the template by modifying the files in the src/templates/default directory. Ensure you update the package.json and other configuration files as needed.

Development

To work on the create-candle-app project itself:

  1. Clone the repository.
  2. Install dependencies:
npm install
  1. Build the project:
npm run build
  1. Test the CLI tool locally:
npm start

Contributing

Contributions are welcome! Please open an issue or submit a pull request.

License

This project is licensed under the ISC License. See the LICENSE file for details.

1.0.19

1 year ago

1.0.22

1 year ago

1.0.21

1 year ago

1.0.20

1 year ago

1.0.26

1 year ago

1.0.25

1 year ago

1.0.24

1 year ago

1.0.23

1 year ago

1.0.27

1 year ago

1.0.2

1 year ago

1.0.17

1 year ago

1.0.16

1 year ago

1.0.8

1 year ago

1.0.7

1 year ago

1.0.6

1 year ago

1.0.5

1 year ago

1.0.4

1 year ago

1.0.3

1 year ago

1.0.15

1 year ago

1.0.14

1 year ago

1.0.13

1 year ago

1.0.12

1 year ago

1.0.1

1 year ago

1.0.0

1 year ago