moonwitch / litterpricebox

LitterPriceBox

LitterPriceBox is a web service that checks the price per kg of a specific brand of cat litter from various stores.

Endpoints

• GET /check-price?url={store_url}: Get the price per kg from the specified store URL.
• GET /swagger/*: Swagger documentation.

Setup

1. Install Go.
2. Clone the repository.
3. Run go mod tidy to install dependencies.
4. Run the server: go run cmd/server/main.go.

Deployment

Deploy to Heroku using the following steps:

1. heroku login
2. heroku create litterpricebox
3. git init
4. git add .
5. git commit -m "initial commit"
6. heroku git:remote -a litterpricebox
7. git push heroku master
8. heroku open

Development

• go run cmd/server/main.go: Run the server locally.
• swag init -g cmd/server/main.go -o docs/: Generate Swagger documentation.