README.md

Koryntia App

Revolutionizing Financial Inclusion: Koryntia's Mission to Empower 2 Billion People with Borderless Credit Access

NETLIFY URL

Background

This project is built on Next.js 13.5 and is organized as a single application within a standalone repository. This approach allows us to focus on delivering a cohesive and optimized DeFi experience.

Prerequisites

To run this project locally, the following tools are required on your local machine:

• Node.js
• npm

1. Installation

Clone the project:

git clone https://github.com/Koryntia/KoryntiaWebApp.git

Navigate into the project directory and install its dependencies:

cd KoryntiaWebApp/

Project Setup Guides

Install Dependencies

Before setting up a project, install dependencies for the Project:

npm install

Run

First, run the development server:

npm run dev
# or
yarn dev
# or
pnpm dev

Local Routes

Open http://localhost:3000 with your browser to see the result. -http://localhost:3000 --> if you wanna test Metamask connection page -http://localhost:3000/landing --> for the langing page

CRUD Operations

Loans

To test:

• Make sure you have MongoDB Compass up and running.

• Copy the content of.env.example and save it in .env.local file.

• visit: http://localhost:3000/loans

Note:

• The loans route is only for testing purposes. Might/will be deleted later.

Deployment

N/A

Stack

List of libraries in building the Koryntia web app

• Tailwindcss
• Formik
• Yup
• React Router DOM V6
• Sweetalert2
• Socket io
• next-intl
• Redux toolkit
• Axios
• etc

Architecture

N/A

File Structure

N/A

IU Components

List of common reusable components.

Components

• Card
• Button

Application state

N/A