Skip to content

voi99/modern-angular-template

Repository files navigation

Modern Angular Template

This repository serves as a template for creating a new modern Angular project. Follow the instructions below to set up your project.

  • Zoneless by default (start the setup from the with-zone branch if you would like to use zone.js)
  • Material 3 (custom theme, components color variants and sizes)
  • Tailwind (Integration with Material)
  • Dynamic form error messages
  • Bun package manager
  • Eslint (new flat config) & Prettier
  • Husky (pre-commit linting)
  • Schematics (OnPush change detection, inlineStyle and inlineTemplate)

Setup Instructions

  1. Create a new repository using this template:

    • Click the "Use this template" button
    • Then, click “Create a new repository” from the dropdown menu

    Screenshot 2024-07-30 at 23 58 49

  2. Clone the newly created repository:

    Open your terminal and run the following command, replacing your-username and your-new-repo with your GitHub username and the name of your newly created repository:

    git clone https://github.com/__your-username__/__your-new-repo__.git
    cd __your-new-repo__
  3. Run the setup script:

    Make sure you have Node.js installed on your system. Run the setup script to customize your project:

    node setup.js

    You will be prompted to enter your project name. Ensure that you provide a non-empty name:

    Enter your project name: my-angular-app
  4. Install dependencies:

    bun install
  5. Start the development server:

    ng serve

Contributing

If you encounter any issues or have suggestions for improvements, feel free to open an issue or submit a pull request.