Skip to content

Commit

Permalink
Readme updated
Browse files Browse the repository at this point in the history
  • Loading branch information
Bloivating-Major committed May 28, 2024
1 parent 89c1c57 commit d60969d
Show file tree
Hide file tree
Showing 2 changed files with 83 additions and 2 deletions.
55 changes: 53 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,26 @@

<br />

![Preview](https://bloivating-major.github.io/Age-Calculator-CA-/)

### Overview

The Age Calculator App is a React application built with Vite that allows users to calculate their age in years, months, and days. It also features error handling for missing or invalid inputs and includes a night mode and day mode for enhanced user experience.

### Table of Contents

- [Overview](#overview)
- [Features](#features)
- [Screenshots](#screenshots)
- [Installation](#installation)
- [Usage](#usage)
- [Technologies Used](#technologies)
- [Learning Experience](#learningexperience)
- [Contributing](#contributing)
- [License](#license)
- [Credits](#credits)
- [Contact](#contact)

### Features

- Calculate age in years, months, and days
Expand Down Expand Up @@ -46,10 +62,45 @@ npm run dev

This will open the application in your default web browser at http://localhost:3000.

### 05. Usage:
### Usage
Input your birthdate in the provided field, click on the "Calculate Age" button to see your age in years, months, and days. Toggle between night mode and day mode for different color themes.


### Technologies
React
Vite
Tailwind CSS
JavaScript
CSS


### Learning
1. Understanding useState: Explored the useState hook in React to manage component state efficiently.
2. Complex Logic Development: Implemented complex logic for age calculation and error handling, testing and debugging various scenarios.
3. Flowchart-based Logic: Created logic using flowcharts to visualize the program's flow and optimize decision-making processes.
4. Debugging Techniques: Learned effective debugging techniques to identify and fix errors in the program.




### Contributing
Contributions are welcome! Please follow the guidelines outlined in [Contributing.md](./contributing.md)


### License
This project is licensed under the [MIT License](./LICENSE)

### Credits
Developer: Sambhav Wakhariya
Inspiration: This project is my first task as an intern at [CodeAlpha Company](https://www.codealpha.tech/)

### Contact
For any inquiries or feedback, feel free to reach out:

Email: [[email protected]](mailto:[email protected])
GitHub: [bloivatingmajor](https://github.com/Bloivating-Major)

```
Make sure to update any other project-specific details as needed. This guide provides clear instructions for new users to clone the repository, install dependencies, start the Vite development server, and access and use the app locally.
```
```
30 changes: 30 additions & 0 deletions contributing.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# Contributing to Age Calculator

Welcome to Age Calculator! I am thrilled that you're interested in contributing to our project. This document outlines how you can get involved and contribute to the project's development.

## Reporting Bugs

If you encounter a bug while using Age Calculator, please help me by [opening an issue](link_to_issues) on GitHub. When reporting bugs, please include as much information as possible, such as steps to reproduce the issue, expected behavior, and screenshots if applicable.

## Requesting Features

Have an idea for a new feature or improvement? [Open an issue](link_to_issues) on GitHub and let me know! I welcome feature requests and appreciate any feedback on how i can enhance Age Calculator to better meet your needs.

## Contributing Code

I welcome contributions from the community! If you'd like to contribute code to Age Calculator, please follow these steps:

1. Fork the repository on GitHub.
2. Clone your forked repository to your local machine.
3. Create a new branch for your changes: `git checkout -b feature-name`.
4. Make your changes and commit them to your branch.
5. Push your changes to your forked repository: `git push origin feature-name`.
6. [Open a pull request](link_to_pull_requests) on GitHub with a detailed description of your changes.

Before submitting a pull request, please ensure that your code follows my coding style guidelines and that all tests pass. I'll review your pull request as soon as possible and provide feedback if needed.

## License

By contributing to Age Calculator, you agree that your contributions will be licensed under the [MIT License](./LICENSE). All contributions are subject to the terms outlined in the license agreement.

Thank you for contributing to Age Calculator! Your support and contributions are greatly appreciated.

0 comments on commit d60969d

Please sign in to comment.