Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/haru52/clean-user-manager

CLI of a user management system. This is an example TypeScript project of Clean Architecture.
https://github.com/haru52/clean-user-manager

clean-architecture cli typescript

Last synced: 13 days ago
JSON representation

CLI of a user management system. This is an example TypeScript project of Clean Architecture.

Host: GitHub
URL: https://github.com/haru52/clean-user-manager
Owner: haru52
License: wtfpl
Created: 2022-08-21T13:57:01.000Z (about 2 years ago)
Default Branch: main
Last Pushed: 2023-01-23T00:33:02.000Z (almost 2 years ago)
Last Synced: 2024-10-11T01:55:04.440Z (about 1 month ago)
Topics: clean-architecture, cli, typescript
Language: TypeScript
Homepage: https://www.npmjs.com/package/@haru52/usermgr
Size: 2.21 MB
Stars: 0
Watchers: 2
Forks: 0
Open Issues: 1
Metadata Files:
- Readme: README.md
- Contributing: docs/CONTRIBUTING.md
- License: LICENSE
- Code of conduct: docs/CODE_OF_CONDUCT.md
- Security: docs/SECURITY.md

Awesome Lists containing this project

README

        
# Clean User Manager: usermgr

[![Test](https://github.com/haru52/clean-user-manager/actions/workflows/test.yml/badge.svg)](https://github.com/haru52/clean-user-manager/actions/workflows/test.yml)

[![Release](https://github.com/haru52/clean-user-manager/actions/workflows/release.yml/badge.svg)](https://github.com/haru52/clean-user-manager/actions/workflows/release.yml)

[![CodeQL](https://github.com/haru52/clean-user-manager/actions/workflows/codeql-analysis.yml/badge.svg)](https://github.com/haru52/clean-user-manager/actions/workflows/codeql-analysis.yml)

[![Copy/Paste](report/jscpd-badge.svg)](report/jscpd-report.md)

[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](https://haru52.github.io/clean-user-manager/CODE_OF_CONDUCT.html)

[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](https://commitizen.github.io/cz-cli/)

[![semantic-release: conventionalcommits](https://img.shields.io/badge/semantic--release-conventionalcommits-e10079?logo=semantic-release)](https://github.com/semantic-release/semantic-release)

## Overview

CLI of a user management system. This is an example TypeScript project of [Clean Architecture](https://blog.cleancoder.com/uncle-bob/2012/08/13/the-clean-architecture.html).

## Requirements

| Tool            | Version                                          |

| --------------- | ------------------------------------------------ |

| Node.js and npm | `engines` values in [package.json](package.json) |

## Installation

```sh

npm i -g @haru52/usermgr

```

## Usage

```console

Usage: usermgr [options] [command]

CLI of a user management system. This is an example TypeScript project of Clean Architecture.

Options:

  -V, --version    output the version number

  -h, --help       display help for command

Commands:

  register   register a new user

  show         show the user

  help [command]   display help for command

```

`usermgr` command generates or updates `.usermgr/usermgr.db` file in your home directory. This is an SQLite DB file. If you want to clean this DB, please delete this DB file (e.g., Run `$ rm "$HOME"/.usermgr/usermgr.db`).

## Update

```sh

npm i -g @haru52/usermgr

```

## Uninstall

```sh

npm r -g @haru52/usermgr

rm -rf "$HOME"/.usermgr

```

## Versioning policy

[Semantic Versioning 2.0.0](https://semver.org/spec/v2.0.0.html)

## License

[WTFPL](LICENSE)

## Contributing

[Contributing Guideline](https://haru52.github.io/clean-user-manager/CONTRIBUTING.html)

## Documentation

[Documentation | clean-user-manager](https://haru52.github.io/clean-user-manager/)

## References

- [Clean Coder Blog](https://blog.cleancoder.com/uncle-bob/2012/08/13/the-clean-architecture.html)

- [Clean Architecture - アスキードワンゴ](https://asciidwango.jp/post/176293765750/clean-architecture)

- [実践クリーンアーキテクチャ │ nrslib](https://nrslib.com/clean-architecture/)

- [Javaでクリーンアーキテクチャする方法　Part.1:ヘキサゴナルアーキテクチャ - ログミーTech](https://logmi.jp/tech/articles/323233)

## Author

[haru](https://haru52.com/)