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.
These instructions will guide you on how to clone the project, install dependencies, and run it locally.
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
-
Open your terminal or command prompt.
-
Change to the directory where you want to clone the project.
-
Run the following command to clone the project:
git clone [email protected]:ojmarte/construction_api.git
-
Change to the project directory:
cd construction_api
-
Run the following command to install the project dependencies:
npm install
-
Start the development server with the following command:
npm run dev
This will run the project using
ts-node
and start the server. -
Open your browser and navigate to
http://localhost:3000
to access the API.
To run the tests for the project, use the following command:
npm test
This will execute the tests using Mocha.
This project is licensed under the MIT License.