Skip to content

Olayiwola72/fastcash-frontend

Repository files navigation

Fast Cash Portfolio Project

Fast Cash is a cutting-edge digital banking solution designed to simplify and enhance financial management by providing users with seamless and automatic wallet creation for both local and international payments. This project demonstrates my expertise as a Senior Software Engineer πŸ’», integrating robust backend and frontend technologies to deliver a comprehensive and responsive web application.

πŸ”­ Table of Contents

🌱 Project Overview

Fast Cash is a next-generation online bank that automates wallet creation and facilitates effortless transactions. Whether handling local or international payments, Fast Cash aims to provide users with a streamlined, secure, and user-friendly experience.

Demo

Check out the live of Fast Cash here:

https://fast-cash.onrender.com/

fast cash home

πŸ’Ό Tech Stack

Front-End:

Back-End:

Database:

πŸ”§ Getting Started

To set up the project locally:

  1. Clone the Repository:

    git clone https://github.com/Olayiwola72/fastcash-backend
  2. Submodule Initialization:

    The frontend code is included as a submodule within the backend repository. Navigate to src/main/resources/client to interact with the front end.

    git submodule update --init --recursive
  3. Install Dependencies and Start the Application:

    The project leverages Vite & Maven to bundle both React and Spring Boot together. Use the provided script to install all dependencies and run the application.

    ./prod.sh

    The application will be accessible at: http://localhost:8086/

Usage Instructions

Once the application is running, open your browser and navigate to https://fast-cash.onrender.com/. Create a user account and start exploring the features of Fast Cash.

πŸ“ API Documentation

For detailed API information and testing, access the Swagger UI:

https://fast-cash.onrender.com/swagger-ui

Features

Fast Cash is packed with a variety of features aimed at providing a comprehensive digital banking experience:

  • JWT User Authentication
  • Sign in with Google (OAUTH)
  • Transaction History
  • Wallets
  • Make Transfers
  • Recent Transactions
  • Change Password
  • Reset Password
  • Update Profile
  • Email Notifications
  • Delete Account
  • Transaction List PDF and Export Actions
  • Responsive Web Design

Testing

To run the tests locally:

  • Backend Tests

    ./mvnw test

Docker Support

Fast Cash can be deployed using Docker and Docker Compose, which simplifies the process of setting up and running the application in a containerized environment. Follow these instructions to get the application running using Docker.


πŸ›  Prerequisites

  • Docker: Install Docker
  • Docker Compose: Install Docker Compose

πŸš€ Quick Start

  1. Clone the Repository:

    If you haven't already cloned the repository, do so with:

    git clone https://github.com/Olayiwola72/fastcash-backend
    
  2. Build and Start the Application::

    Use Docker Compose to build and start the application. This will build the Docker images and start the containers defined in docker-compose.yml in the root directory.

    docker-compose up --build

    Note: --build forces Docker Compose to rebuild the images. You can omit this flag if you don't need to rebuild.

  3. πŸ“œ Notes:

    Adjust environment variables and ports as needed for your local development or production setup. The application will be accessible at: http://localhost:8086/

Contributing

Contributions to this project are welcome. Please follow the standard GitHub fork, branch, and pull request workflow. Feel free to raise issues or feature requests to enhance this project.

πŸ“ˆ GitHub Stats

Top Langs

🀝 Connect With Me

Olayiwola Akinnagbe | LinkedIn Olayiwola Akinnagbe | Twitter Olayiwola Akinnagbe | Resume

  • πŸ’¬ If you have any questions or feedback, feel free to reach out! I'm also actively seeking exciting job opportunities that align with my skills and experience, so don't hesitate to contact me if you know of any suitable roles

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published