Giter VIP home page Giter VIP logo

rest-contact-api's Introduction

Contact Service API

Welcome to the Contact Service API! This API allows you to perform CRUD operations on a contact database.

Installation

  1. Clone the repository:

    git clone https://github.com/VedantSharma11/Interactly-task
  2. Install dependencies:

    cd contact-service-api
    npm install
  3. Create a .env file:

    Create a file named .env in the root directory and add your MongoDB Atlas connection string:

    MONGODB_ATLAS_URI=YOUR_MONGODB_ATLAS_CONNECTION_STRING
  4. Run the application:

    npm start

    The server will start on http://localhost:3000.

How to Run

To run the project, follow these steps:

  1. Start the server:

    npm start

    The server will start on http://localhost:3000.

  2. Access the API guide:

    Visit http://localhost:3000 in your web browser or use a tool like curl:

    curl http://localhost:3000

    This will provide you with a guide on how to use the API endpoints.

API Endpoints

  • GET /contacts: Get all contacts.
  • POST /contacts: Create a new contact.
  • PUT /contacts/:id: Update an existing contact.
  • DELETE /contacts/:id: Delete a contact.
  • GET /contacts/:id: Get a specific contact by ID.

rest-contact-api's People

Contributors

vedantsharma11 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.