Lendsqr FE Test

This is frontend application which employs React, Typescript, SCSS using Vite. It serves as an admin dashboard for a fintech company.

API Documentation

It utilizes an API that facilitates getting
dummy customer data, which is used to populate the dashboard. The API just has two routes.

Get All Users This returns all the users/customers using the app per say. The data comes in as an array of 100 user objects

AND

Get A User This returns data for a single user taking and id as a parameter.

Environment Variables

To run this project, you will need to add a an .env file if not already present and add the following environment variable:

VITE_APP_BASE_URL this is the base URL which the app uses to make api calls.

Run Locally

To run this project you must have docker desktop installed and running on your local machine. You will also need to create an account with flutterwave or paystack, depending on what you want to work with, in other to get your api keys.

Clone the project

  git clone https://github.com/DarthVve/lendsqr-fe-test.git

Go to the project directory

  cd lendsqr-fe-test

Install dependencies

  yarn install

Start the server

  yarn dev

Running Tests

Testing was carried out using Cypress/Jest To run tests, run the following command

  yarn test

Deployment

This project was deployed on Vercel. Here is the link to the base url.

https://majoroh-oshevire-lendsqr-fe-test.vercel.app/

Usage

To run a production build run the command

    yarn build

When the server starts simply click on login to access the dashboard as this is a mock application. Have fun playing around the dashboard.

Authors

• Vve