Giter Club home page Giter Club logo

contactbook's Introduction

Contact Book Managent System

Description

This is a contact book application that allows the user to add, view, update and delete contacts.

Technologies

  • Node.js
  • Express.js
  • Mongodb
  • Mongoose

Table of Contents

Installation

To install necessary dependencies, run the following command:

npm i

Usage

To use the application, run the following command:

npm start

Endpoints

1. companies endpoints

  • GET /api/company - get all companies
  • POST /api/company - create a company
      • body
      {
         "name": "company name",
         "address": "company address",
         "mobileNumber": "company mobile",
         "instagramHandle": "company insta handle",
         "emailId": "company email"
      }
      

2. contacts endpoints

  • GET /api/contacts - get contacts

    • query params
      • mobileNumber, emailID, instagramHandle
        • get specific contact with all company details
      • comapanyId
        • get all conatacts of specific company
  • POST /api/contacts - create a contact

    • query params
      • companyId
        • company ID to create the contact with
      • body
        {
            "name": "contact name",
            "address": "contact address",
            "mobileNumber": "contact mobile",
            "instagramHandle": "contact insta handle",
            "emailId": "contact email"
        }
        ```
      
  • POST /api/contacts/bulk - delete a contact

    • query params
      • companyId
        • company ID to create the contact with
      • body
        [ 
            {
                "name": "contact name",
                "address": "contact address",
                "mobileNumber": "contact mobile",
                "instagramHandle": "contact insta handle",
                "emailId": "contact email"
            },
            ...
        ]
      
  • PUT /api/contacts - update a contact

    • update contact

contactbook's People

Contributors

nikkyamresh avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.