Construction API

Construction API is a project that provides construction data, including material prices, worker rates, and performance metrics. It is designed for developers, contractors, and project managers in the construction industry.

Getting Started

These instructions will guide you on how to clone the project, install dependencies, and run it locally.

Prerequisites

Before cloning and running the project, make sure you have the following software installed on your system:

• Node.js (version X.X.X or higher)
• npm (version X.X.X or higher)
• Git

Clone the Project

1. Open your terminal or command prompt.

2. Change to the directory where you want to clone the project.

3. Run the following command to clone the project:

   git clone git@github.com:ojmarte/construction_api.git
   

Install Dependencies

1. Change to the project directory:

   cd construction_api
   

2. Run the following command to install the project dependencies:

   npm install
   

Run the Project

1. Start the development server with the following command:

   npm run dev
   

   This will run the project using ts-node and start the server.

2. Open your browser and navigate to http://localhost:3000 to access the API.

Running Tests

To run the tests for the project, use the following command:

npm test

This will execute the tests using Mocha.

License

This project is licensed under the MIT License.