diff --git a/React-JS Projects/bmi-calculator/README.md b/React-JS Projects/bmi-calculator/README.md new file mode 100644 index 0000000000..2057545b73 --- /dev/null +++ b/React-JS Projects/bmi-calculator/README.md @@ -0,0 +1,57 @@ +# BMI Calculator 🍛 + +This project is a Body Mass Index (BMI) calculator built with React. The application allows users to input their weight and height, and then calculates their BMI based on the provided values. This README provides instructions on how to set up, run, and deploy the application. + +## Table of Contents + +- [Features](#features) +- [Setup and Installation](#setup-and-installation) +- [Available Scripts](#available-scripts) + +## Features + +- Accepts height in meters and weight in kilograms. +- BMI calculation based on the provided weight and height. +- User-friendly interface. + +## Setup and Installation + +1. **Clone the Repository** + +```bash +git clone https://github.com/pranjay-poddar/Dev-Geeks.git +``` + +2. **Navigate to the BMI Calculator Folder** + +```bash +cd "React-JS Projects/bmi-calculator/" +``` + +3. **Install Dependencies** + +Make sure you have [Node.js](https://nodejs.org/en) and [npm](https://www.npmjs.com/) installed. Then run: + +```bash +npm install +``` + +4. **Run the Application** + +After installation, you can use the available scripts (listed below) to run or build the application. + +## Available Scripts + +In the project directory, you can run: + +### `npm start` + +Runs the app in development mode. Open [http://localhost:3000](http://localhost:3000) to view it in the browser. The page will reload if you make edits. + +### `npm test` + +Launches the test runner in interactive watch mode. + +### `npm run build` + +Builds the app for production to the `build` folder. It correctly bundles React in production mode and optimizes the build for best performance.