{"_id":"@alpha_anas/atm-system","name":"@alpha_anas/atm-system","dist-tags":{"latest":"1.0.0"},"versions":{"1.0.0":{"name":"@alpha_anas/atm-system","version":"1.0.0","description":"This ATM System application simulates basic ATM functionalities such as checking account balance, depositing money, withdrawing money, and exiting the system.","main":"index.js","type":"module","publishConfig":{"access":"public"},"bin":{"atm-system":"index.js"},"scripts":{"test":"echo \"Error: no test specified\" && exit 1"},"keywords":[],"author":"","license":"ISC","dependencies":{"inquirer":"^9.2.23"},"devDependencies":{"@types/inquirer":"^9.0.7"},"_id":"@alpha_anas/atm-system@1.0.0","gitHead":"d125832a927b82653b9e38e9ca8a67cfde131473","_nodeVersion":"20.11.1","_npmVersion":"10.2.4","dist":{"integrity":"sha512-ekjR5Rzs96Dtfn+nFYUqhmyVZU80ZubdL6tEWSRrkXakdAKwD4gBlyFbOFYukxYrk3mKSU8eptmS9wEuXdofng==","shasum":"f1b5bdd440c974b2aa8c477d4bdf90b5b4a274a5","tarball":"https://registry.npmjs.org/@alpha_anas/atm-system/-/atm-system-1.0.0.tgz","fileCount":5,"unpackedSize":26567,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIGbYd7c6XDL6bB6rhVKWeUsffClSYu81lUzfnJbZL2jeAiEA9+90Iv2a5F+Mu5k6LVKQMz7+iROdmrIQJOahiPCKtW0="}]},"_npmUser":{"name":"alpha_anas","email":"muhd.anas70pe@gmail.com"},"directories":{},"maintainers":[{"name":"alpha_anas","email":"muhd.anas70pe@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/atm-system_1.0.0_1717914928304_0.623076100736651"},"_hasShrinkwrap":false}},"time":{"created":"2024-06-09T06:35:28.199Z","1.0.0":"2024-06-09T06:35:28.519Z","modified":"2024-06-09T06:35:28.809Z"},"maintainers":[{"name":"alpha_anas","email":"muhd.anas70pe@gmail.com"}],"description":"This ATM System application simulates basic ATM functionalities such as checking account balance, depositing money, withdrawing money, and exiting the system.","keywords":[],"license":"ISC","readme":"# ATM System\r\n\r\n## Application Walkthrough\r\n\r\nThis ATM System application simulates basic ATM functionalities such as checking account balance, depositing money, withdrawing money, and exiting the system.\r\n\r\n### Features\r\n\r\n1. **Check Balance**: View the current balance in your account.\r\n2. **Deposit Money**: Add a specified amount of money to your account.\r\n3. **Withdraw Money**: Withdraw a specified amount of money from your account.\r\n4. **Exit**: Exit the ATM system.\r\n\r\n## Run the Application on CLI:\r\n\r\n```\r\nnpm i **\\_\\_\\_**\r\nnpx ****\\_****\r\n```\r\n\r\nwhen all the dependencies are successfully installed you can build and run the project using the\r\nbelow mentioned command :\r\n`tsc && node index.js`\r\n\r\n### Prerequisites\r\n\r\nBefore running the application, ensure you have the following installed:\r\n\r\n- [Node.js](https://nodejs.org/)\r\n- [npm](https://www.npmjs.com/)\r\n\r\n### Installation\r\n\r\n1. **Clone the repository**:\r\n\r\n   ```\r\n   git clone https://github.com/yourusername/atm-system.git\r\n   cd atm-system\r\n   ```\r\n\r\n2. **Install the dependencies**:\r\n   ```\r\n   npm install\r\n   ```\r\n\r\n### Usage\r\n\r\n1. **Start the application**:\r\n\r\n   ```\r\n   npm start\r\n   ```\r\n\r\n2. **Follow the on-screen prompts** to interact with the ATM system.\r\n\r\n### User Guide\r\n\r\n1. **Starting the ATM System**:\r\n   - Upon running the application, you will be presented with a menu of options.\r\n2. **Options Menu**:\r\n   - `1. Check Balance`: Displays the current balance in your account.\r\n   - `2. Deposit Money`: Prompts you to enter an amount to deposit. After entering the amount, your balance will be updated accordingly.\r\n   - `3. Withdraw Money`: Prompts you to enter an amount to withdraw. If the amount is available in your balance, it will be deducted. Otherwise, an error message will be displayed.\r\n   - `4. Exit`: Exits the ATM system.\r\n\r\n### Example Interaction\r\n\r\n1. **Menu Display**:\r\n\r\n   ```\r\n   Welcome to the ATM System\r\n   1. Check Balance\r\n   2. Deposit Money\r\n   3. Withdraw Money\r\n   4. Exit\r\n   ```\r\n\r\n2. **Checking Balance**:\r\n\r\n   ```\r\n   Your current balance is $1000\r\n   ```\r\n\r\n3. **Depositing Money**:\r\n\r\n   ```\r\n   Enter the amount to deposit: 200\r\n   You have successfully deposited $200. Your new balance is $1200.\r\n   ```\r\n\r\n4. **Withdrawing Money**:\r\n\r\n   ```\r\n   Enter the amount to withdraw: 500\r\n   You have successfully withdrawn $500. Your new balance is $700.\r\n   ```\r\n\r\n5. **Exiting the System**:\r\n   ```\r\n   Thank you for using the ATM System. Goodbye!\r\n   ```\r\n\r\n## Development\r\n\r\n### Run/ Edit the Application on IDE:\r\n\r\n        Clone or download the zip of the folder from : `LINK TO BE INSERTED HERE`\r\n        `Then run the following commands to install the DEPENDENCIES : `\r\n\r\n        ```\r\n                tsc --init\r\n                npm init -y\r\n                npm install inquirer\r\n                npm i --save-dev @types/inquirer\r\n\r\n        ```\r\n\r\n## To contribute to the development of the ATM System:\r\n\r\n1. **Fork the repository** on GitHub.\r\n2. **Clone your fork** locally:\r\n   ```\r\n   git clone https://github.com/yourusername/atm-system.git\r\n   cd atm-system\r\n   ```\r\n3. **Create a new branch** for your feature or bugfix:\r\n   ```\r\n   git checkout -b feature-or-bugfix-name\r\n   ```\r\n4. **Make your changes** and commit them:\r\n   ```\r\n   git add .\r\n   git commit -m \"Description of changes\"\r\n   ```\r\n5. **Push your changes** to your fork:\r\n   ```\r\n   git push origin feature-or-bugfix-name\r\n   ```\r\n6. **Create a pull request** on GitHub.\r\n","readmeFilename":"README.md"}