Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jkheadley/appy-backend
A user system to bootstrap your app.
https://github.com/jkheadley/appy-backend
api api-server authentication authorization hapi hapi-api login mongodb mongoose permissions registration rest rest-hapi restful-api server swagger user-management user-roles user-system users
Last synced: about 3 hours ago
JSON representation
A user system to bootstrap your app.
- Host: GitHub
- URL: https://github.com/jkheadley/appy-backend
- Owner: JKHeadley
- License: mit
- Created: 2017-01-20T09:56:14.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2023-01-04T06:20:09.000Z (almost 2 years ago)
- Last Synced: 2024-04-15T01:59:55.298Z (7 months ago)
- Topics: api, api-server, authentication, authorization, hapi, hapi-api, login, mongodb, mongoose, permissions, registration, rest, rest-hapi, restful-api, server, swagger, user-management, user-roles, user-system, users
- Language: JavaScript
- Homepage: https://appyapp.io
- Size: 124 MB
- Stars: 108
- Watchers: 14
- Forks: 31
- Open Issues: 21
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.txt
Awesome Lists containing this project
README
A user system leveraging [rest-hapi](https://github.com/JKHeadley/rest-hapi) to bootstrap your app.
appy-backend is the server portion of the [appy](https://appyapp.io) project. It provides a boilerplate user system that leverages the powerful [rest-hapi](https://github.com/JKHeadley/rest-hapi) API generator. Inspired by the [frame](https://github.com/jedireza/frame) user system, the goal of appy-backend is to provide an easy to use user API that is also capable of supporting a wide range of applications. appy-backend is a great resource for starting almost any app. By leveraging [rest-hapi](https://github.com/JKHeadley/rest-hapi), adding new endpoints is as simple as defining a new model, and model associations are a snap. Bootstrapping your app has never been easier!
## Features
* Registration and account activation flows
* Login system with forgot password and reset password
* Social login
* Abusive login attempt detection
* User permissions based on roles and groups
* Three optional authentication strategies
* Websocket chat via [@hapi/nes](https://github.com/hapijs/nes)
* File upload api
* Endpoint validation and query support
* Swagger docs for easy endpoint access
## Technologies
appy-backend implements a [hapi](https://github.com/hapijs/hapi) framework server. appy-backend's RESTful API endpoints are generated through [rest-hapi](https://github.com/JKHeadley/rest-hapi), which means models are based off of [mongoose](https://github.com/Automattic/mongoose) and data is stored in [MongoDB](www.mongodb.org).
## Demos
View the swagger docs for the **live demo**:
https://api.appyapp.io
### Starting appy-backend
### Logging in
### GET /users
### Filter Query and Populate Relationship
## Readme contents
- [Requirements](#requirements)
- [Getting Started](#getting-started)
- [Installation](#installation)
- [Configuration](#configuration)
- [First time setup](#first-time-setup)
- [Running appy](#running-appy)
- [Wiki](#wiki)
- [Swagger documentation](#swagger-documentation)
- [Authentication](#authentication)
- [Authorization](#authorization)
- [License](#license)
- [Questions](#questions)
- [Contributing](#contributing)
- [Thanks!](#thanks)
## Requirements
Just [Docker](https://docs.docker.com/install)
**OR**
You need [Node.js](https://nodejs.org/en/) installed (>=12.14.1) and you'll need [MongoDB](https://docs.mongodb.com/manual/installation/) installed and running.
[Back to top](#readme-contents)
## Getting Started
Download from GitHub:
```bash
$ git clone https://github.com/JKHeadley/appy-backend.git
$ cd appy-backend
```
## Installation
### Using Docker
None required.
### Without Docker
```bash
$ npm install
```
[Back to top](#readme-contents)
## Configuration
appy configuration follows [frame's](https://github.com/jedireza/frame) configuration flow:
> Simply edit ``config/index.js``. The configuration uses confidence which makes it easy to manage configuration settings across environments. Don't store secrets in this file or commit them to your repository.
> Instead, access secrets via environment variables. We use dotenv to help make setting local environment variables easy (not to be used in production).
### Using Docker
> Simply copy .env-docker-sample to .env-docker and edit as needed. Don't commit .env-docker to your repository.
### Without Docker
> Simply copy .env-sample to .env and edit as needed. Don't commit .env to your repository.
## First time setup
**WARNING**: This will clear all data in the MongoDB database defined in ``restHapiConfig.mongo.URI`` (default ``mongodb://localhost/appy``).
If you would like to seed your database with some data, run:
### Using Docker
```
$ sh seed_data.sh
```
### Without Docker
```
$ npm run seed
```
NOTE: The password for all seed users is ``root``.
[Back to top](#readme-contents)
## Running appy-backend
To quickly run the app locally, simply run:
## Using Docker
```
$ sh run_server.sh
```
## Without Docker
```
$ npm start
```
Once the app is running point your browser to http://localhost:8080/ to view the Swagger docs.
[Back to top](#readme-contents)
## Wiki
For detailed explanations on many of the topics covered in this readme, including authentication, authorization, and logging in and testing endpoints, please refer to the [wiki pages](https://github.com/JKHeadley/appy-backend/wiki).
[Back to top](#readme-contents)
## Swagger documentation
Swagger documentation is automatically generated for all endpoints and can be viewed by pointing a browser at the server URL. By default this will be http://localhost:8080/. The swagger docs provide quick access to testing your endpoints along with model schema descriptions and query options.
[Back to top](#readme-contents)
## Authentication
There are three optional authentication strategies in appy and each make use of javascript web tokens (JWT) and the [hapi-auth-jwt2](https://www.npmjs.com/package/hapi-auth-jwt2) scheme. The three strategies are:
1. Standard token
2. Session
3. Session with refresh token
The strategy used is determined by the ``restHapiConfig.authStrategy`` config property.
For a more in-depth description of these strategies, please view the [wiki](https://github.com/JKHeadley/appy-backend/wiki/Authentication).
[Back to top](#readme-contents)
## Authorization
Authorization in appy is enforced via the hapi ``scope`` endpoint property. Endpoints generated through [rest-hapi](https://github.com/JKHeadley/rest-hapi) come prepopulated with scope values. See the [rest-hapi docs](https://resthapi.com/docs/authorization.html) for more info.
User scope values are populated based on appy's permission system. User's gain permissions based on three associations:
1. User defined permissions
2. Group defined permissions
3. Role defined permissions
Users must belong to at least one role and can belong to multiple groups. Each permission association carries with it a ``state`` property that can be set to `Included`, `Excluded`, or `Forbidden`. This property allows permissions to override each other based on priority. User permissions have the highest priority, followed by Group permissions and lastly Role permissions:
```
User->Group->Role
```
This allows easy and specific configuration of user endpoint access. In general, a user will gain the majority of it's permissions through it's role. Those permissions will be further defined by any groups the user belongs to. Finally a user might have a few specific permissions assigned directly to them. A user's scope final scope is a combination of the user's role, groups, and effective permissions. See below for an example:
User: ``'[email protected]'``
Role: ``'Admin'``
Role Permissions:
```javascript
[
{ name:'readUser', state:'Included' },
{ name:'updateUser', state:'Included' },
{ name:'addUserPermissions', state:'Included' },
{ name:'removeUserPermissions', state:'Included' }
]
```
User's Groups: ``['Managers']``
Group Permissions:
```javascript
[
{ name:'updateUser', state:'Excluded' },
]
```
User Permissions:
```javascript
[
{ name:'removeUserPermissions', state:'Excluded' },
]
```
Final User Scope:
```javascript
['Admin','Managers','readUser','addUserPermissions']
```
For a more in-depth description of authorization within appy, please view the [wiki](https://github.com/JKHeadley/appy-backend/wiki/Authorization)
[Back to top](#readme-contents)
## License
MIT
[Back to top](#readme-contents)
## Questions?
If you have any questions/issues/feature requests, please feel free to open an [issue](https://github.com/JKHeadley/appy-backend/issues/new). We'd love to hear from you!
[Back to top](#readme-contents)
## Contributing
Please reference the contributing doc: https://github.com/JKHeadley/appy-backend/blob/master/CONTRIBUTING.md
[Back to top](#readme-contents)
## Thanks!
We hope you enjoy appy-backend!