mashafrancis/butternut-user

<div align="center">

# Butternut Users

[![Build Status](https://github.com/mashafrancis/butternut-user/workflows/Build%20&%20Test/badge.svg)](https://github.com/mashafrancis/butternut-user/actions)
[![CircleCI](https://circleci.com/gh/mashafrancis/butternut-user.svg?style=svg)](https://circleci.com/gh/mashafrancis/butternut-user)
[![Test Coverage](https://api.codeclimate.com/v1/badges/f6bdcb4f36837ce24b06/test_coverage)](https://codeclimate.com/github/mashafrancis/butternut-user/test_coverage)
[![Maintainability](https://api.codeclimate.com/v1/badges/f6bdcb4f36837ce24b06/maintainability)](https://codeclimate.com/github/mashafrancis/butternut-user/maintainability)

</div>

<div align="center">

    Butternut API user management micro-userService

  [![Butternut](../public/img/readme.svg)](https://butternut.com)

  #### Simple but complicated butternut

</div>

### Description
This is the user management micro-userService for the butternut project used for user authentication and user profiling.

### Application Links and Documentation

-   Frontend (Butternut App Hosting):
    [butternut react web app](https://butternut-staging.herokuapp.com/)

-   Postman collection
    <br />
    <br />
    [![Run in Postman](https://run.pstmn.io/button.svg)](https://app.getpostman.com/run-collection/2222c2a8892e4e7c4b7e#?env%5Bbutternut%5D=W3sia2V5IjoiYmFzZS11cmwiLCJ2YWx1ZSI6IiIsImVuYWJsZWQiOnRydWV9LHsia2V5IjoidG9rZW4iLCJ2YWx1ZSI6IiIsImVuYWJsZWQiOnRydWV9XQ==)


### Running the app

```bash
# development
$ yarn start

# watch mode
$ yarn start:dev

# production mode
$ yarn start:prod
```

### Test

```bash
# unit tests
$ yarn test:unit

# e2e tests
$ yarn test:e2e

# test coverage
$ yarn test:cov
```

### Stay in touch

- Author - [Francis Masha](https://mashafrancis.com)
- Website - [https://butternut.com](https://butternut.com/)
- Twitter - [@butternut](https://twitter.com/butternut)

### License

  Nest is [MIT licensed](LICENSE).