Skip to content

README.md

Latest commit

 

History

History
68 lines (41 loc) · 1.45 KB

README.md

File metadata and controls

68 lines (41 loc) · 1.45 KB

WaterJugRiddle API

Welcome to the WaterJugRiddle API! This API is designed to solve the classic water jug riddle problem, commonly used in job interview tests.

Getting Started

To get started with the API, follow these instructions:

Prerequisites

  • Node.js installed on your machine
  • npm (Node Package Manager) installed on your machine

Installation

  1. Clone this repository to your local machine:
git clone https://github.com/your_username/WaterJugRiddle-API.git
  1. Navigate into the project directory:
cd WaterJugRiddle-API
  1. Install the dependencies:
npm install

Running the API

To run the API, use the following command:

npm run start

Running Tests

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

npm run test

Accessing Documentation

Once the API is running, you can access the documentation through your web browser using the following URL:

http://localhost:3000/api

Usage

Once the API is up and running, you can start solving water jug riddle problems by making requests to the appropriate endpoints. Please refer to the API documentation for more details on available endpoints and their usage.

Contributing

Contributions are welcome! If you'd like to contribute to this project, please fork the repository, make your changes, and submit a pull request.

License

This project is licensed under the MIT License - see the LICENSE file for details.