Skip to content

romafederico/monash-coding-challenge

Repository files navigation

Monash University Backend Coding Challenge

by Federico Roma

Installation

$ yarn

# or

$ npm install

Running the app

$ yarn run start:dev

# or

$ npm run start:dev

Considerations

  • I created the address book in the form of a REST API using the nestJS framework, to be able to speed delivery and have a modularized application.
  • There is no integration with aany database. Mock data and contacts created are stored in memory, so restarting the nest server will reset the number of available contacts.
  • I included a postman collection of available requests in monash.postman_collection.json

Available API Requests

API Index or Health Check

GET - http://localhost:3000/api

Get all avaiable address books

GET - http://localhost:3000/api/book

Get all contacts of a specific book

GET - http://localhost:3000/api/book/:id

Compare two books

GET - http://localhost:3000/api/book/compare?bookA=1&bookB=2

Get all contacts

GET - http://localhost:3000/api/contact

Create contact

POST - http://localhost:3000/api/contact

Request body:

{
  book: 1,
  name: "Geraldine",
  phone: "+61 (841) 564-2043"
}

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published