Built with ARCH Framework

Overview

The "ARCH FRAMEWORK" is a modern web development stack made by TheIceJi focused on modularity, scalability, and full-stack typesafety. It consists of:

• TypeScript
• Next.js (App directory)
• Tailwind CSS
• tRPC
• Prisma
• MongoDB
• NextAuth.js
• AWS-S3

Optionals:

• Framer Motion
• Zustand
• Redis

---

⚠️ Note!

• S3 is turned off by default to avoid errors when creating an S3 client without environment variables. Enable it by uncommenting the relevant lines in server/plugins/trpc/trpc.context.ts and server/interfaces/trpc/trpc.caller.ts.
• Frontend pages live in src/app.
• The global directory contains store, environment config, and general app settings.
• All backend logic resides in the server folder, connect with NextJs by tRPC interface.

---

📅 Getting Started

📦 Installation

Option 1: Download Release

• Go to the Releases tab and download the latest release.
• Extract it into your project directory.

Option 2: Manual Setup

• Clone the main repository:

  git clone https://github.com/Nexel-Lab/Arch-Framework

• Navigate to the app root folder:

  cd <app_name>

• Clone the core module:

  git clone https://github.com/Nexel-Lab/Arch-Core arch/core

• Copy the environment template:

  mv .env-example .env

⚙️ Configuration

• Add the required environment variable:

  MONGODB_URI=<your_mongodb_uri>

  (Other variables in .env are optional)

🚀 Setup & Development

• Install dependencies:

  bun install
  # or
  yarn install

• Generate database client:

  bun db:gen
  # or
  yarn db:gen

• (Recommended) Install the Todo Tree VSCode extension to track areas needing updates.

• Start the development server:

  bun dev
  # or
  yarn dev

  App runs at http://localhost:8080

📆 Production Deployment

bun deploy
# or
yarn yarn:deploy

---

🔄 What's Next?

1. Update app details:

   • global/config/app.ts → App name
   • global/config/meta/data.ts → SEO metadata
   • global/config/contacts.ts → Contact info
   • src/app/sitemap.ts → Base URL for sitemap

2. Configure layout:

   • src/layouts/_controllers/controllers.tsx → Global UI controllers

3. Optional:

   • Update global/env.ts after adding/removing packages or modules
   • Enable S3 in the tRPC context