Add Summit project documentation

[setasena]

Summary

This PR adds comprehensive documentation for the Summit project, an open-source invoicing and financial management application. The documentation provides a complete overview of the project's architecture, tech stack, features, deployment strategy, and known limitations.

Changes

• Added SUMMIT.md — New documentation file containing:
  • Project overview and status
  • Repository and tech stack details (Next.js 16, TypeScript, Drizzle ORM, PostgreSQL, etc.)
  • Key architecture patterns (monorepo structure, auth flows, database design, file storage, payment integration)
  • Complete feature list (invoicing, quoting, expense/income tracking, reporting, client portal, team management)
  • Deployment information (Railway, Docker, environment configuration)
  • Integration details (Xendit, Resend, MinIO/S3, Slack)
  • Known limitations and tech debt items
  • Revenue model and active clients information
  • Additional notes on configuration and deployment

Purpose

This documentation serves as a reference guide for developers, contributors, and operators to understand Summit's architecture, capabilities, and deployment requirements. It captures the current state of the project including known issues and areas for improvement.

https://claude.ai/code/session_0125b8X6wPGahF8FXu7KSDAK

Summary by CodeRabbit

• Documentation
  • Added comprehensive documentation for the Summit invoicing and financial management application, covering overview, technical stack, architecture decisions, features, deployment, integrations, and operational details.

[coderabbitai]

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: b674a557-05d8-4b3b-a5ef-06906bd1f21f

📥 Commits

Reviewing files that changed from the base of the PR and between 06558ee and 1ad09e0.

📒 Files selected for processing (1)

• SUMMIT.md

---

📝 Walkthrough

Walkthrough

A new SUMMIT.md documentation file has been added, providing comprehensive information about the Summit invoicing and financial management application. The document covers the application's overview, tech stack, architectural decisions, features, deployment details, integrations, and operational notes.

Changes

Cohort / File(s)	Summary
Documentation SUMMIT.md	New documentation file (85 lines) describing the Summit application architecture, tech stack, features, deployment configuration, integrations, and operational guidelines.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐰 A document unfolds with care,
Summit's blueprint laid so fair,
Tech stacks dance and features sing,
Architecture spreads its wing,
Knowledge shared for all to see! 📚✨

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch claude/create-summit-docs-ZOll0

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[github-actions]

PR Check Results

✅ Tests Passed

Test Output

  NewAgingReceivablesChart.tsx                          |       0 |        0 |       0 |       0 | 3-150                                                                           
  NewProfitLossChart.tsx                                |       0 |        0 |       0 |       0 | 3-153                                                                           
  ProfitLossChart.tsx                                   |       0 |        0 |       0 |       0 | 3-104                                                                           
  RecurringTransactionsButton.tsx                       |       0 |        0 |       0 |       0 | 3-50                                                                            
  StatCard.tsx                                          |       0 |        0 |       0 |       0 | 3-20                                                                            
  VisitorsChart.tsx                                     |       0 |        0 |       0 |       0 | 3-66                                                                            
 src/components/expenses                                |   22.67 |    18.01 |   18.51 |   23.03 |                                                                                 
  ExpenseCategoriesPage.tsx                             |       0 |        0 |       0 |       0 | 3-338                                                                           
  ExpenseForm.tsx                                       |   56.93 |     35.8 |   66.66 |   58.01 | 29,104-105,128-146,158-179,192-194,220-242,435-492                              
  ExpensesPage.tsx                                      |       0 |        0 |       0 |       0 | 3-365                                                                           
 src/components/income                                  |       0 |        0 |       0 |       0 |                                                                                 
  IncomeCategoriesPage.tsx                              |       0 |        0 |       0 |       0 | 3-338                                                                           
  IncomeForm.tsx                                        |       0 |        0 |       0 |       0 | 3-462                                                                           
  IncomePage.tsx                                        |       0 |        0 |       0 |       0 | 3-331                                                                           
 src/components/invoices                                |    75.9 |    61.58 |   58.49 |   76.11 |                                                                                 
  InvoiceForm.tsx                                       |      80 |    74.68 |   66.66 |   79.85 | 154,160-161,230-232,236-238,251-253,265-267,324-326,334-335,341,361,440-486,537 
  InvoiceItemForm.tsx                                   |     100 |    83.33 |     100 |     100 | 171-172                                                                         
  InvoiceList.tsx                                       |   73.91 |    45.23 |      50 |   73.91 | 90-94,99,113-119,134,177-222,275-286                                            
  InvoicePDF.tsx                                        |       0 |        0 |       0 |       0 | 1-279                                                                           
 src/components/layout                                  |       0 |        0 |       0 |       0 |                                                                                 
  Header.tsx                                            |       0 |        0 |       0 |       0 | 3-63                                                                            
  Sidebar.tsx                                           |       0 |        0 |       0 |       0 | 3-72                                                                            
 src/components/pdf                                     |       0 |        0 |       0 |       0 |                                                                                 
  InvoicePDF.tsx                                        |       0 |        0 |       0 |       0 | 1-377                                                                           
  QuotePDF.tsx                                          |       0 |        0 |       0 |       0 | 1-374                                                                           
 src/components/quotes                                  |    9.41 |     8.62 |    7.57 |    9.48 |                                                                                 
  QuoteForm.tsx                                         |       0 |        0 |       0 |       0 | 3-531                                                                           
  QuoteItemForm.tsx                                     |     100 |       75 |     100 |     100 | 98-119,173-174                                                                  
  QuoteList.tsx                                         |       0 |        0 |       0 |       0 | 3-358                                                                           
  QuotePDF.tsx                                          |       0 |        0 |       0 |       0 | 1-289                                                                           
 src/components/settings                                |       0 |        0 |       0 |       0 |                                                                                 
  ApiTokenSettings.tsx                                  |       0 |        0 |       0 |       0 | 3-255                                                                           
  CompanySettings.tsx                                   |       0 |        0 |       0 |       0 | 1-515                                                                           
 src/components/ui                                      |   33.33 |    11.57 |      29 |   34.85 |                                                                                 
  alert-dialog.tsx                                      |       0 |      100 |       0 |       0 | 3-156                                                                           
  alert.tsx                                             |       0 |      100 |       0 |       0 | 1-66                                                                            
  badge.tsx                                             |    87.5 |    66.66 |     100 |     100 | 35                                                                              
  button.tsx                                            |    87.5 |      100 |     100 |     100 |                                                                                 
  calendar.tsx                                          |       0 |        0 |       0 |       0 | 3-76                                                                            
  card.tsx                                              |   77.77 |      100 |   71.42 |   77.77 | 87,89                                                                           
  chart.tsx                                             |       0 |        0 |       0 |       0 | 3-352                                                                           
  dialog.tsx                                            |       0 |      100 |       0 |       0 | 3-134                                                                           
  dropdown-menu.tsx                                     |       0 |        0 |       0 |       0 | 3-256                                                                           
  form.tsx                                              |   94.28 |     37.5 |     100 |   94.28 | 53,159                                                                          
  input.tsx                                             |     100 |      100 |     100 |     100 |                                                                                 
  label.tsx                                             |     100 |      100 |     100 |     100 |                                                                                 
  popover.tsx                                           |       0 |        0 |       0 |       0 | 3-48                                                                            
  radio-group.tsx                                       |       0 |      100 |       0 |       0 | 3-45                                                                            
  select.tsx                                            |   64.28 |      100 |      70 |   64.28 | 177,179-182                                                                     
  separator.tsx                                         |       0 |        0 |     100 |       0 | 3-31                                                                            
  sonner.tsx                                            |       0 |        0 |       0 |       0 | 3-25                                                                            
  switch.tsx                                            |       0 |      100 |       0 |       0 | 3-31                                                                            
  table.tsx                                             |      80 |      100 |      75 |      80 | 111,115                                                                         
  tabs.tsx                                              |       0 |      100 |       0 |       0 | 3-66                                                                            
  textarea.tsx                                          |     100 |      100 |     100 |     100 |                                                                                 
 src/components/vendors                                 |       0 |        0 |       0 |       0 |                                                                                 
  VendorForm.tsx                                        |       0 |        0 |       0 |       0 | 3-326                                                                           
  VendorsList.tsx                                       |       0 |        0 |       0 |       0 | 3-219                                                                           
 src/lib                                                |   27.41 |    16.66 |   41.66 |   27.86 |                                                                                 
  config.ts                                             |       0 |        0 |     100 |       0 | 4                                                                               
  minio.ts                                              |       0 |        0 |       0 |       0 | 1-88                                                                            
  pdf.ts                                                |       0 |      100 |       0 |       0 | 1-20                                                                            
  utils.ts                                              |     100 |       80 |     100 |     100 | 14                                                                              
 src/lib/auth                                           |   15.94 |        0 |       0 |   16.41 |                                                                                 
  apiTokenUtils.ts                                      |       0 |      100 |       0 |       0 | 1-26                                                                            
  getAuthInfo.ts                                        |   16.66 |        0 |       0 |   16.66 | 16-61                                                                           
  options.ts                                            |   24.24 |        0 |       0 |      25 | 27-88                                                                           
 src/lib/auth/client                                    |       0 |        0 |       0 |       0 |                                                                                 
  utils.ts                                              |       0 |        0 |       0 |       0 | 1-165                                                                           
 src/lib/auth/permissions                               |    1.03 |        0 |       0 |    1.08 |                                                                                 
  roles.ts                                              |       0 |        0 |       0 |       0 | 20-119                                                                          
  server.ts                                             |       0 |        0 |       0 |       0 | 1-93                                                                            
  utils.ts                                              |   14.28 |        0 |       0 |   16.66 | 135-147                                                                         
 src/lib/cron                                           |       0 |        0 |       0 |       0 |                                                                                 
  recurring-items.ts                                    |       0 |        0 |       0 |       0 | 1-311                                                                           
 src/lib/jobs                                           |       0 |        0 |       0 |       0 |                                                                                 
  cron-config.ts                                        |       0 |      100 |     100 |       0 | 1-20                                                                            
  recurring-transactions.ts                             |       0 |        0 |       0 |       0 | 1-197                                                                           
 src/lib/reports                                        |       0 |        0 |       0 |       0 |                                                                                 
  cash-flow.ts                                          |       0 |        0 |       0 |       0 | 1-399                                                                           
  invoice-reports.ts                                    |       0 |        0 |       0 |       0 | 1-365                                                                           
  profit-loss.ts                                        |       0 |        0 |       0 |       0 | 1-198                                                                           
 src/lib/validations                                    |   30.58 |        0 |       0 |    37.5 |                                                                                 
  account.ts                                            |       0 |        0 |       0 |       0 | 1-25                                                                            
  client.ts                                             |     100 |      100 |     100 |     100 |                                                                                 
  expense.ts                                            |   53.33 |        0 |       0 |   77.77 | 29-38                                                                           
  income.ts                                             |       0 |      100 |       0 |       0 | 1-39                                                                            
  invoice.ts                                            |      75 |      100 |     100 |     100 |                                                                                 
  payment.ts                                            |       0 |        0 |       0 |       0 | 1-29                                                                            
  quote.ts                                              |   63.63 |      100 |     100 |     100 |                                                                                 
  transaction.ts                                        |       0 |        0 |       0 |       0 | 1-30                                                                            
 src/lib/xendit                                         |       0 |        0 |       0 |       0 |                                                                                 
  index.ts                                              |       0 |        0 |       0 |       0 | 1-71                                                                            
--------------------------------------------------------|---------|----------|---------|---------|---------------------------------------------------------------------------------

Test Suites: 9 passed, 9 total
Tests:       50 passed, 50 total
Snapshots:   0 total
Time:        7.837 s
Ran all test suites.

✅ Build Passed

Build Output

├ ○ /income-categories
├ ƒ /income/[incomeId]/edit
├ ○ /income/new
├ ○ /invoices
├ ƒ /invoices/[invoiceId]
├ ƒ /invoices/[invoiceId]/edit
├ ƒ /invoices/[invoiceId]/print
├ ○ /invoices/new
├ ○ /payment/failure
├ ○ /payment/success
├ ƒ /portal/dashboard
├ ƒ /portal/invoices
├ ƒ /portal/invoices/[invoiceId]
├ ƒ /portal/login
├ ƒ /portal/quotes
├ ƒ /portal/verify
├ ○ /quotes
├ ƒ /quotes/[quoteId]
├ ○ /quotes/new
├ ○ /recurring-transactions
├ ○ /reports
├ ○ /settings
└ ○ /vendors


ƒ Proxy (Middleware)

○  (Static)   prerendered as static content
ƒ  (Dynamic)  server-rendered on demand