📇 Index

• 📄 Description
• 🚀 Quick Start
• 🔨 Development & Contribution
  • 📋 Prerequisites
  • 🧪 Update and Test
  • 📁 Project Layout
• ⚖️ Licensing
• 🏁 Wrapping Up

📄 Description

Kickstart your next Angular project in seconds, not hours.

@proangular/pro-ject is a friendly, interactive Node CLI that streamlines ng new and gives your Angular 20+ workspace a modern, best-practices foundation. With just one command, you'll get guided prompts for naming, structure, and sensible defaults. No more guessing what's standard or spending time configuring tools. After setup, opt into extras like runtime type checking, date handling, UI libraries, code formatting, and more, all ready with minimal fuss.

Why you'll love it:

• Clean, opinionated project scaffolding
• Minimal, clear prompts to get started fast
• TypeScript-first, Angular 20+ ready
• Optional integration of Material, CDK, Prettier, ESLint, Husky, and more
• Pick add-ons for forms, tables, snippets, and project structure—just toggle on what you need
• Fully validates your project name and setup
• Ensures a working development server out of the box
• Professional defaults that save you time, but still let you extend and customize

Perfect for new apps, rapid prototypes, or just skipping the boring setup steps—leaving you to focus on real features.

🚀 Quick Start

First, install Node.js v20+. Then, run the following command:

npx -y @proangular/pro-ject@latest

or

npm exec -y @proangular/pro-ject@latest

You can replace @latest with a specific version number if desired.

Follow the prompts to scaffold your new Angular project with best-practice defaults. Once complete, navigate to your new project directory and start the development server:

npm run start

Then open your browser to http://localhost:4200 to see your new Angular application in action!

🔨 Development & Contribution

📋 Prerequisites

1. Install Node.js.

2. Install dependencies:

   npm install

🧪 Update and Test

1. Update source code in src.

2. Run npm run build to compile the TypeScript files in src to dist.

3. Run node dist/index.js to execute the compiled code.

4. Add your changes to git and create a pull request.

📁 Project Layout

.
├─ .github/                      # GitHub workflows, actions, and related automation files.
├─ .scripts/                     # Scripts run by node for various automation tasks.
├─ .vscode/                      # VS Code workspace settings for the project.
├─ dist/                         # Non-committed, compiled project files from source code in `src/`.
├─ node_modules/                 # Non-committed, installed dependencies needed to run & develop the project.
├─ src/                          # Source code of the project.
│  ├─ constants/                 # Project constants such as version mappings.
│  ├─ steps/                     # The wizard steps for project generation.
│  ├─ templates/                 # File templates used during project scaffolding.
│  ├─ utils/                     # Utility functions and types.
│  └─ index.ts                   # The main entry point of the project.
├─ .gitignore                    # Specifies files and directories to be ignored by Git.
├─ .prettierignore               # Specifies files and directories to be ignored by Prettier.
├─ LICENSE                       # The MIT license for this project.
├─ package-lock.json             # Auto-generated file that locks the versions of dependencies.
├─ package.json                  # Project metadata and dependencies.
├─ README.md                     # This file.
└─ tsconfig.json                 # TypeScript configuration file.

⚖️ Licensing

This project is licensed under the MIT License. See the LICENSE file for the pertaining license text.

SPDX-License-Identifier: MIT

🏁 Wrapping Up

Thank you to the entire Angular team and community for such a great framework to build upon. If you have any questions, please let me know by opening an issue here.

| Type | Info | | :---------------------------------------------------------------------------------------------------------------------------------------------- | :------------------------------------------------------------- | | | [email protected] | | | https://github.com/sponsors/CodyTolene | | | https://www.buymeacoffee.com/codytolene | | | bc1qfx3lvspkj0q077u3gnrnxqkqwyvcku2nml86wmudy7yf2u8edmqq0a5vnt |

Fin. Happy programming friend!

Cody Tolene