Files
Aseret_Bank/README.md
2026-02-09 21:51:31 -08:00

93 lines
2.3 KiB
Markdown

# Aseret Bank - Full System Platform
A comprehensive full-stack banking platform for Aseret (CFL-licensed lender) including frontend website, core banking system, CRM, ERP, transaction processing, loan origination orchestration, and CFL-compliant tokenized services.
## Technology Stack
- **Frontend**: Next.js 14+ (React) with TypeScript
- **Backend**: Node.js with Express and TypeScript
- **Database**: PostgreSQL with Prisma ORM
- **Blockchain**: Tokenization layer (Ethereum, Polygon, or private chain)
- **Authentication**: JWT with RBAC
- **API**: RESTful APIs with OpenAPI documentation
## Project Structure
```
Aseret_Bank/
├── frontend/ # Next.js application
├── backend/ # Express API server
├── shared/ # Shared TypeScript types
├── contracts/ # Smart contracts (Solidity)
└── docs/ # Documentation
```
## Getting Started
### Prerequisites
- Node.js 18+ and npm/yarn
- PostgreSQL 14+
- Docker and Docker Compose (for local development)
- Redis (for caching and sessions)
### Prerequisites
- Node.js 18+
- pnpm 8+ (`npm install -g pnpm`)
- Docker and Docker Compose (for local development)
- PostgreSQL 14+ (or use Docker)
- Redis (or use Docker)
### Installation
1. Clone the repository
2. Copy `.env.example` to `.env` and configure
3. Install dependencies:
```bash
pnpm install
```
4. Start Docker services (PostgreSQL and Redis):
```bash
pnpm docker:up
```
5. Generate Prisma client:
```bash
pnpm db:generate
```
6. Run database migrations:
```bash
pnpm db:migrate
```
7. (Optional) Seed the database:
```bash
pnpm db:seed
```
8. Start development servers:
```bash
# Both backend and frontend
pnpm dev
# Or separately:
pnpm dev:backend # Backend only (port 3001)
pnpm dev:frontend # Frontend only (port 3000)
```
### Available Scripts
- `pnpm dev` - Start both backend and frontend in development mode
- `pnpm build` - Build both backend and frontend for production
- `pnpm db:migrate` - Run database migrations
- `pnpm db:generate` - Generate Prisma client
- `pnpm db:studio` - Open Prisma Studio
- `pnpm docker:up` - Start Docker services
- `pnpm docker:down` - Stop Docker services
## Development Phases
See the plan document for detailed phase breakdown.
## License
Proprietary - Aseret Bank