Skip to content
Get packs

Guide · Open source

How to use ngx-admin: clone, build and customise an Angular dashboard

Updated · written with AI from the project's own documentation and checked against our catalogue data

ngx-admin is an open-source Angular admin dashboard template built on the Nebular component library. It gives you prebuilt pages, layouts and UI components so you do not have to build the basic dashboard structure from scratch. This guide explains what you need, how to get the code running locally, and how to decide whether it fits your project.

ngx-adminakveo/ngx-admin · ★ 25.7k · MIT

Quick start

  1. 1Check Node.js. Confirm that Node.js is version 14.14 or newer on your machine.
  2. 2Clone the repository. Run git clone on the ngx-admin repository from GitHub.
  3. 3Follow the install guidelines. Use the installation guidelines in the official documentation to build the project.
  4. 4Choose a branch. Use the main branch for the full template, the starter-kit branch for an empty base, or feat/material-theme for the material theme.
  5. 5Pick a theme. Switch between the bundled visual themes to match your design direction.
  6. 6Build your pages. Use the existing pages, layouts and Nebular components as a reference for your own dashboard.

What do you need before you start with ngx-admin?

ngx-admin is installed by cloning the repository and building it, so you need a working Node.js setup. The README asks for Node.js version 14.14 or newer, because of the node-sass version used in the application.

The project assumes working knowledge of Angular and TypeScript. Setup and customisation are not written as a beginner tutorial, so if you are new to both, learn the basics first.

  • Node.js 14.14 or newer
  • Working knowledge of Angular and TypeScript
  • Git, to clone the repository
node --version

How do you install ngx-admin from the repository?

The install method is clone-and-build. Start by cloning the repository from GitHub into a folder on your machine.

After cloning, move into the project folder and follow the installation guidelines in the official documentation for the remaining build steps.

  • Check that your Node.js version is 14.14 or newer.
  • Clone the repository to your machine.
  • Follow the installation guidelines in the official documentation to build the project.
git clone https://github.com/akveo/ngx-admin.git

What does ngx-admin include out of the box?

The README lists Angular and TypeScript, Bootstrap 4+ with SCSS, a responsive layout and RTL support. It also includes an authentication module with multiple providers, and a set of themes you can switch between.

The template uses Nebular modules. The README lists 40+ Angular components and 60+ usage examples, which you can use as a reference when building your own pages.

  • Responsive layout and RTL support
  • Bootstrap 4+ and SCSS styling
  • Flexibly configurable themes with hot-reload (3 themes included in the feature list)
  • Authentication module with multiple providers
  • 40+ Angular components and 60+ usage examples

How do you pick a theme in ngx-admin?

The README shows several visual themes, including default, dark, cosmic and corporate, which you can select through the theme parameter on the dashboard page. The material theme is on a separate branch.

To use the material theme, the README says to check out the feat/material-theme branch. It states that the material theme is backward-compatible for existing ngx-admin users.

  • Default, dark, cosmic and corporate themes are shown in the README demo links.
  • Material Dark and Material Light are part of the material theme.
  • Material theme is on the feat/material-theme branch.
git checkout feat/material-theme

Should you start from the full template or the starter kit?

If you do not need every page and module, the README points to a starter-kit branch, which is an empty starter kit for new projects.

Choose the main branch to learn from a project with many pages and components. Choose the starter-kit branch if you want a smaller base to build on.

  • Full template: many pages and components to explore and learn from.
  • starter-kit branch: a leaner base without all pages and modules.
git checkout starter-kit

What should you check before adopting ngx-admin for a long-term project?

The README states the repository is in minimal maintenance. The main focus is keeping the Angular version up to date. The maintainers say they are not actively reviewing or merging pull requests, and are not actively responding to or resolving issues.

Plan for that when you decide. You may need to maintain your own fixes and upgrades, and you should not expect community issues to be resolved upstream.

  • Upstream focus is on keeping Angular up to date.
  • Pull requests and issues are not actively reviewed or merged.
  • Projects that need active upstream support should choose something else.

What people use it for

  • Starting a new Angular admin or back-office dashboard without building the layout from scratch
  • Building a product with Nebular-based components and a few visual themes
  • Learning from an Angular project with many pages and components
  • Using the included authentication module with multiple providers as a starting point

Frequently asked questions

Is ngx-admin free to use?

ngx-admin is released under the MIT licence, as listed in the project details. Check the LICENSE file in the repository for the full terms before you ship a product.

What version of Node.js does ngx-admin need?

The README says to use Node.js version 14.14 or newer. This is because of the node-sass version used in the application.

How do I install ngx-admin?

Clone the repository with git clone from github.com/akveo/ngx-admin, then follow the installation guidelines in the official documentation to build it.

Is ngx-admin still maintained?

The README says the repository is in minimal maintenance. The focus is on keeping the Angular version up to date, and pull requests and issues are not actively reviewed or merged.

Is ngx-admin built on Nebular?

Yes. The template uses the Nebular modules set, and the README links to Nebular documentation for guides on working with it.

What is the difference between ngx-admin and the material theme?

The material theme is a separate version on the feat/material-theme branch, based on Angular Material. The README says it is backward-compatible for existing ngx-admin users.

New agent skills, repos and AI tools — every week

The best new skills and open-source projects, the fastest-growing repos, and one free prompt. Five minutes to read. Unsubscribe anytime.

Our verdict

ngx-admin suits developers who know Angular and TypeScript and want a Nebular-based admin dashboard with several themes and an authentication module as a starting point. Teams that need active upstream support, or beginners new to both Angular and TypeScript, should pick a different option or learn the basics first.

Install options & downloads