From 3cd4ef47694700bd544c98e2a32b8f5554b3ce94 Mon Sep 17 00:00:00 2001 From: Roberto Callari <robertocallari89@gmail.com> Date: Thu, 3 Sep 2020 15:40:32 +0200 Subject: [PATCH] readme --- README.md | 27 ++++++++++++++++++++++++++- 1 file changed, 26 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index aa54e183..fc64fdd7 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 + -- GitLab