generator-litebox
v1.4.0
Published
[![NPM version](https://img.shields.io/npm/v/generator-hellolitebox.svg)](https://www.npmjs.com/package/generator-litebox)
Downloads
7
Readme
generator-litebox
A Yeoman generator for scaffolding Litebox projects.
Installation
First, make sure you have Yeoman and Node.js installed. Then, install the generator globally using npm:
To insall yeoman, run the following command:
npm install -g yo
To install the generator, run the following command:
npm install -g generator-litebox
Usage
yo litebox --force
This will prompt you to enter some information about your project, such as the project name and description. After you've provided the required information, the generator will create a new project in the current directory.
Update the generator
To update the generator, run the following command:
yo
After that, go to "Update your generators" and select "generator-litebox".
Features
The generator supports the following options:
- Back only: Creates a project for the back-end only.
- Front only: Creates a project for the front-end only.
- Back and front in the same monorepo: Creates a project with both the back-end and front-end in the same monorepo.
- Back and front in the same monorepo, with the back-end living inside the Next.js API: Creates a project with both the back-end and front-end in the same monorepo, but with the back-end living inside the Next.js API.
Dev
Run the following command from the root of the project:
yarn run:dev
TO DO
- [x] Add eslint
- [x] Add prettier
- [x] Add commitlint
- [x] Add husky
- [] Add support for app router in next js
- [] Add tsconfig package
- [] Migrate from JS to TS.