This repository contains the source code for the create-awesome-node-app
package. β¨
In the project directory, you can run:
npm run <script> |
Description |
---|---|
test |
Runs unit tests with Jest. |
lint |
π¦ Lints the project for potential errors |
lint:fix |
Lints the project and fixes all correctable errors |
format |
Formats the project using Prettier |
type-check |
Runs TypeScript type checking |
When contributing you might want to test your changes locally before opening a PR. To do so, you can use the create-awesome-node-app
CLI to create a new project and test your changes.
# Clone the repository
git clone https://github.com/Create-Node-App/create-node-app.git
# Move into the directory
cd create-node-app
# Setup your local environment
fnm use
npm install
# Build the CLI
npm run build -- --filter create-awesome-node-app
# Create a new project
./packages/create-awesome-node-app/index.js my-app