From 4b215d9be92f2641719a97fa6e700827b547f71e Mon Sep 17 00:00:00 2001 From: Abdelrahman Adel Hashiem <149705123+Abdelrahman-Adel610@users.noreply.github.com> Date: Sun, 1 Sep 2024 01:09:02 +0300 Subject: [PATCH] Create README.md --- README.md | 69 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 69 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..7f36bc3 --- /dev/null +++ b/README.md @@ -0,0 +1,69 @@ +#đŸĻ Bankist App +An interactive js bank application with a nice UI +![image](https://github.com/user-attachments/assets/7d4ff2cb-bd33-4f08-a6d1-69e6bfe01bc9) +![image](https://github.com/user-attachments/assets/ff4e03fa-0712-4bc4-9c19-dbd98da53f31) +![image](https://github.com/user-attachments/assets/fda0c3ec-4985-4fda-9860-ddb5744eb553) + + + +## Features ⚙ī¸ + +- **Internationalization API**: All the dates and numbers at the page were formatted using it. +- **Setting timer**:Every 10 mins from being inactive you are automatically logged out. +- **Reseting timer**:For each successful bank treatment the timer is rest to 10 mins again. +- **Verifications**:For each action (login,transfer,loans,close account), the entered data are been verified in 2 seconds (a hardcoded timer simulating a real bank operation), if they are correct or suitable (depending on the action), the action is done else you'll get an alert for wrong or incomplete operation. +- **Updating the interface**:By any action or operation, the UI is automatically updated with the up-to-date data. +- **Account summary**:In the footer we display summary for the whole movements (income/outcome/interest) + +## Note 🔴 +According to the client data loaded form an API you shall login using you first letter of each name in your full name (Abdelrahman Adel===>aa) && using your pin instead of real API we hard coded the 2 following users: +- USER:js PIN:1111 +- USER:jd PIN:2222 +For each user the following data is provided: +1. Full name. +2. Pin. +3. Locale. +4. His bank movements with their date. +5. currency. +6. interest rate. + +![image](https://github.com/user-attachments/assets/2682e04c-2f9b-4a5e-acdc-21aad9cf6f4f) + +## 📈 Potential Improvements + +- **API Integration**: Connecting the app to real-world banking APIs for live data. +- **Enhanced Analytics**: Adding features for financial analytics and reporting. +- **Signing up**: Signing up for new customers + +## How to use 🕹ī¸ +1. Open the App in your web browser. +2. login +3. Now you can see all the account movements and you can do any new movement (transfer to another account / loan / close your account ) + +## Installation + +1. Clone the repository: + ```bash + git clone https://github.com/Abdelrahman-Adel610/Bankist + ``` +2. Navigate to the project directory: + ```bash + cd Bankist + ``` +3. Open `index.html` in your web browser. + +## Project Structure + +- `index.html`: The main HTML file. +- `css/style.css`: The CSS file for styling the game. +- `css/mediaQuery.css`: Making the game responsive to all screens. +- `js/script.js`: The JavaScript file containing the game logic. +- `Images/`: The used logo for the app. + +## ⚖ī¸ License + +This project is licensed under the MIT License. + +--- +Thank you for checking out **Bankist**! Feel free to give your feedback or contributing . +Your feedback or contributions are totally appreciated.