/aera-contacts-app-backend

Primary LanguageJava

Area Contact Backend

This simple backend service simulates a Contact app.

📝 Table of Contents

🧐 About

The purpose of this Spring Boot application is to try a new way to query aa Elasticsearch db throw Spring Data.

🏁 Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites

For running this Spring Boot Application you need Java 8 and Docker. If you do not have these things yet here below you can find where get them.

  • Docker for Windows Link
  • Docker for OS X Link
  • Docker compose Link
  • Java for Windows Link
  • Java for Mac Link

🎈 Usage

For run this localy you can use this command:

docker-compose up --build

Rest Endpoint

  • GET /contacts (retrieve all contacts)
  • POST /contacts (add a new contact)
  • PUT /contacts (update a contact)
  • DELETE /contacts (delete a contact)
  • GET /contacts/search (search contacts by phone number full match or full text on other fields)

🚀 Deployment

See TODO.md file.

⛏️ Built Using

✍️ Authors