GithubHelp home page GithubHelp logo

customermanagement's Introduction

Customer Management

AboutFunctionalitiesHow to executeTechnologiesDeployment documentation

💻 About the project

This is an API to manage the customers


⚙️ Functionalities

  • Save a new customer
  • Retrieve customer's information by Id and by filter
  • Update customer's information

💡 How to execute

before starting

Download Docker and install it. https://desktop.docker.com/win/main/amd64/Docker%20Desktop%20Installer.exe

Running

Clone the project

git clone https://github.com/andreluizralmeida/CustomerManagement.git

through CMD, enter in the folder of the cloned project (CustomerManagement) and run the docker compose command

docker compose up

Open the browser and type this URL: http://localhost/swagger/index.html

image

✅ That's it! Now you are ready to use the customer management project!


👨‍💻 How to use it

You can use the API through Swagger page or any API Client like Postman or Insomnia

Swagger

Choose which operation you want to do.

Creating a new Customer

image

image

image

image

Searching a customer by Id

image

image

image

Searching a customer by filter

image

image

image

  • First Name includes
  • Surname includes

Updating customer information

image

image

image


🛠 Technologies

The following Technologies were used to build this project


🚀 Deployment documentation

Deploy to a live environment;

Write a .yml file with deployment instructions through Kubernete or Jenkins and etc

Handle large volumes of requests, including concurrent creation and update operations

Using some load balancer, like Nginx and transaction or implements Semaphore

Continue operating in the event of problems reading and writing from the database

Implement Resilience Techniques using Hangfire to create a job to retry a fail command. Or Implement some message-broker like Kafka or rabbitMQ to process on demand

Ensure the security of the user information

Add authentication, add SSL, Encrypt sensitive data and not logging de sensitive data

customermanagement's People

Contributors

andreluizralmeida avatar

Stargazers

Karen Almeida 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.