@wizishop/angular-components 18.2.0 → 19.0.0-beta.1

package/README.md

@@ -1,87 +1,24 @@
-# Wizi Angular Components Module
+# AngularComponents
 
-## 1 - Dependencies
+This library was generated with [Angular CLI](https://github.com/angular/angular-cli) version 11.2.12.
 
-- Run `npm i @wizishop/angular-components`.
+## Code scaffolding
 
-- Then install all the lib dependencies & peerDenpendencies.
-You can find the list, in the `package.json` file in `node_modules/@wizishop/angular-components`.
+Run `ng generate component component-name --project angular-components` to generate a new component. You can also use `ng generate directive|pipe|service|class|guard|interface|enum|module --project angular-components`.
+> Note: Don't forget to add `--project angular-components` or else it will be added to the default project in your `angular.json` file. 
 
-Run `npm i nameOfTheDependency`.
+## Build
 
-## 2 - Module & Translation system
+Run `ng build angular-components` to build the project. The build artifacts will be stored in the `dist/` directory.
 
-In `app.module.ts` file :
+## Publishing
 
-```
-import { HttpClient, HttpClientModule } from '@angular/common/http';
-import { TranslateHttpLoader } from '@ngx-translate/http-loader';
-import { TranslateLoader, TranslateModule } from '@ngx-translate/core';
+After building your library with `ng build angular-components`, go to the dist folder `cd dist/angular-components` and run `npm publish`.
 
-import { WiziComponentsModule } from 'angular-components';
+## Running unit tests
 
-export function HttpLoaderFactory(http: HttpClient) {
-  return new TranslateHttpLoader(http, './assets/angular-components/i18n/', '.json');
-}
+Run `ng test angular-components` to execute the unit tests via [Karma](https://karma-runner.github.io).
 
+## Further help
 
-@NgModule({
-  imports: [
-    BrowserModule,
-    BrowserAnimationsModule,
-    CommonModule,
-    ReactiveFormsModule,
-    FormsModule,
-    ...
-    HttpClientModule,
-    TranslateModule.forRoot({
-      defaultLanguage: 'fr',
-      loader: {
-          provide: TranslateLoader,
-          useFactory: (HttpLoaderFactory),
-          deps: [HttpClient]
-      }
-    }),
-    WiziComponentsModule
-  ]
-  ...
-})
-
-```
-
-If you already use ngx-translate, maybe you should use [@ngx-translate/multi-http-loader](https://www.npmjs.com/package/ngx-translate-multi-http-loader) in order to load multiple translation source file.
-
-
-## 3 - Integration / Assets & Styles
-
-- In `angular.json` file add a link to the module assets and a link to calendar script :
-
-```
-assets": [
-              ...
-              {
-                "glob": "**/*",
-                "input": "node_modules/@wizishop/angular-components/assets/",
-                "output": "./assets/angular-components/"
-              }
-            ],
-...
-"scripts": [
-              "node_modules/bulma-calendar/dist/js/bulma-calendar.js"
-            ]
-```
-
-- Add `<link rel="stylesheet" href="https://pro.fontawesome.com/releases/v5.12.1/css/all.css" crossorigin="anonymous" />` in your `index.html` file.
-
-- Copy/paste the following folder in your app project.
-
-[Github link with all scss files to import](https://gitlab.wizishop.com/wizi/angular-components/-/tree/master/projects/showcase/src/scss/includes)
-
-- Make the import of the `import.scss` file in your main scss file :
-
-`@import '@wizishop/angular-components/angular-components';`
-
-
-## 4 - Use components from this module !
-
-All the components of this module starts with `wac-` prefix like `<wac-button>`.
+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.