https://github.com/dxphilo/kenyan-banks
An API that provides Kenyan bank logos, slug and code.
https://github.com/dxphilo/kenyan-banks
Last synced: 4 months ago
JSON representation
An API that provides Kenyan bank logos, slug and code.
- Host: GitHub
- URL: https://github.com/dxphilo/kenyan-banks
- Owner: dxphilo
- License: mit
- Created: 2023-01-27T14:17:18.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2023-01-27T14:18:59.000Z (over 3 years ago)
- Last Synced: 2025-07-25T05:58:33.977Z (11 months ago)
- Language: TypeScript
- Homepage: https://kenyan-banks.onrender.com
- Size: 47.9 KB
- Stars: 1
- Watchers: 1
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Kenyan Banks
## Usage
- Get all banks info with their slugs
Make a `GET` request to `https://kenyan-banks.onrender.com`
- Get single bank info
Make a `GET` request with the `bank_code` as query param to `https://kenyan-banks.onrender.com/bank`
## Prerequisites
- [Nodejs](https://nodejs.org) installed on your machine
## Installation
- Clone the repository
```bash
git clone https://github.com/dxphilo/kenyan-banks.git
```
## How to start
1. Create a copy of `example.env` named `.env`
2. `yarn install`
3. `yarn run dev`
4. `Start adding stuff`
## Commands
- `yarn start` - Starts the app. Needs to be builded first
- `yarn run build` - Builds the app (typescript compilation)
- `yarn run dev` - Starts nodemon (Auto-restart on changes with auto-rebuild)
## Contributors
- [Your name here] - [Your Twitter handle]() [Your GitHub handle]()
## Authors
- John Philip - [Twitter](https://twitter.com/amjohnphilip) [Github](https://github.com/dxphilo)
## License
This project has been inspired by Ichtrojan's [Nigerian banks](https://github.com/ichtrojan/nigerian-banks)
Thanks to [Christos](https://github.com/chrispanag/node-typescript-boilerplate) for maintaing the template used for this project.
[MIT](LICENSE)