Skip to content

A sample JSON data file will be provided with a base set of acronym definitions. We expect you to create a NodeJS server using modern best practices for API development.

Notifications You must be signed in to change notification settings

will-abule/G2i-Node-JS-Test

Folders and files

NameName
Last commit message
Last commit date

Latest commit

0346318 · Mar 23, 2021

History

3 Commits
Mar 23, 2021
Mar 23, 2021
Mar 23, 2021
Mar 23, 2021
Mar 23, 2021
Mar 23, 2021
Mar 23, 2021
Mar 23, 2021
Mar 23, 2021

Repository files navigation

Will Abule ⬢ G2i NodeJS Test

Instructions

Messaging acronyms are everywhere now. Do you know all of them?

Build a REST API for the World Texting Foundation, also known as WTF.

A sample JSON data file will be provided with a base set of acronym definitions. We expect you to create a NodeJS server using modern best practices for API development. Please consider the recommendations attached as this will list the items we are looking for above.

These endpoints should be created:

  • GET /acronym?from=50&limit=10&search=:search
    • ▶ returns a list of acronyms, paginated using query parameters
    • ▶ response headers indicate if there are more results
    • ▶ returns all acronyms that fuzzy match against :search
  • GET /acronym/:acronym
    • ▶ returns the acronym and definition matching :acronym
  • GET /random/:count?
    • ▶ returns :count random acronyms
    • ▶ the acronyms returned should not be adjacent rows from the data
  • POST /acronym
    • ▶ receives an acronym and definition strings
    • ▶ adds the acronym definition to the db
  • PUT /acronym/:acronym
    • ▶ receives an acronym and definition strings
    • ▶ uses an authorization header to ensure acronyms are protected
    • ▶ updates the acronym definition to the db for :acronym
  • DELETE /acronym/:acronym
    • ▶ deletes :acronym
    • ▶ uses an authorization header to ensure acronyms are protected

Setup

MongoDB Node JS

To install dependencies

in your terminal run

	npm i
To start app

in your terminal run

	npm start
To run test

in your terminal run

	npm run test
To view test coverage

navigate to coverage/lcov-report/index.html

About

A sample JSON data file will be provided with a base set of acronym definitions. We expect you to create a NodeJS server using modern best practices for API development.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages