initial commit
This commit is contained in:
72
README.md
Normal file
72
README.md
Normal file
@@ -0,0 +1,72 @@
|
||||
# [ERP Platform] - AI-Native Financial Operations
|
||||
|
||||
An AI-native enterprise resource planning platform that consolidates ERP, treasury management, AP payments, FP&A, forecasting, financial reporting, multi-entity consolidation, and business intelligence into a single system.
|
||||
|
||||
## Quick Start
|
||||
|
||||
```bash
|
||||
# 1. Install dependencies
|
||||
npm install
|
||||
|
||||
# 2. Copy environment variables
|
||||
cp .env.example .env
|
||||
|
||||
# 3. Set up your database (requires PostgreSQL)
|
||||
# Update DATABASE_URL in .env, then:
|
||||
npx prisma db push
|
||||
npx prisma generate
|
||||
|
||||
# 4. Run the dev server
|
||||
npm run dev
|
||||
```
|
||||
|
||||
Open [http://localhost:3000](http://localhost:3000) to see the platform.
|
||||
|
||||
## Tech Stack
|
||||
|
||||
- **Frontend:** Next.js 14 (App Router) + React + TypeScript
|
||||
- **Styling:** Tailwind CSS + Radix UI primitives
|
||||
- **Database:** PostgreSQL + Prisma ORM
|
||||
- **AI:** Anthropic Claude API (embedded assistant)
|
||||
- **Charts:** Recharts
|
||||
|
||||
## Project Structure
|
||||
|
||||
```
|
||||
src/
|
||||
app/ # Next.js App Router pages
|
||||
(dashboard)/ # Authenticated layout group
|
||||
dashboard/ # Main dashboard
|
||||
general-ledger/ # GL module (chart of accounts, journal entries)
|
||||
new-entry/ # Create journal entry form
|
||||
ap-ar/ # Accounts Payable/Receivable (upcoming)
|
||||
treasury/ # Treasury management (upcoming)
|
||||
fpa/ # FP&A module (upcoming)
|
||||
forecasting/ # Forecasting module (upcoming)
|
||||
tax/ # Tax compliance (upcoming)
|
||||
reporting/ # Financial reporting (upcoming)
|
||||
settings/ # Platform settings (upcoming)
|
||||
components/
|
||||
layout/ # Sidebar, Header, AI Assistant
|
||||
modules/ # Module-specific components
|
||||
ui/ # Reusable UI components (Button, Card, Badge, DataTable)
|
||||
lib/
|
||||
auth/ # RBAC logic and permissions
|
||||
db/ # Prisma client
|
||||
utils/ # Utility functions
|
||||
types/ # TypeScript type definitions
|
||||
prisma/
|
||||
schema.prisma # Database schema
|
||||
```
|
||||
|
||||
## What's Built
|
||||
|
||||
- Platform shell with sidebar navigation, header, and responsive layout
|
||||
- Role-based "View As" switcher (CEO, CFO, Controller, Manager, Analyst, Clerk)
|
||||
- Multi-entity selector
|
||||
- AI Assistant slide-out panel
|
||||
- General Ledger module with Chart of Accounts, Journal Entries, and Trial Balance
|
||||
- New journal entry form with real-time debit/credit validation
|
||||
- Core database schema covering all modules
|
||||
- RBAC permission system
|
||||
- Reusable UI component library
|
||||
Reference in New Issue
Block a user