sarthak-mittal / ifsc Goto Github PK

An application to query bank details based on IFSC code. Client implementation for RazorPay IFSC https://github.com/razorpay/ifsc API

Home Page: https://sarthak-mittal.github.io/ifsc/

License: MIT License

JavaScript 4.85% TypeScript 53.23% CSS 10.31% HTML 30.74% Dockerfile 0.87%

ifsc-api angular ifsc ifsc-codes bank-api typescript hacktoberfest hactoberfest2020 hacktoberfest-accepted razorpay

ifsc's Introduction

IFSC: Indian Financial System Code

Go to check it out here here

Introduction
Description
Technologies Using
Getting Started - Local Development
Contributers Guide

Introduction

This project aims to help you get your bank details with your IFSC code. I tend to forget where my bank branch is located or does it offer services like UPI, NEFT, RTGS or IMPS.

So I think this will help serve the purpose for people who might want to look up some information about their bank branch.

Description

On the frontend we are using Angular and on the backend we are hitting a free API provided by Razorpay. To know about API @ Razorpay IFSC Toolkit

Technologies Using

Angular 9.1.0.
Bootstrap 4.5.2.

Getting Started

To get started locally, follow these instructions:

If you haven't done it already, make a fork of this repo.
Clone to your local computer using git.
Make sure that you have Node 12.13.0 or later installed. See instructions here.

Angular Application Configuration

Use npm install to download the needed depenedencies for this project.
Don't forget to install the Angular CLI if you haven't already.
Build and run your app by using the ng serve command from the root directory.
Navigate your browser to http://localhost:4200.
Make sure you have running internet connection to successfully hit API mentioned in Description.

Run with Docker

Are you a Docker fan who wants to just run the application and doesn't care about installing other dependencies or Do you just want to know as to how to run with Docker

Follow the steps:

Download and install docker.
If you are on Linux you need to run some post-install steps so that you won't need to run docker with sudo.
On the root of this project simply run docker build . -t "<image_name>:<image_tag>".
After the image is built just run docker run --net=host <image_name>:<image_tag>.
Navigate your browser to http://localhost:4200.
Make sure you have running internet connection to successfully hit API mentioned in Description.

Contributers Guide

Read Contributors guidelines before submitting a PR or creating a new issue.

To contribute hassle free, follow these steps:

Fork this repository.
Create a branch: git checkout -b <branch_name>.
Make your changes and commit them: git commit -m '<commit_message>'
Push to the original branch: git push origin <project_name>/<location>
Create the pull request.
Show your support by ⭐ the project.

Alternatively see the GitHub documentation on creating a pull request.

_{If you find a bug or think something could be better, please file an issue! If you think a code change should be made, feel free to raise a PR.}

ifsc's People

Contributors

Watchers

Forkers

shubhi23994 smatthies ansidev vp4140 carlosmbpereira bishtsaurabh5 rohanshenoy96

ifsc's Issues

[feat] message on wrong IFSC input

Display a message if no data found related to the entered IFSC code.

Add content to 'About' page

The about page of this app is empty. Need to put up content in there, you can refer to the Introduction and Description section of Readme of this repository. You can also refer wiki or any reliable resource to add a line or two.

Briefly cover the following, not necessarily with the following heading

What this project is about?
What is IFSC?
Describe the Razorpay API used to fetch data, link their website and GitHub repo for reference.

Make sure everything stays responsive

Add content on this empty page

Add Support for Headless chrome

Idea:
Add support for Headless chrome

Why?
Headless chrome is really beneficial when we run tests in ci so that we can run the tests without needing a gui.

Configure Github Actions script for Continuous Deployment

Configure Github actions script for continuous deployment of the master branch. You can refer Github Actions

Open for any other tool you know of for automated deployment on Github pages.

Style 'Search' and 'Clear' buttons

A clear distinction for both the buttons
Keep a check on how they look when disabled

Keep the buttons decent. Make sure they follow the above two parameters at least.

Add icon for 'View on Google maps' feature

It would we real convenient if there is an icon along with the link 'View on Google Maps'. A button here would be a plus point as per usability

image in footer not visible

After deployment, image is not found in footer but when running locally its there.

Add favicon

Add a new favicon icon signifying its a banking app. Something similar to 🏛️

Add footer

Add a minimalistic and responsive footer

Add topic `hacktoberfest`

I created a pull request and checked Hacktoberfest Dashboard.

Problem:

Hacktoberfest is warning: Your PR was submitted to a repository that is not participating in Hacktoberfest. Maintainers of the repository can add the "hacktoberfest" topic to their repository if they wish to participate.

Expected:

No warning anymore.

Containerize the project

Idea:
I am thinking of containerizing this project.

Description:
Containerizing this project will help to run it without the need for any additional dependencies like angular, node etc.

Solution:

Dockerize the project
A custom build script to build and dockerize the latest project

Add spinner on 'Search' button

Add spinner while data from API is in transit state. Preferably using spinner-border bootstrap class.

Add icon (✅,❌) instead of boolean values

API returns boolean values for UPI, NEFT, RTGS, and IMPS fields. Currently, those booleans are displayed. Need to show icons in place of true and false text.

Green colored check/tick icon (✅) when the returned value is true
Else show a red-colored cross icon (❌).

You can refer Font Awesome for icons.

Improve bootstrap layout for mobile view

When API results are populated on the page. Currently, everything is stacked up in the mobile view. Need to improve the layout so everything looks clean and not stacked in the mobile view.