zacharydavidsaunders/pseudonameapi

The backend API that serves the Pseudoname website. — A javascript Node/Express API wrapper with middlewares, Mocha/Chai unit tests, and Travis CI integration.

pseudonameapi's Issues

Upgrade ESLint per reports of security issues

NPM is reporting that ESLint has 2 vulnerabilities (1 moderate, 1 high).

ESLint should be updated to address these issues.

Add rate limiting

The API needs rate limiting (see ZacharyDavidSaunders/pseudoname#9).

https://www.npmjs.com/package/express-rate-limit may be a good option.

Improve the API's HTTP method usage

Currently, all the API routes use the GET HTTP method. This makes sense for the / route, however, the /add/ and /delete/ route should used POST and DELETE HTTP methods respectively.

When updating the routes, be sure to also update the README documentation so that the API's clients (notably https://github.com/ZacharyDavidSaunders/pseudoname) can update their code accordingly.

Prevent the daisy-chaining of aliases

Users should not be able to chain aliases (create a new alias with an existing alias provided as the “real email” parameter). Daisy-chained aliases puts unnecessary load on the system.

Fix start script

The existing start script does not work. The script should install and run PseudonameAPI like:

npm install && node ./src/index.js

Install Helmet Js

Helmet JS should be installed and implemented to improve the security of the API.

Make the codebase ES2017 compliant

In an effort to follow industry standards, the codebase should become ES2017 compliant. ESLint will help identify and correct poor usage and will enforce rules going forward.

Add a CONTRIBUTING.md file

A CONTRIBUTING.md file should be created to set guidelines on how to contribute and interact with this repo. Once added, the guidelines will be visible when creating each issue (see https://github.blog/2012-09-17-contributing-guidelines/)