Skip to content

Commit

Permalink
feat: add monorepo structure README
Browse files Browse the repository at this point in the history
  • Loading branch information
Jennievon committed Oct 1, 2024
1 parent 0f79ef3 commit 1abea37
Showing 1 changed file with 29 additions and 0 deletions.
29 changes: 29 additions & 0 deletions packages/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# Monorepo Structure for TEN Frontend Projects

This repository uses a monorepo setup to manage multiple frontend projects and shared resources such as components, utilities, and hooks. The structure enhances code reuse, maintainability, and collaboration across projects like **Tenscan**, **Gateway**, **Bridge**, and more.

## Folder Structure

```bash
📁 packages
├── 📁 apis - Server-side logic, API routes, and backend services
│ ├── 📁 .config - Configuration files for the APIs
│ ├── 📁 src - Source files for API logic
│ ├── 📁 storage - Storage-related logic or utilities
├── 📁 eslint-config - Centralized ESLint configuration for all frontend projects
├── 📁 shared - Reusable components, hooks, and utilities shared across frontend apps
│ ├── 📁 src - Main directory containing shared code
├── 📁 typescript-config - Centralized TypeScript configurations
│ ├── 📄 base.json - Base TypeScript configuration for general projects
│ ├── 📄 nextjs.json - Configuration specific to Next.js projects
│ ├── 📄 react-library.json - Configuration for React libraries
├── 📁 ui -
│ ├── 📁 api - API logic consumed by the frontend
│ ├── 📁 components - Reusable React components used in the UI
│ ├── 📁 hooks - Custom hooks used across the frontend
│ ├── 📁 lib - Utility functions used across the frontend
│ ├── 📁 public - Static files such as images and assets
│ ├── 📁 services - External service interactions like APIs
│ ├── 📁 routes - Routing configuration and route-related logic
│ ├── 📁 stores - Global state mgt
```

0 comments on commit 1abea37

Please sign in to comment.