# @btcraft/genesis

> Bitcraft scaffolding project

Latest version **0.0.7** (published 2020-01-05) · MIT license · 0 weekly downloads

## Install

```sh
npm install @btcraft/genesis
pnpm add @btcraft/genesis
yarn add @btcraft/genesis
bun add @btcraft/genesis
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.7 |
| Published | 2020-01-05 |
| First published | 2019-12-24 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 21 |
| Unpacked size | 1.8 MB |
| Known vulnerabilities | 0 (+24 in 4 direct dependencies) |
| Install scripts | no |
| Author | Dmitrij Rysanow |
| Maintainers | thecyberd3m0n |
| Keywords | genesis, boilerplate |

## Links

- npm: https://www.npmjs.com/package/@btcraft/genesis
- Repository: https://gitlab.com/bitcraft-crypto/genesis
- Homepage: https://gitlab.com/bitcraft-crypto/genesis#readme
- Issues: https://gitlab.com/bitcraft-crypto/genesis/issues
- npm.io page: https://npm.io/package/@btcraft/genesis

## Dependencies (21)

- [rxjs](https://npm.io/package/rxjs.md) ~6.4.0
- [tslib](https://npm.io/package/tslib.md) ^1.10.0
- [zone.js](https://npm.io/package/zone.js.md) ~0.9.1
- [hammerjs](https://npm.io/package/hammerjs.md) ^2.0.8
- [@ngrx/store](https://npm.io/package/@ngrx/store.md) ^8.6.0
- [@angular/cdk](https://npm.io/package/@angular/cdk.md) ~8.2.3
- [@ngrx/entity](https://npm.io/package/@ngrx/entity.md) ^8.6.0
- [@angular/core](https://npm.io/package/@angular/core.md) ~8.2.14
- [@ngrx/effects](https://npm.io/package/@ngrx/effects.md) ^8.6.0
- [@angular/forms](https://npm.io/package/@angular/forms.md) ~8.2.14
- [@angular/common](https://npm.io/package/@angular/common.md) ~8.2.14
- [@angular/router](https://npm.io/package/@angular/router.md) ~8.2.14
- [@angular/compiler](https://npm.io/package/@angular/compiler.md) ~8.2.14
- [@angular/material](https://npm.io/package/@angular/material.md) ~8.2.3
- [@angular/animations](https://npm.io/package/@angular/animations.md) ~8.2.14
- [@angular/flex-layout](https://npm.io/package/@angular/flex-layout.md) ^8.0.0-beta.27
- [@ngrx/store-devtools](https://npm.io/package/@ngrx/store-devtools.md) ^8.6.0
- [material-design-icons](https://npm.io/package/material-design-icons.md) ^3.0.1
- [@angular/platform-browser](https://npm.io/package/@angular/platform-browser.md) ~8.2.14
- [ng-material-multilevel-menu](https://npm.io/package/ng-material-multilevel-menu.md) ^4.11.3
- [@angular/platform-browser-dynamic](https://npm.io/package/@angular/platform-browser-dynamic.md) ~8.2.14

## Recent versions

- 0.0.7 (latest) — 2020-01-05
- 0.0.6 — 2020-01-05
- 0.0.5 — 2020-01-05
- 0.0.4 — 2020-01-05
- 0.0.3 — 2020-01-01
- 0.0.2 — 2019-12-30
- 0.0.1 — 2019-12-28
- 0.0.0 — 2019-12-24

## README

# GENESIS - Never write same thing again

Ready to use Component and Modules Library for Angular 2+

### Features

- UX Modules
- Security Module

### Usage
- Client:
	- `ng new client`
	- Install UX dependencies

```
cd client && npm install  @angular/animations @angular/cdk @angular/material hammerjs ng-material-multilevel-menu material-design-icons @angular/flex-layout
```
  - Install state management - it's needed for Security Module

```
npm install @ngrx/store @ngrx/entity @ngrx/effects --save
```
  - install @bitcraft/genesis
```
npm i @btcraft/genesis --save
```
  - Make your main NgModule look like:

```
import { ModuleWithProviders, NgModule } from '@angular/core';
import { FlexLayoutModule } from '@angular/flex-layout';
import { BrowserModule } from '@angular/platform-browser';
import { BrowserAnimationsModule } from '@angular/platform-browser/animations';
import { RouterModule, Routes } from '@angular/router';
import { UxModule } from '@btcraft/genesis/dist/ux';
import { EffectsModule } from '@ngrx/effects';
import { StoreModule } from '@ngrx/store';
import { StoreDevtoolsModule } from '@ngrx/store-devtools';
import { environment } from '../environments/environment';
import { AppRoutingModule } from './app-routing.module';
import { AppComponent } from './app.component';
export const routes: Routes = [
  {
    path: 'security',
    loadChildren: () =>
      import('@btcraft/genesis/dist/security').then(
        m => m.SecurityModule
      )
  }
];

const ModuleRouting: ModuleWithProviders = RouterModule.forRoot(routes);
@NgModule({
  declarations: [
    AppComponent
  ],
  imports: [
    BrowserModule,
    AppRoutingModule,
    UxModule,
    FlexLayoutModule,
    ModuleRouting,
    StoreModule.forRoot({}),
    EffectsModule.forRoot([]),
    StoreDevtoolsModule.instrument({
      maxAge: 25, // Retains last 25 states
      logOnly: environment.production, // Restrict extension to log-only mode
    }),
    BrowserAnimationsModule,
  ],
  providers: [],
  bootstrap: [AppComponent]
})
export class AppModule { }
```
- Add styles to your angular json
```
            "styles": [
              "node_modules/@btcraft/genesis/dist/_theme.scss",
            ],
```

---
_Source: https://npm.io/package/@btcraft/genesis · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._