Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add README for bmi-calculator React project #5183

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
57 changes: 57 additions & 0 deletions React-JS Projects/bmi-calculator/README.md
Original file line number Diff line number Diff line change
@@ -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.