Skip to content

Commit 15984fe

Browse files
authored
Merge pull request #1 from nitinyadav2188/main
Add README for BMI Calculator project
2 parents ed009ca + 258f29e commit 15984fe

File tree

1 file changed

+131
-0
lines changed

1 file changed

+131
-0
lines changed

README.md

Lines changed: 131 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,131 @@
1+
# BMI Calculator
2+
3+
[![Status](https://img.shields.io/badge/status-active-brightgreen.svg)](https://github.com/niraj0624/bmi-calculator)
4+
[![License](https://img.shields.io/github/license/niraj0624/bmi-calculator.svg)](LICENSE)
5+
[![GitHub issues](https://img.shields.io/github/issues/niraj0624/bmi-calculator.svg)](https://github.com/niraj0624/bmi-calculator/issues)
6+
[![GitHub forks](https://img.shields.io/github/forks/niraj0624/bmi-calculator.svg)](https://github.com/niraj0624/bmi-calculator/network)
7+
[![GitHub stars](https://img.shields.io/github/stars/niraj0624/bmi-calculator.svg)](https://github.com/niraj0624/bmi-calculator/stargazers)
8+
9+
## Description
10+
11+
**BMI Calculator** is a simple, lightweight web application built using vanilla JavaScript, HTML, and CSS. It allows users to quickly calculate their Body Mass Index (BMI) based on their height and weight. BMI is a reliable indicator of body fatness and is widely used to screen for weight categories that may lead to health problems.
12+
13+
---
14+
15+
## Features
16+
17+
- User-friendly interface
18+
- Real-time BMI calculation
19+
- Input validation for height and weight
20+
- Categorizes BMI results (e.g., Underweight, Normal, Overweight, Obese)
21+
- Responsive design for desktops and mobile devices
22+
- No external dependencies
23+
24+
---
25+
26+
## Demo
27+
28+
You can view a live demo [here](https://niraj0624.github.io/bmi-calculator/)
29+
30+
---
31+
32+
## Getting Started
33+
34+
### Prerequisites
35+
36+
- A modern web browser (Chrome, Firefox, Edge, etc.)
37+
38+
### Installation
39+
40+
1. **Clone the repository:**
41+
```bash
42+
git clone https://github.com/niraj0624/bmi-calculator.git
43+
```
44+
2. **Navigate to the project directory:**
45+
```bash
46+
cd bmi-calculator
47+
```
48+
3. **Open `index.html` in your browser:**
49+
- Double click `index.html`
50+
- or run:
51+
```bash
52+
open index.html # Mac
53+
start index.html # Windows
54+
```
55+
56+
---
57+
58+
## Usage
59+
60+
1. Enter your height (in cm or meters, as specified).
61+
2. Enter your weight (in kg).
62+
3. Click on the "Calculate" button.
63+
4. View your BMI and the associated category.
64+
65+
---
66+
67+
## Repository Status
68+
69+
- **Project Status:** Active & maintained
70+
- **Latest Release:** See [Releases](https://github.com/niraj0624/bmi-calculator/releases)
71+
- **Issues:** Please use the [issue tracker](https://github.com/niraj0624/bmi-calculator/issues) to report bugs or suggest features.
72+
73+
---
74+
75+
## Technologies Used
76+
77+
- **JavaScript** (39.3%)
78+
- **HTML** (32.4%)
79+
- **CSS** (28.3%)
80+
81+
---
82+
83+
## Contributing
84+
85+
We welcome contributions! Please follow these steps to contribute:
86+
87+
1. **Fork** this repository.
88+
2. **Clone** your forked repo:
89+
```bash
90+
git clone https://github.com/niraj0624/bmi-calculator.git
91+
```
92+
3. **Create a new branch** for your feature or bugfix:
93+
```bash
94+
git checkout -b feature/your-feature-name
95+
```
96+
4. **Make your changes** and **commit** them:
97+
```bash
98+
git add .
99+
git commit -m "Describe your changes"
100+
```
101+
5. **Push** to your forked repository:
102+
```bash
103+
git push origin feature/your-feature-name
104+
```
105+
6. **Open a Pull Request** against the `main` branch of this repository.
106+
107+
For major changes, please open an issue first to discuss what you would like to change.
108+
109+
**Contribution Guidelines:**
110+
- Write clear, concise commit messages
111+
- Follow the existing code style
112+
- Check for lint errors before submitting
113+
- Add comments and documentation where necessary
114+
115+
---
116+
117+
## License
118+
119+
This project is licensed under the [MIT License](LICENSE).
120+
121+
---
122+
123+
## Contact
124+
125+
For any questions or feedback, please open an issue or contact the maintainer [@niraj0624](https://github.com/niraj0624).
126+
127+
---
128+
129+
For any questions or feedback, please open an issue or contact the maintainer [@niraj0624](https://github.com/niraj0624).
130+
131+
---

0 commit comments

Comments
 (0)