Developer Getting Started Guide

Welcome to the Oan Finance developer documentation. This guide will help you set up your development environment and understand our technical architecture.

System Architecture Overview

Development Environment Setup

Prerequisites

required_tools:
  - Node.js: Latest LTS
  - Docker Desktop: Latest
  - Kubernetes CLI: Latest
  - Git: Latest
  - Oracle Cloud CLI: Latest
  
development_ide:
  recommended: VSCode
  extensions:
    - ESLint
    - Prettier
    - Docker
    - Kubernetes
    - GitLens

Local Setup Steps

1. Clone Repositories

   git clone git@github.com:oanfinance/sme-web.git
   git clone git@github.com:oanfinance/sme-backoffice.git
   git clone git@github.com:oanfinance/backend-services.git

2. Frontend Setup

   cd sme-web
   npm install
   cp .env.example .env
   # Configure environment variables
   npm run dev

3. Backend Setup

   cd backend-services
   npm install
   cp .env.example .env
   # Configure environment variables
   docker-compose up -d
   npm run dev

Key Technologies

Frontend Stack

frontend:
  framework: React.js
  language: TypeScript
  ui