in-square (API1)

---

An API for fetching the fix square meter value

📝 Table of Contents

• About
• Getting Started
• Automated Tests
• Deployment
• Built Using
• Authors

🧐 About

An API for fetching the fix square meter value

🏁 Getting Started

Prerequisites

NodeJS and NPM

Installing

To execute the API locally run

npm start

Endpoints to consume

/ (Welcome route)
/get-meter-price

More info about the routes on the Swagger

🔧 Running the tests

This project uses AVA for the unit tests

To execute the tests run

npm test

🚀 Deployment

This project uses the Github Actions CI/CD and Docker to deploy automatically to the Heroku Server

⛏️ Built Using

• NodeJs - Server Environment
• Express - Server Framework
• Docker - Image deployment
• AVA - Test Framework

✍️ Authors

• @dev-John