Giter Club home page Giter Club logo

cache's Introduction

cache

codecov

This repository follows the hexagonal architecture, the below diagram shows an overview of it.

Local development environment

Requirements

You should have installed Go in your machine, please follow this guide https://golang.org/doc/install

Download the project

git clone https://github.com/cristianchaparroa/cache.git 

Execute the application

You can run the server using the following command

cd path/to/project/cache/
go run *.go

After executes the last commands, you can start to using the API.

Docker

If is not possible create a local environment, and you have docker installed in your machine you can follow the next steps to run the application.

cd path/to/project/cache/
docker build -t cache .
docker run -p 8080:8080 cache

Docker-compose

If you have installed docker and docker-compose you also can deploy the services just with

cd path/to/project/cache/
docker-compose up

It'll start the API server that will be expose in

{host}:8080

Testing

Unit testing

You can run the unit testing using

go test ./... 

Usage

  1. Create an object in memory
curl --request POST \
--url http://localhost:8080/object/1 \
--header 'Content-Type: application/json' \
--data '{
"name": "cristian",
"last": "chaparro",
"country": "Colombia",
"phone": "3226638130"
}'
  1. Get an object by key
curl --request GET \
--url http://localhost:8080/object/1
  1. Update an existent object
curl --request PUT \
  --url http://localhost:8080/object/1 \
  --header 'Content-Type: application/json' \
  --data '{
	"name": "cristian",
	"last": "chaparro",
	"country": "Colombia",
	"phone": "3226638130",
	"another": "field"
}'
  1. Delete an object
curl --request DELETE \
  --url http://localhost:8080/object/1

cache's People

Contributors

cristianchaparroa avatar

Watchers

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