Hornest-Wallet

A simple wallet system built with NestJS, postgres and TypeORM

Functionalities

• Abilities for users to be able to save and withdraw money to using the Flutterwave payment gateway.
• User Card credentials such as credit-card numbers and CVV are stored as encrypted ciphertexts in order for the system to be PCI DSS compliant
• users can also check the current exchange rates for popular cryptocurrencies(BTC, ETH, DOGE, SHIB, SOL e.t.c) via our very own api : bitfast

To get started with this project, clone the repo by running the command git clone https://github.com/E-wave112/Hornest-Wallet.git or downloading the zip file

In the root of the project run the following command

 yarn

or

 npm install

Start the development server (remember to put in the right environment variables) via the command

 yarn start:dev

or

 npm run start:dev

The API is also documented via postman and the live url can be found here

You can try out the transactions functionality for free using the cards credentials(Card Number, CVVs, expiry) in the documentation

Containerizing the API

Build the initial docker image

docker-compose up --build

Running the Dev Docker container

To run the container, use the following command:

 docker-compose up

• The server will be running on localhost:5000

• Find the Docker image on the cloud here

• A useful resource on how to push your docker image to DockerHub can be found here

CONTRIBUTING TO HORNEST WALLET

While the hornest-wallet project is completely free to use and open source, here are a few things to note when making Pull Requests

• Ensure the PR is made to the dev branch so it can be reviewed before it gets merged to the main branch (we are currently looking to implement a CI/CD pipeline as soon as possible) so as to automate things and reduce room for human error
• The code architecture and design pattern for the PR should be consistent with the existing codebase

Your Contributions are highly appreciated!