# @putty_king/auth

> My Moleculer-based microservices project

Latest version **1.0.0** (published 2023-04-18) · 0 weekly downloads

## Install

```sh
npm install @putty_king/auth
pnpm add @putty_king/auth
yarn add @putty_king/auth
bun add @putty_king/auth
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2023-04-18 |
| First published | 2023-04-18 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >= 16.x.x |
| Dependencies | 4 |
| Unpacked size | 81.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | putty-kang |
| Keywords | microservices, moleculer |

## Links

- npm: https://www.npmjs.com/package/@putty_king/auth
- npm.io page: https://npm.io/package/@putty_king/auth

## Dependencies (4)

- [moleculer](https://npm.io/package/moleculer.md) ^0.14.27
- [moleculer-db](https://npm.io/package/moleculer-db.md) ^0.8.21
- [moleculer-web](https://npm.io/package/moleculer-web.md) ^0.10.5
- [moleculer-db-adapter-mongo](https://npm.io/package/moleculer-db-adapter-mongo.md) ^0.4.16

## Recent versions

- 1.0.0 (latest) — 2023-04-18

## README

# moleculer 中间件 权限管理 auth 服务

## 背景

> 基于moleculer分布式中间件模板开发auth权限管理服务

## 开发准备

> 环境基于 Node.js & TypeScript 的开发环境

- `node` 版本 v16.2.0
- `typescript`版本 4.9.3

> 依赖包管理使用 pnpm

- `pnpm` 版本 8.1.1 

## 启动准备

> 初始化项目 `pnpm install` 

## 项目启动

> 1. 测试环境启动
     `pnpm run dev`
> 2. 单机部署
     `pnpm run build && pnpm run start `         
> 3. docker 环境
     启动：`pnpm run dc: up`
     停止：`pnpm run dc: down`
> 4. 单元测试
     `pnpm test`
> 5. 代码格式检查
     `pnpm run lint`

## 代码结构
```
auth
├─ .dockerignore   // docker 构建时需要忽略的文件
├─ .editorconfig    // 配置编码规范
├─ .eslintrc.js    // *js校验
├─ .prettierignore  
├─ .prettierrc.json  // 前后端代码编码格式配置 
├─ .vscode
│ └─ launch.json       // 用于调试的配置文件
│ └─ extensions.json   // 项目用到的插件列表
│ └─ settings.json     // 控制诸多工作项的配置   
├─ docker-compose.env  // docker-compose 环境变量设置
├─ docker-compose.yml  // docker-compose 配置文件
├─ Dockerfile          // 构建镜像所需的指令和说明
├─ mixins
│ └─ db.mixin.ts      
├─ moleculer.config.ts   // moleculer配置文件
├─ package-lock.json     // 使用 npm i 时生成的文件，用于依赖包版本锁定
├─ package.json          // 项目或者模块包的描述
│─ public                // 公共展示页面信息
│ ├─ favicon.ico
│ ├─ index.html
│ └─ main.css
├─ README.md             // 项目说明
├─ services              // moleculer项目服务代码位置
│ ├─ api.service.ts      // 网关服务
│ └─ auth.service.ts     // 普通服务  
├─ test                  // 单元测试代码位置
│ ├─ integration
│ └─ unit
│ ├─ mixins
│ └─ services
├─ tsconfig.build.json   // 项目构建时 有关ts文件的构建配置
├─ tsconfig.eslint.json  // ts文件代码校验
└─ tsconfig.json         // ts文件代码配置信息

```
## 相关链接

* Moleculer website: https://moleculer.services/
* Moleculer Documentation: https://moleculer.services/docs/0.14/
* Moleculer template website：https://github.com/moleculerjs/moleculer-template-project

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