README.md

GarudaNG

This is the component library for the website-based projects of Garuda Linux.

Introduction

GarudaNG is a set of components to use in any kind of Angular project. It is built on PrimeNG.

Documentation

The latest tagged version of the documentation can be found here, for the latest changes instead have a look at the development version.

Usage

The library can be installed using your favourite node package manager.

# pnpm
pnpm add @garudalinux/core

# yarn
yarn add @garudalinux/core

# npm
npm install @garudalinux/core

Changelog

Learn about the latest improvements by reading the changelog.

Development

Getting started

To get started with development, clone the repository and install the dependencies. This repository includes a Nix flakes configuration, so you can use Nix to get started like this:

nix develop

This sets up all pre-commit hooks and installs the dependencies as well. If you don't have Nix available, you can also just use pnpm:

pnpm install

Building the library

To build all the projects, run the following command:

pnpm build

Running the documentation server

To run the documentation server, use the following command:

pnpm "serve docs"

Running the tests

To run the tests, use the following command:

pnpm test

Contributing

If you want to contribute to the project, please read the contributing guidelines.

Like the library? Give us a star ⭐!