No longer maintained

Boilerplates can be a huge time sink to maintain and I've decieded to archivethis project.

Thanks for your interest in my projects.

Frame

A user system API starter. Bring your own front-end.

Features

• Login system with forgot password and reset password
• Abusive login attempt detection
• User roles for accounts and admins
• Admins only notes and status history for accounts
• Admin groups with shared permissions
• Admin level permissions that override group permissions

Technology

Frame is built with the hapi framework. We'reusing MongoDB as a data store.

Bring your own front-end

Frame is only a restful JSON API. If you'd like a ready made front-end,checkout Aqua. Or better yet, forkthis repo and build one on top of Frame.

Live demo

Postman is a great tool for testing anddeveloping APIs. See the wiki for details on how tologin.

Requirements

You need Node.js >=8.x and you'll need aMongoDB >=2.6 server running.

Installation

$ git clone https://github.com/jedireza/frame.git
$ cd frame
$ npm install

Configuration

Simply edit config.js. The configuration usesconfidence which makes it easy tomanage configuration settings across environments. Don't store secrets inthis file or commit them to your repository.

Instead, access secrets via environment variables. We usedotenv to help make setting localenvironment variables easy (not to be used in production).

Simply copy .env-sample to .env and edit as needed. Don't commit .envto your repository.

First time setup

WARNING: This will clear all data in the following MongoDB collections ifthey exist: accounts, adminGroups, admins, authAttempts, sessions,statuses, and users.

$ npm run first-time-setup

# > frame@0.0.0 first-time-setup /home/jedireza/projects/frame
# > node first-time-setup.js

# MongoDB URL: (mongodb://localhost:27017/frame)
# Root user email: jedireza@gmail.com
# Root user password:
# Setup complete.

Running the app

$ npm start

# > frame@0.0.0 start /home/jedireza/projects/frame
# > ./node_modules/nodemon/bin/nodemon.js -e js,md server

# 09 Sep 03:47:15 - [nodemon] v1.10.2
# ...

Now you should be able to point your browser to http://127.0.0.1:9000/ andsee the welcome message.

nodemon watches for changes in servercode and restarts the app automatically.

With the debugger

$ npm run inspect

# > frame@0.0.0 inspect /home/jedireza/projects/frame
# > nodemon --inspect -e js,md server.js

# [nodemon] 1.14.12
# [nodemon] to restart at any time, enter `rs`
# [nodemon] watching: *.*
# [nodemon] starting `node --inspect server.js`
# Debugger listening on ws://127.0.0.1:9229/3d706d9a-b3e0-4fc6-b64e-e7968b7f94d0
# For help see https://nodejs.org/en/docs/inspector
# 180203/193534.071, [log,info,mongodb] data: HapiMongoModels: successfully connected to the db.
# 180203/193534.127, [log,info,mongodb] data: HapiMongoModels: finished processing auto indexes.
# Server started on port 9000

Once started with the debuger you can open Google Chrome and go tochrome://inspect. See https://nodejs.org/en/docs/inspector/for more details.

Running in production

$ node server.js

Unlike $ npm start this doesn't watch for file changes. Also be sure to setthese environment variables in your production environment:

• NODE_ENV=production - This is important for many differentoptimizations.
• NPM_CONFIG_PRODUCTION=false - This tells $ npm install to not skipinstalling devDependencies, which we may need to run the first timesetup script.

Have a question?

Any issues or questions (no matter how basic), open an issue. Please take theinitiative to read relevant documentation and be pro-active with debugging.

Want to contribute?

Contributions are welcome. If you're changing something non-trivial, you maywant to submit an issue before creating a large pull request.

Running tests

Lab is part of the hapi ecosystem and what weuse to write all of our tests.

$ npm test

# > frame@0.0.0 test /home/jedireza/projects/frame
# > lab -c -L

#  ..................................................
#  ..................................................
#  ..................................................
#  ..............

# 164 tests complete
# Test duration: 14028 ms
# No global variable leaks detected
# Coverage: 100.00%
# Linting results: No issues

Targeted tests

If you'd like to run a specific test or subset of tests you can use thetest-server npm script.

You specificy the path(s) via the TEST_TARGET environment variable like:

$ TEST_TARGET=test/server/web/main.js npm run test-server

License

MIT

Don't forget

What you build with Frame is more important than Frame.