ejklock / client-energy-api

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Client Energy Eligibility Check API

Overview

This is a RESTful API for the Client Energy Eligibility Check.

Technologies

  • TypeScript
  • Fastify
  • Node.js 20.14

Getting Started

To get started with the application, follow these steps:

Prerequisites

Ensure you have Docker and Docker Compose installed on your machine.

Running the Application

  1. Start the application:

    docker-compose up --build

    This command will build and start the application along with its dependencies, including MySQL.

  2. Access the application:

    Open your browser and go to http://0.0.0.0:3333/. You will find the Swagger documentation for the API.

API Usage

Use Swagger interface to manage farms,farmers, reports, farm cultures

About


Languages

Language:TypeScript 99.4%Language:Dockerfile 0.6%