Team ^

Alchemy Code Lab - 401 Group Project

• Mark Petrie ([email protected])
• Stephanie Fitzgerald ([email protected])
• Christy La Guardia ([email protected])

http://carret.herokuapp.com/

Synopsis

Our project is an authentication security solution that is intended for publication as an npm package. Developers can install our security package for use in their new and existing apps that require security. It uses a MongoDB to store user events such as signup, signin/login, failed login, etc., and other relevant user data.

For coding standards and user stories, see our DEVELOPER.md. For a more detailed description and demo code for our endpoints, see the presentation.md. We recommend using postman with these examples to quickly see the responses.

Project Structure

• Lib Directory

  • auth files
  • models
    • email- and ip-blacklist models
    • event model
    • user model
  • routes
    • see below for endpoints
  • utils
    • requests to Sqreen API are here
  • app
  • connect.js for the MongoDB connection
  • error-handler

• server - an http server

• Tests Directory

  • End to End tests
  • Unit tests
  • Some helper modules for e2e tests are included

• Data Directory

  • Seed data as json for use in postman and mongodb queries

• Public Directory

  • This is a minimal front-end for demo purposes

Installation

npm i

Tests

npm test

Dependencies

• Sqreen API
• bcrypt
• body-parser
• dotenv
• express
• jsonwebtoken-promisified
• mongoose
• morgan
• superagent

Endpoints

Method	Route
GET	/auth/verify
POST	/auth/signup
POST	/auth/signin
GET	/me
PATCH	/me
DELETE	/me
GET	/admin/users
GET	/admin/users/:email
PATCH	/admin/users/:email
DELETE	/admin/users/:email
GET	/admin/reports/events
GET	/admin/reports/events?(query)