https://github.com/mathiscode/helio-mod-users

Users mod for Helio API Boilerplate
https://github.com/mathiscode/helio-mod-users

Last synced: 9 days ago
JSON representation

Users mod for Helio API Boilerplate

• Host: GitHub
• URL: https://github.com/mathiscode/helio-mod-users
• Owner: mathiscode
• License: mit
• Created: 2019-05-25T19:40:14.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2023-01-03T22:39:56.000Z (almost 2 years ago)
• Last Synced: 2024-11-27T20:17:49.253Z (26 days ago)
• Language: JavaScript
• Size: 1.03 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 16
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Helio API Boilerplate: Users Mod

Handles user registration, authentication, profile/setting management, and more.

This mod may be installed into projects utilizing [Helio API Boilerplate](https://github.com/mathiscode/helio-api-boilerplate).

---

- [Helio API Boilerplate: Users Mod](#helio-api-boilerplate-users-mod)

  - [Install](#install)

  - [Methods](#methods)

    - [`GET /`](#get)

    - [`DELETE /`](#delete)

    - [`POST /register` [public]](#post-register-public)

    - [`POST /login` [public]](#post-login-public)

    - [`GET /logout`](#get-logout)

    - [`GET /settings`](#get-settings)

    - [`GET /settings/:key`](#get-settingskey)

    - [`PUT /settings/:key`](#put-settingskey)

    - [`GET /client-settings`](#get-client-settings)

    - [`PUT /client-settings`](#put-client-settings)

    - [`GET /profile`](#get-profile)

    - [`GET /profile/:key`](#get-profilekey)

    - [`PUT /profile/:key`](#put-profilekey)

    - [`GET /username`](#get-username)

    - [`GET /username/availability` [public]](#get-usernameavailability-public)

    - [`PATCH /username`](#patch-username)

    - [`PATCH /password`](#patch-password)

---

## Install

```sh

yarn add helio-mod-users # or npm install helio-mod-users

```

```js

import UsersMod from 'helio-mod-users'

Mods = [{ path: '/user', module: UsersMod }]

```

[More information on Helio mods](https://github.com/mathiscode/helio-api-boilerplate#mods)

## Methods

### `GET /`

- Get user object of current user

### `DELETE /`

- Delete current user

### `POST /register` [public]

> { email: '[email protected]', password: 'supersecretpassword' }

- Register a new user; returns auth token

### `POST /login` [public]

> { email: '[email protected]', password: 'supersecretpassword' }

- Login as user; returns auth token

### `GET /logout`

- Invalidate token for current user

### `GET /settings`

- Get settings object of current user

### `GET /settings/:key`

- Get setting value with key name :key

### `PUT /settings/:key`

> { value: 'NewValue' }

- Set value for setting with key name :key

### `GET /client-settings`

- Get client settings object; may be used by a frontend to store preferences

### `PUT /client-settings`

> { any: 'thing', can: 'be', stored: 'here' }

- Update the client settings object; may be used by a frontend to store preferences

### `GET /profile`

- Get profile object of current user

### `GET /profile/:key`

- Get value for profile item with key name :key

### `PUT /profile/:key`

> { value: 'NewValue' }

- Set value for profile item with key name :key

### `GET /username`

- Get username of current user

### `GET /username/availability` [public]

> { username: 'MyNewUsername' }

- Check availbility of username

### `PATCH /username`

> { username: 'MyNewUsername' }

- Change username of current user

### `PATCH /password`

> { currentPassword: 'mycurrentpassword', newPassword: 'mynewpass', confirmPassword: 'mynewpass' }

- Update password for current user