https://github.com/wmfs/tymly-users-plugin

https://github.com/wmfs/tymly-users-plugin

plugin tymly

Last synced: 22 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/wmfs/tymly-users-plugin
• Owner: wmfs
• License: mit
• Created: 2018-06-12T14:16:20.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2023-10-02T18:34:32.000Z (over 1 year ago)
• Last Synced: 2024-12-09T22:41:21.383Z (about 2 months ago)
• Topics: plugin, tymly
• Language: JavaScript
• Size: 943 KB
• Stars: 0
• Watchers: 7
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# tymly-users-plugin

[![Tymly Plugin](https://img.shields.io/badge/tymly-plugin-blue.svg)](https://tymly.io/)

[![npm (scoped)](https://img.shields.io/npm/v/@wmfs/tymly-users-plugin.svg)](https://www.npmjs.com/package/@wmfs/tymly-users-plugin)

[![CircleCI](https://circleci.com/gh/wmfs/tymly-users-plugin.svg?style=svg)](https://circleci.com/gh/wmfs/tymly-users-plugin)

[![codecov](https://codecov.io/gh/wmfs/tymly-users-plugin/branch/master/graph/badge.svg)](https://codecov.io/gh/wmfs/tymly-users-plugin)

[![CodeFactor](https://www.codefactor.io/repository/github/wmfs/tymly-users-plugin/badge)](https://www.codefactor.io/repository/github/wmfs/tymly-users-plugin)

[![Dependabot badge](https://img.shields.io/badge/Dependabot-active-brightgreen.svg)](https://dependabot.com/)

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

[![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)

[![license](https://img.shields.io/github/license/mashape/apistatus.svg)](https://github.com/wmfs/tymly-users-plugin/blob/master/LICENSE)

> This plugin handles interactions to do with a user.

...

## Install

```bash

$ npm install tymly-users-plugin --save

```

## Testing

Before running the tests, you'll need a test PostgreSQL database available and set a `PG_CONNECTION_STRING` environment variable to point to it, for example:

```PG_CONNECTION_STRING=postgres://postgres:postgres@localhost:5432/my_test_db```

Once the environment variables have been set, you can run the tests like this:

```bash

$ npm test

```

## License

[MIT](https://github.com/wmfs/tymly/blob/master/LICENSE)