Skip to content

Latest commit

 

History

History
77 lines (58 loc) · 2.17 KB

README.md

File metadata and controls

77 lines (58 loc) · 2.17 KB

Gorack

Go Report Card License: MIT

An API for calculating racking weight for barbell. The api is available here https://gorack.pachevjoseph.com/v1/api

An example application using this API can be found here

Features:

  • Easily Calculate needed weight for any exercise
  • Easily Define bar weight along with available plates
  • Sensible defaults are provided with common weights along with Olympic barbell weight (45lb)
  • Simple to use without any UI needed: v1/api/rack?weigh=335 in your browser will return instant results

Note: returned values should be considered as pairs e.g. (fortyFives: 2 means two forty-five plates on each side)

Getting Started

Installation

A Makefile is included with this repository.

$ make all

The command above will fetch sources and run the application on http://localhost:8080/v1/api

Advanced Requests

If you don't like the defaults provided from the GET call, you can make a POST request with the available weights that you have (the application assumes inputs as pairs).

Example: I'd like to achieve 285 lb with a standard olympic bar with limited plates:

curl -X POST \
  https://gorack.pachevjoseph.com/v1/api/rack \
  -H 'content-type: application/json' \
  -d '{
	"fortyFives": 1,
	"thirtyFives": 1,
	"twentyFives": 1,
	"tens": 1,
	"fives": 2,
	"twoDotFives": 1,
	"desiredWeight": 285
}'

In the request above, "barWeight" was not included as was therefore defaulted to 45lb. The returned payload with look like below (returned values are in pairs):

{
    "fortyFives": 1,
    "thirtyFives": 1,
    "twentyFives": 1,
    "tens": 1,
    "fives": 1,
    "desiredWeight": 285,
    "achievedWeight": 285,
    "message": "You got this!"
}

License

MIT

TODO: Enhance README