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 099dab4 commit 48c0b36
Show file tree
Hide file tree
Showing 5 changed files with 52 additions and 5 deletions.
57 changes: 52 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,55 @@
# React + Vite
<div align="center">
<h2>⚜️ AGE &nbsp; CALCULATOR ⚜️</h2>
</div>

This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules.
<br />

Currently, two official plugins are available:
### Overview

- [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react/README.md) uses [Babel](https://babeljs.io/) for Fast Refresh
- [@vitejs/plugin-react-swc](https://github.com/vitejs/vite-plugin-react-swc) uses [SWC](https://swc.rs/) for Fast Refresh
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.

### Features

- Calculate age in years, months, and days
- Error handling for missing or invalid inputs
- Night mode and day mode for UI customization

### Screenshots

![Screenshot](/Age%20Calculator/src/assets/Light%20Mode%20Ui.png)
![Screenshot](/Age%20Calculator/src/assets/Night%20Mode%20Ui.png)
![Screenshot](/Age%20Calculator/src/assets/Light%20Mode%20Error.png)
![Screenshot](/Age%20Calculator/src/assets/Night%20Mode%20Error.png)

### Installation

### 01. Clone the repository:
```git
git clone https://github.com/Bloivating-Major/Age-Calculator-CA-.git
```


### 02. Navigate to the Project Directory: Change your current directory to the project directory:
```bash
cd '.\Age-Calculator-CA--main\'
```

### 03. Install Dependencies: Install the required dependencies for the project using npm or yarn:
```npm
npm install
```

### 04. Start the Developement Server:
```npm
npm run dev
```

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

### 05. 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.

```
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.
```
Binary file added src/assets/Light Mode Error.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/assets/Light Mode Ui.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/assets/Night Mode Error.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/assets/Night Mode Ui.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 48c0b36

Please sign in to comment.