📝 Ajout du readme

Author: mckenziearts

README.md

@@ -1,27 +1,36 @@
-# NgrxApp
+# Cosna Admin Cpanel
 
-This project was generated with [Angular CLI](https://github.com/angular/angular-cli) version 13.3.5.
+🚀 Admin panel boilerplate to quickly scaffold any large scale enterprise application for Angular. Built with the Tailwind, fully customizable and developer-first.
+This project use ANgular 13+
 
-## Development server
+### ⏳ Installation
 
-Run `ng serve` for a dev server. Navigate to `http://localhost:4200/`. The application will automatically reload if you change any of the source files.
+Clone the repo locally:
+```bash
+git clone https://gitlab.com/i2658/cosna-afrique/boilerplate/cpanel.angular.git cpanel.angular && cd cpanel.angular
+```
 
-## Code scaffolding
+Install NPM dependencies:
+```bash
+npm i
+```
 
-Run `ng generate component component-name` to generate a new component. You can also use `ng generate directive|pipe|service|class|guard|interface|enum|module`.
+Setup configuration:
+```bash
+cp .env.example .env
+```
 
-## Build
+### 🖐 Requirements
 
-Run `ng build` to build the project. The build artifacts will be stored in the `dist/` directory.
+**Node:**
 
-## Running unit tests
+- NodeJS >= 14 <= 18
+- NPM >= 6.x
 
-Run `ng test` to execute the unit tests via [Karma](https://karma-runner.github.io).
+### Features
 
-## Running end-to-end tests
-
-Run `ng e2e` to execute the end-to-end tests via a platform of your choice. To use this command, you need to first add a package that implements end-to-end testing capabilities.
-
-## Further help
-
-To get more help on the Angular CLI use `ng help` or go check out the [Angular CLI Overview and Command Reference](https://angular.io/cli) page.
+- **Modern Admin Panel:** Elegant, entirely customizable and a fully extensible admin panel.
+- **Secure by default:** Roles, Guard and more.
+- **Authentication Module:** All authentication features enabled (Login, Reset Password, Forgot Password, Logout).
+- **Shared module:** All reusabled customize components.
+- **Theme module:** Theme management with Auth and Cpanel Layout.