Skip to content

Marremelad/SalamanderBank

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Salamander Bank

Salamander Banner

Contributors

Features

As user

  • Create Account.
  • Receive verification email.
  • Sign in with existing account.
  • View existing bank accounts.
  • Create new bank accounts.
  • Transfer funds to different accounts.
  • Receive SMS message after funds have been received.
  • Exchange currency.
  • View transaction history.

As admin

  • Create new users.

Application Demo

Salamander Demo Gif

Verification Email

Screenshot Of Verification Email

Transfer SMS

Screenshot Of Transfer SMS

Structure

In this application we have chosen to structure the code in the following way.

  • Program.cs is the entry point of the program and is only used to start the application.
  • The Ui class displays user options and is largely responsible for message output and formatting.
  • The object classes: User, Account, Transfer, Loan and Currency, stores information that can be processed by the manager classes.
  • The Manager classes: UserManager, AccountManager, TransferManager, LoanManager, CurrencyManager and Auth, processes the information of objects and sends the data to the Ui class and also handles database querying.
  • The DB class initializes the database and creates the database tables.
  • The classes, EmailService and SmsService Handles the formatting and sending of email and SMS messages respectively.

Download UML diagram

UML Diagram

Requirements

To run the app successfully make sure that you are using the following.

Runtime:

Packages:

Files:

  • In your entry point directory, create a file named Credentials.env and add the environmental variables EMAIL and EMAIL_PASSWORD for sending emails, SMS_API_USERNAME and SMS_API_PASSWORD for sending SMS messages and CURRENCY_API_KEY for fetching currency data.

UML Diagram

Notes

  • Keep in mind that some email providers require SMTP authentication for third party applications. This means that your regular password might not work when trying to send emails through this app. To fix this, access your email account and generate a third party app password and set it as the value for the EMAIL_PASSWORD variable. Alternatively contact one of the contributors to use Team Salamanders SMTP credentials.

  • This application uses the 46elks API for sending SMS messages and currencyapi.com for fetching currency data. To access these API's you will have to get a subscription or ask Team Salamander for the API keys and passwords.

Get started

If you are using Visual Studio or any other C# IDE with an integrated repo-cloning function use it with this URL - https://github.com/Marremelad/SalamanderBank.git then open the solution and run the program.

Else, do the following.

  • Open the terminal on your computer.
  • Navigate to the directory where you keep your repositories.
  • Run the following command
git clone https://github.com/Marremelad/SalamanderBank.git      
  • Navigate into the directory that holds the projects entry point and run the following command.
dotnet run

About

Bank app simulation in the console

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 3

  •  
  •  
  •  

Languages