Skip to Content
Getting StartedQuickstart

Quickstart

Spin up a new Node.js backend using JavaScript or TypeScript with NeatNode - no setup required.

Create a New Project

Run the CLI command:

npx neatnode

Follow the interactive prompts to choose:

  • Project folder name
  • Language (JavaScript or TypeScript)
  • Template type (Basic, REST API, or Socket.IO)
  • Include example CRUD? (Yes / No)

After Scaffolding

Once generation completes, enter your project and start the dev server:

cd <project-name>
npm install
npm run dev

Then generate your first feature resource:

neatnode g resource user
✔ Created user.controller.js
✔ Created user.service.js
✔ Created user.route.js
✔ Created user.validation.js
✔ Created user.model.js

✔ Updated routes/index.route.js

✨ Resource "user" generated successfully.

[!TIP] Use npm start for production mode (if available in the template).

Example Workflow

npx neatnode
# Enter project folder name: my-app
# Select language: JavaScript
# Choose template: REST API
# Choose Architecture: MVC (or Modular)
# Include CRUD: No
 
cd my-app
npm install
npm run dev
 
neatnode g resource user

Server starts at:

http://localhost:4000

[!NOTE] Explore all available templates in the Templates section.

InstallationCLI Usage