Skip to content

Latest commit

 

History

History
119 lines (75 loc) · 3.77 KB

README.md

File metadata and controls

119 lines (75 loc) · 3.77 KB

🚀 My Angular Starter

Angular Version Angular Query License: MIT PRs Welcome

Welcome to MyAngularStarter, an Angular template designed to streamline the creation of projects for articles, talks, presentations, and demos with my preferred tools and practices.

✨ Features

🎨 Styles

  • Tailwind CSS: Utility-first CSS framework for rapid UI development.
  • PrimeNG: Comprehensive UI component library for Angular.

🔄 State Management

🛠️ Other Tools

  • Ag Grid: Feature-rich data grid for Angular applications.
  • ngxtension: Angular extensions for enhanced development.

🧑‍💻 Development

🧪 Testing

🌟 Code Quality

  • ESLint: Pluggable linting utility for JavaScript and TypeScript.
    • Sheriff: Enforces architecture rules.
  • Prettier Plugins
    • prettier-plugin-organize-attributes: Automatically organize attributes in your code.
    • @trivago/prettier-plugin-sort-imports: Prettier plugin to sort imports.
    • prettier-plugin-tailwindcss: Integrates Tailwind CSS classes sorting with Prettier.

📦 Getting Started

  1. Clone the repository:

    git clone https://github.com/yourusername/my-angular-starter.git
    cd my-angular-starter
  2. Install dependencies:

    pnpm install
  3. Run the development server:

    pnpm run start
  4. Run the mocked API Server:

    pnpm run start-json-server 

📝 TODO

  • Cypress Component Testing
  • ngrx
  • commitlint
    • husky
    • Releaselog

🤝 Contributing

Contributions, issues, and feature requests are welcome! Feel free to check the issues page.


📜 License

This project is licensed under the MIT License.


📫 Contact

Created by Alfredo Perez - feel free to contact me!


🌟 Acknowledgements

  • Thanks to all the contributors who have made this project possible.

📖 Using Angular Material

Refer to the Angular Material documentation for more information on using Angular Material components.