RestAdmin

This library was generated with Angular CLI version 12.1.0.

RestAdmin for Angular

License

RestAdmin is licensed under the MIT license.

Installation

npm i @foris-master/ngx-rest-admin

or

yarn add @foris-master/ngx-rest-admin

Usage

Add the RestAdminModule to the imports of the module which will be using the RestAdmin.

// in app.module.ts
import { BrowserModule } from '@angular/platform-browser';
import { RestAdminModule } from '@foris-master/ngx-rest-admin';

import { AppRoutingModule } from './app-routing.module';
import { AppComponent } from './app.component';
import { RESOURCES_CONFIG } from './rest-admin-config';

@NgModule({
  ...
  imports: [
    BrowserModule,
    RestAdminModule.forRoot(RESOURCES_CONFIG),
    AppRoutingModule
  ],
  ...
})
export class AppModule { }

Configure your app with the name, the ressources and the baseUrl of the api.

import { REST_CONFIG } from "@foris-master/ngx-rest-admin";
import { resources } from "./resources";

export const RESOURCES_CONFIG: REST_CONFIG = {
  name: "The name of your app",
  resources: resources,
  baseUrl: "https://api.exmaple.com/api",
  authConfig: {
    strategy: STRATEGY_AUTH.EMAIL,
    loginEndPoint: '/auth/signin',
    logoutEndPoint: '/auth/logout',
    userInfoEndPoint: '/users/me',
    profileNameEndPoint: 'name',
    profilePictureEndPoint: 'picture',
    redirectRouteAfterLogin: '/address', //juste mettre le nom de la ressource
  },
};

HTML Example

Add this in our app-routing.module.ts

Add in our app-routing.module.ts

import { NgModule } from '@angular/core';
import { ExtraOptions, RouterModule, Routes } from '@angular/router';

const routes: Routes = [{ path: '**', redirectTo: '/' }];

const config: ExtraOptions = {
  useHash: false,
};

@NgModule({
  imports: [RouterModule.forRoot(routes, config)],
  exports: [RouterModule],
})
export class AppRoutingModule {}

Add Dependency Style

Add 'node_modules/@foris-master/ngx-rest-admin/assets/style/styles.scss' style file:

node_modules/bootstrap/dist/css/bootstrap.css node_modules/typeface-exo/index.css node_modules/roboto-fontface/css/roboto/roboto-fontface.css, node_modules/ionicons/scss/ionicons.scss node_modules/socicon/css/socicon.css, node_modules/nebular-icons/scss/nebular-icons.scss node_modules/pace-js/templates/pace-theme-flash.tmpl.css, node_modules/leaflet/dist/leaflet.css, node_modules/@fortawesome/fontawesome-free/css/all.css, node_modules/@foris-master/ngx-rest-admin/assets/style/styles.scss

to angular.json styles array:

"styles": [
  "node_modules/bootstrap/dist/css/bootstrap.css",
  "node_modules/typeface-exo/index.css",
  "node_modules/roboto-fontface/css/roboto/roboto-fontface.css",
  "node_modules/ionicons/scss/ionicons.scss",
  "node_modules/socicon/css/socicon.css",
  "node_modules/nebular-icons/scss/nebular-icons.scss",
  "node_modules/pace-js/templates/pace-theme-flash.tmpl.css",
  "node_modules/leaflet/dist/leaflet.css",
  "node_modules/@fortawesome/fontawesome-free/css/all.css",
  "node_modules/@foris-master/ngx-rest-admin/assets/style/styles.scss",
  "src/styles.css"
],

Options

| Options | Type | Default | Description | | ------------------------ | ------------------------ | --------------------------------- | ------------------------------------------------------------------------------------------------------------- | | REST_CONFIG | REST_CONFIG | | configure your app

Examples and Tutorials

A great step-by-step example of making an Angular CLI project with a library distributed separate from the app , by Geol1

Library Contributions

• Fork repo.
• Update ./projects/rest-admin
• Update ./src/lib with new functionality.
• Update README.md

Helpful commands

• Build lib: $ npm run lib:build
• Copy license and readme files: $ npm run copy-files
• Create package: $ npm run npm_pack
• Build lib and create package: $ npm run package

Contributors

Thanks goes to these wonderful people (emoji key):