Skip to content

Latest commit

 

History

History
executable file
·
195 lines (133 loc) · 6.13 KB

README.md

File metadata and controls

executable file
·
195 lines (133 loc) · 6.13 KB
Raw

Anchor

CircleCI Build Status Dependency Status devDependency Status Coverage Status

A user system API starter with a database administrative system. Bring your own front-end.

Features

  • Login system with forgot password and reset password
  • Abusive login attempt detection
  • User roles for analysts, clinicians, researchers, admins
  • Analyst can view anonymized information
  • Clinician can view information of specific users
  • Researcher can view all information
  • Admins can view update and delete all information
  • Auto Backups
  • Admin UI to view Database Records
  • Custom Event Tracking
  • User Feedback System
  • Email Invites
  • API Tokens

Technology

Anchor is built with the hapi framework. We're using MongoDB as a data store. This project was originally a fork from Frame

Live demo

url username password
https://getframe.herokuapp.com/ root root
https://getframe.herokuapp.com/docs ---- ----

Postman is a great tool for testing and developing APIs. See the wiki for details on how to login.

Requirements

You need Node.js installed and you'll need MongoDB installed and running.

We use bcrypt for hashing secrets. If you have issues during installation related to bcrypt then refer to this wiki page.

Installation

$ git clone [email protected]:hicsail/anchor.git
$ cd anchor
$ npm install

Configuration

Simply edit config.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).

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 following MongoDB collections if they exist: authAttempts, backups, events, feedback, invite, sessions, tokens, and users.

$ npm run first-time-setup

# > [email protected] first-time-setup /home/hicsail/projects/anchor
# > node first-time-setup.js

# MongoDB URL: (mongodb://localhost:27017/anchor)
# Root user email: [email protected]
# Root user password:
# Setup complete.

Running the app

$ npm start

# > [email protected] start /Users/hicsail/projects/anchor
# > ./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/ and see the welcome message.

nodemon watches for changes in server code and restarts the app automatically.

We also pass the --inspect flag to Node so you have a debugger available. Watch the output of $ npm start and look for the debugging URL and open it in Chrome. It looks something like this:

chrome-devtools://devtools/remote/serve_file/@62cd277117e6f8ec53e31b1be58290a6f7ab42ef/inspector.html?experiments=true&v8only=true&ws=localhost:9229/node

Running in production

$ node server.js

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

  • NODE_ENV=production - This is important for many different optimizations.
  • NPM_CONFIG_PRODUCTION=false - This tells $ npm install to not skip installing devDependencies, which we may need to run the first time setup script.

Running with Docker

Running with Docker and Docker Compose is quick and easy. Just run

$ docker-compose up --build

Docker compose will download MongoDB and Node.js into containers and start running the application in production mode.

Have a question?

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

Want to contribute?

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

Running tests

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

$ npm test

# > [email protected] test /Users/hicsail/projects/anchor
# > ./node_modules/lab/bin/lab -c

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

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

License

MIT