admin/ARTEX
1
0 Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

chore(web): 删除模板残留文档

Browse Source 
移除 Studio Admin 模板遗留的 README.md / AGENTS.md / CONTRIBUTING.md（与 ARTEX 无关）。

Co-Authored-By: Claude Opus 4.8 (1M context) <[email protected]>
This commit is contained in:
Autumn-27andClaude Opus 4.8 committed 2026-07-26 05:30:04 -04:00
1 parent ee97991a5e
commit 5dbede42b2
3 files changed
-362
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

web/AGENTS.md
-96
View File
@@ -1,96 +0,0 @@
# AGENTS.md
## Project overview
Studio Admin is a responsive admin dashboard built with Next.js 16, React 19, TypeScript, Tailwind CSS v4, and shadcn/ui.
This repository uses the shadcn `radix-nova` style. The shadcn CLI reports `base: "radix"`, which refers to Radix UI. Always inspect the local components in `src/components/ui/` because individual wrappers may use different primitives.
<!-- BEGIN:nextjs-agent-rules -->
# Next.js: ALWAYS read docs before coding
Before any Next.js work, find and read the relevant doc in `node_modules/next/dist/docs/`. Your training data is outdated — the docs are the source of truth.
<!-- END:nextjs-agent-rules -->
## shadcn skill
Use the shadcn skill for all work involving shadcn/ui components, styling, composition, registries, presets, or `components.json`.
If the skill is not available, install it with:
```bash
npx skills add shadcn/ui
```
The skill contains the component, styling, composition, accessibility, and CLI rules. Do not duplicate those rules here. Always inspect the local component source before using it.
Do not modify files inside `src/components/ui/` or `src/components/calendar/`. Keep these components intact and apply styling or customization where they are used.
## Setup
This project uses npm.
```bash
npm install
npm run dev
```
Available commands:
```bash
npm run build
npm run lint
npm run format
npm run check
npm run check:fix
npm run generate:presets
```
There is currently no automated test command. Run build, lint, check, or other validation commands only when the user explicitly requests that validation.
## Co-location-based structure
Keep feature code close to the route that owns it.
- Dashboard routes: `src/app/(main)/dashboard/<screen>/page.tsx`
- Screen-specific components, data, and schemas: `src/app/(main)/dashboard/<screen>/_components/`
- Shared dashboard components: `src/app/(main)/dashboard/_components/`
- Shared application components: `src/components/`
- Local shadcn components: `src/components/ui/`
- Shared hooks and utilities: `src/hooks/` and `src/lib/`
- Theme presets: `src/styles/presets/`
Keep a component inside its route until it is reused by another feature. Do not move screen-specific code into a shared directory preemptively.
## Creating or extending a screen
1. Inspect the closest current screen before writing code. Finance, Infrastructure, CRM, and Analytics are useful references. Do not use routes under `(legacy)` as references for new screens unless maintaining a legacy route.
2. When reproducing a UI from a screenshot or image, follow its visual direction closely, including layout, hierarchy, spacing, component structure, and important details. Implement it with the project's existing components and semantic theme tokens rather than copying raw color values. If the design needs a color that is not available through the existing theme tokens, or the user explicitly requests a non-theme color, use a named color from Tailwind's default palette. Do not use arbitrary hex, RGB, HSL, or OKLCH values.
3. Reuse the existing dashboard shell, local components, layout controls, and theme tokens.
4. Break each new page into focused components inside the route's `_components/` directory. Keep `page.tsx` small and focused on composing those pieces.
5. Keep `page.tsx` as a Server Component by default. Move interactive or browser-dependent code into a dedicated Client Component.
6. Add the screen to `src/navigation/sidebar/sidebar-items.ts` when it should appear in the dashboard navigation.
7. Decide the information hierarchy before choosing widgets. Let the content determine the page structure.
8. Keep the established visual rhythm where it fits: compact spacing, clear typography hierarchy, responsive action rows, and grids that collapse cleanly on smaller screens.
9. Widget selection is not a fixed formula. Try different arrangements of cards, resource rows, meters, charts, tabs, empty states, and actions, then keep the version that communicates the content clearly and feels consistent with the project.
10. Match nearby screens in card density, borders, radius, spacing, content width, and responsive behavior.
11. Use semantic theme tokens so new screens work with light mode, dark mode, and the existing theme presets.
12. Handle relevant loading, empty, error, disabled, and overflow states.
13. Keep screens accessible with semantic HTML, keyboard support, visible focus states, labels, and appropriate ARIA attributes.
## Code conventions
- TypeScript strict mode is enabled. Use precise types and avoid `any`.
- Use the existing `@/` import aliases.
- Follow the Biome configuration: double quotes, semicolons, two-space indentation, sorted imports, and a 120-character line width.
- Avoid unnecessary dependencies.
- Keep changes focused and do not refactor unrelated files.
## Contributions
- Use conventional commit prefixes such as `feat:`, `fix:`, `refactor:`, `docs:`, and `chore:`.
- Include screenshots for new screens and material visual changes. Include mobile and dark-theme states when relevant.
- Explain new reusable patterns or dependencies in the pull request.
- Follow `CONTRIBUTING.md` for the contribution workflow.
web/CONTRIBUTING.md
-127
View File
@@ -1,127 +0,0 @@
# Contributing to Studio Admin
Thanks for showing interest in improving **Studio Admin** (repo: `next-shadcn-admin-dashboard`).
This guide will help you set up your environment and understand how to contribute.
---
## Overview
This project is built with **Next.js 16**, **TypeScript**, **Tailwind CSS v4**, and **Shadcn UI**.
The goal is to keep the codebase modular, scalable, and easy to extend.
---
## Project Layout
We use a **colocation-based file system**. Each feature keeps its own pages, components, and logic.
```
src
├── app # Next.js routes (App Router)
│ ├── (auth) # Auth layouts & screens
│ ├── (main) # Main dashboard routes
│ │ └── (dashboard)
│ │ ├── crm
│ │ ├── finance
│ │ ├── default
│ │ └── ...
│ └── layout.tsx
├── components # Shared UI components
├── hooks # Reusable hooks
├── lib # Config & utilities
├── styles # Tailwind / theme setup
└── types # TypeScript definitions
```
If you’d like a more detailed example of this setup, check out the [Next Colocation Template](https://github.com/arhamkhnz/next-colocation-template), where the full structure is explained with examples.
---
## Getting Started
### Fork and Clone the Repository
1. Fork the Repository
Click [here](https://github.com/arhamkhnz/next-shadcn-admin-dashboard/fork) to fork the repository.
2. Clone the Repository
```bash
git clone https://github.com/YOUR_USERNAME/next-shadcn-admin-dashboard.git
```
3. Navigate into the Project
```bash
cd next-shadcn-admin-dashboard
```
4. **Install dependencies**
```bash
npm install
```
5. **Run the dev server**
```bash
npm run dev
```
App will be available at [http://localhost:3000](http://localhost:3000).
---
## Contribution Flow
- Always create a new branch before working on changes:
```bash
git checkout -b feature/my-update
```
- Use clear commit messages:
```bash
git commit -m "feat: add finance dashboard screen"
```
- Open a Pull Request once ready.
- If your change adds a new UI screen or component, include a screenshot in your PR description.
---
## Where to Contribute
- **External Pages**: Landing pages or other non-dashboard routes → `src/app/(external)/`
- **Auth Screens**: Login, register, and authentication layouts → `src/app/(main)/auth/`
- **Dashboard Screens**: Feature dashboards like CRM, Finance, Analytics → `src/app/(main)/dashboard/`
- **Components**: Reusable UI goes in `src/components/`
- **Hooks**: Custom logic goes in `src/hooks/`
- **Themes**: New presets under `src/styles/presets/`
---
## Guidelines
- Prefer **TypeScript types** over `any`
- Husky pre-commit hooks are enabled - linting and formatting run automatically when you commit, and if there are errors the commit will be blocked until they are fixed.
- Follow **Shadcn UI** style & Tailwind v4 conventions
- Keep accessibility in mind (ARIA, keyboard nav)
- Use clear commit messages with conventional prefixes (`feat:`, `fix:`, `chore:`, etc.)
- Avoid unnecessary dependencies — prefer existing utilities where possible
---
## Submitting PRs
- Open a Pull Request once your changes are ready.
- Ensure your branch is up to date with `main` before submitting.
- Reference any related issue in your PR for context.
---
## Questions & Support
- Report bugs, suggestions, or issues via [GitHub Issues](https://github.com/arhamkhnz/next-shadcn-admin-dashboard/issues)
---
Your contributions keep this project growing. 🚀
**Happy Vibe Coding!**
web/README.md
-139
View File
@@ -1,139 +0,0 @@
# Next.js Admin Template with TypeScript & Shadcn UI
**Studio Admin** - Includes multiple dashboards, authentication layouts, customizable theme presets, and more.
<img src="https://github.com/arhamkhnz/next-shadcn-admin-dashboard/blob/main/media/dashboard.png?version=5" alt="Dashboard Screenshot">
Most admin templates I found, free or paid, felt cluttered, outdated, or too rigid. I built this as a cleaner alternative with features often missing in others, such as theme toggling and layout controls, while keeping the design modern, minimal, and flexible.
> **View demo:** [studio admin](https://next-shadcn-admin-dashboard.vercel.app)
> [!NOTE]
> Looking for the Base UI version? Check out [next-shadcn-admin-dashboard-baseui](https://github.com/arhamkhnz/next-shadcn-admin-dashboard-baseui).
> [!TIP]
> I’m also working on Nuxt.js, Svelte, and React (Vite + TanStack Router) versions of this dashboard. They’ll be live soon.
## Features
- Built with Next.js 16, TypeScript, Tailwind CSS v4, and Shadcn UI
- Responsive and mobile-friendly
- Customizable theme presets (light/dark modes with color schemes like Tangerine, Brutalist, and more)
- Flexible layouts (collapsible sidebar, variable content widths)
- Authentication flows and screens
- Prebuilt dashboards (Default, CRM, Finance, Analytics, Productivity) plus legacy variants
- Role-Based Access Control (RBAC) with config-driven UI and multi-tenant support *(planned)*
> [!NOTE]
> The default dashboard uses the **shadcn neutral** theme.
> It also includes additional color presets inspired by [Tweakcn](https://tweakcn.com):
>
> - Tangerine
> - Neo Brutalism
> - Soft Pop
>
> You can create more presets by following the same structure as the existing ones.
> Looking for the **Next.js 15** version?
> Check out the [`archive/next15`](https://github.com/arhamkhnz/next-shadcn-admin-dashboard/tree/archive/next15) branch.
> This branch contains the setup prior to upgrading to Next 16 and the React Compiler.
> Looking for the **Next.js 14 + Tailwind CSS v3** version?
> Check out the [`archive/next14-tailwindv3`](https://github.com/arhamkhnz/next-shadcn-admin-dashboard/tree/archive/next14-tailwindv3) branch.
> It has a different color theme and is not actively maintained, but I try to keep it updated with major changes.
## Tech Stack
- **Framework**: Next.js 16 (App Router), TypeScript, Tailwind CSS v4
- **UI Components**: Shadcn UI
- **Validation**: Zod
- **Forms & State Management**: React Hook Form, Zustand
- **Tables & Data Handling**: TanStack Table
- **Tooling & DX**: Biome, Husky
## Screens
### Available
- Default Dashboard
- CRM Dashboard
- Finance Dashboard
- Analytics Dashboard
- Productivity Dashboard
- E-commerce Dashboard
- Academy Dashboard
- Logistics Dashboard
- Infrastructure Dashboard
- Chat Page
- Email Page
- Users Management
- Roles Management
- Kanban Board
- Tasks Page
- Invoice Page
- Calendar Page
- Authentication (4 screens)
- Legacy: Default v1, CRM v1, Finance v1, Analytics v1
### Planned
I’ve added all the planned screens. Feel free to open an issue for requesting something specific.
## Colocation File System Architecture
This project follows a **colocation-based architecture** each feature keeps its own pages, components, and logic inside its route folder.
Shared UI, hooks, and configuration live at the top level, making the codebase modular, scalable, and easier to maintain as the app grows.
For a full breakdown of the structure with examples, see the [Next Colocation Template](https://github.com/arhamkhnz/next-colocation-template).
## Getting Started
You can run this project locally, or deploy it instantly with Vercel.
### Deploy with Vercel
[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Farhamkhnz%2Fnext-shadcn-admin-dashboard)
_Deploy your own copy with one click._
### Run locally
1. **Clone the repository**
```bash
git clone https://github.com/arhamkhnz/next-shadcn-admin-dashboard.git
```
2. **Navigate into the project**
```bash
cd next-shadcn-admin-dashboard
```
3. **Install dependencies**
```bash
npm install
```
4. **Start the development server**
```bash
npm run dev
```
Your app will be running at [http://localhost:3000](http://localhost:3000)
### Formatting and Linting
Format, lint, and organize imports
```bash
npx @biomejs/biome check --write
```
> For more information on available rules, fixes, and CLI options, refer to the [Biome documentation](https://biomejs.dev/).
---
> [!IMPORTANT]
> This project is updated frequently. If you’re working from a fork or an older clone, pull the latest changes before syncing. Some updates may include breaking changes.
---
Contributions are welcome. Feel free to open issues, feature requests, or start a discussion.
**Happy Vibe Coding!**