From d60969db6f589137f84a1bc0bc9879a5bdc4f260 Mon Sep 17 00:00:00 2001 From: Sambhav <102620496+Bloivating-Major@users.noreply.github.com> Date: Tue, 28 May 2024 17:36:38 +0530 Subject: [PATCH] Readme updated --- README.md | 55 +++++++++++++++++++++++++++++++++++++++++++++++-- contributing.md | 30 +++++++++++++++++++++++++++ 2 files changed, 83 insertions(+), 2 deletions(-) create mode 100644 contributing.md diff --git a/README.md b/README.md index 104a919..e730df0 100644 --- a/README.md +++ b/README.md @@ -4,10 +4,26 @@
+![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 @@ -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: [sambhav12wakhariya@gmail.com](mailto:sambhav12wakhariya@gmail.com) +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. -``` +``` \ No newline at end of file diff --git a/contributing.md b/contributing.md new file mode 100644 index 0000000..7a1653c --- /dev/null +++ b/contributing.md @@ -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.