diff --git a/README.md b/README.md index aa54e183f42aa272b59b7724c26f099280861047..fc64fdd72473754de39db0a9bea8b5781beefa1c 100644 --- a/README.md +++ b/README.md @@ -1 +1,26 @@ -# Urbanite UI Template \ No newline at end of file +# Urbanite UI Template +This repository contains Urbanite UI Template. This template is built starting from [NGX-Admin](https://akveo.github.io/ngx-admin/), an open source dashboard based on [Angular](https://angular.io/), [Nebular](https://akveo.github.io/nebular/) with [Eva Design System](https://eva.design/). + +## Requirements +To properly install and start the template, the following tools should be installed: +- Git +- Npm +- [Angular CLI](https://cli.angular.io/) + +## Install +To properly install the template, follow these steps: +``` +git clone +cd urbanite-ui-template +npm install +``` + +## Run + +To start the application, follow these steps: +``` +cd urbanite-ui-template +ng serve +``` +The application will be available at http://localhost:4200 +