Skip to content

Commit 014744a

Browse files
author
Samet UCA
authored
Update README.md
1 parent 76f3606 commit 014744a

1 file changed

Lines changed: 115 additions & 145 deletions

File tree

README.md

Lines changed: 115 additions & 145 deletions
Original file line numberDiff line numberDiff line change
@@ -1,180 +1,150 @@
1-
# React19 Admin Template
1+
# React19 Clapton Admin Template
22

3-
A modern, responsive admin dashboard template built with React 19, TypeScript, and Tailwind CSS. This template provides a comprehensive foundation for building admin applications with a beautiful UI and extensive functionality.
3+
A modern, responsive admin dashboard template built with **React 19**, **TypeScript**, and **Tailwind CSS**. This template offers a robust foundation for building admin applications with a beautiful UI, dark/light theme support, multi-language capabilities, and extensive features.
44

5-
## 🚀 Live Demo
5+
[🚀 **Live Demo**](https://react19-clapton-admin-template-free.vercel.app/)
66

7-
**Try it online:** [https://react19-clapton-admin-template-free.vercel.app/](https://react19-admin-template-premium-prev.vercel.app/)
8-
9-
Experience the template live with all features including theme switching, language support, and responsive design.
7+
---
108

119
## ✨ Features
1210

13-
### 🎨 Modern Design
14-
- **Responsive Layout**: Mobile-first design that works on all devices
15-
- **Dark/Light Theme**: Built-in theme switching with system preference detection
16-
- **Beautiful UI**: Built with Shadcn/ui components and Tailwind CSS
17-
- **Smooth Animations**: Elegant transitions and hover effects
18-
19-
### 🌍 Internationalization
20-
- **Multi-language Support**: Turkish (TR) and English (EN) language support
21-
- **Dynamic Translations**: Context-based language switching
22-
- **Persistent Preferences**: Language choice saved in localStorage
23-
24-
### 📱 Core Pages
25-
- **Dashboard**: Overview with KPIs, charts, and analytics
26-
- **Analytics**: Detailed reports and data visualization
27-
- **Users**: User management interface
28-
- **Tables**: Data table examples
29-
- **Forms Wizard**: Multi-step form implementation
30-
- **Roles**: Role-based access control
31-
- **Settings**: Comprehensive application settings
32-
- **Profile**: User profile management
33-
- **Notifications**: System notifications center
34-
35-
### 🔐 Authentication
36-
- **Login Page**: Modern login interface with social login options
37-
- **Register Page**: Multi-step registration process
38-
- **Form Validation**: Built-in form validation and error handling
39-
40-
### 📊 Data Visualization
41-
- **Charts**: Line, Bar, Pie, and Area charts using Recharts
42-
- **KPIs**: Key Performance Indicators with trend indicators
43-
- **Statistics**: Comprehensive data analytics and reporting
44-
45-
### ⚙️ Configuration
46-
- **Theme Management**: Light, Dark, and System theme options
47-
- **Language Settings**: Easy language switching
48-
- **Customizable Layout**: Flexible sidebar and header configuration
49-
- **Responsive Sidebar**: Collapsible navigation with smooth transitions
50-
51-
## 🚀 Getting Started
11+
- **Modern UI & Design**
12+
- Mobile-first, fully responsive layout
13+
- Light/Dark theme toggle with system preference detection
14+
- Built with [shadcn/ui](https://ui.shadcn.com/) components and Tailwind CSS
15+
- Smooth animations and transitions
16+
17+
- **Internationalization**
18+
- English (EN) and Turkish (TR) language support
19+
- Real-time context-based language switching
20+
- Language preference saved in localStorage
21+
22+
- **Core Application Pages**
23+
- Dashboard: KPIs, charts, and analytics overview
24+
- Analytics: Detailed reports and visualizations
25+
- Users: User management interface
26+
- Tables: Data tables with examples
27+
- Forms Wizard: Multi-step form implementation
28+
- Roles: Role-based access control
29+
- Settings: Full application settings
30+
- Profile: User profile management
31+
- Notifications: Notification center
32+
33+
- **Authentication**
34+
- Modern login page with social logins
35+
- Multi-step registration
36+
- Built-in form validation and error handling
37+
38+
- **Data Visualization**
39+
- Line, Bar, Pie, and Area charts powered by [Recharts](https://recharts.org/)
40+
- KPI widgets and trend indicators
41+
- Comprehensive analytics and reporting
42+
43+
- **Configuration & Customization**
44+
- Theme management (Light, Dark, System)
45+
- Easy language switching
46+
- Flexible sidebar and header configuration
47+
- Collapsible sidebar for improved UX
48+
49+
---
50+
51+
## 🛠️ Getting Started
5252

5353
### Prerequisites
54-
- Node.js 18+
55-
- npm or bun package manager
54+
55+
- Node.js 18+
56+
- npm or bun
5657

5758
### Installation
5859

59-
1. **Clone the repository**
60-
```bash
61-
git clone <repository-url>
62-
cd react19-admin-template
63-
```
64-
65-
2. **Install dependencies**
66-
```bash
67-
npm install
68-
# or
69-
bun install
70-
```
71-
72-
3. **Start development server**
73-
```bash
74-
npm run dev
75-
# or
76-
bun dev
77-
```
78-
79-
4. **Build for production**
80-
```bash
81-
npm run build
82-
# or
83-
bun run build
84-
```
85-
86-
## 🛠️ Tech Stack
87-
88-
- **Frontend Framework**: React 19 with TypeScript
89-
- **Styling**: Tailwind CSS with custom components
90-
- **UI Components**: Shadcn/ui component library
91-
- **Icons**: Lucide React icon set
92-
- **Charts**: Recharts for data visualization
93-
- **Routing**: React Router DOM
94-
- **State Management**: React Context API
95-
- **Build Tool**: Vite
96-
- **Package Manager**: npm/bun
60+
```bash
61+
git clone <repository-url>
62+
cd react19-admin-template
63+
npm install # or bun install
64+
npm run dev # or bun dev
65+
```
66+
67+
### Production Build
68+
69+
```bash
70+
npm run build
71+
# or
72+
bun run build
73+
```
74+
75+
---
9776

9877
## 📁 Project Structure
9978

10079
```
10180
src/
10281
├── components/ # Reusable UI components
103-
│ ├── ui/ # Shadcn/ui components
104-
│ └── AppSidebar.tsx # Main navigation sidebar
105-
├── contexts/ # React Context providers
106-
│ ├── ThemeContext.tsx # Theme management
107-
│ └── LanguageContext.tsx # Language management
82+
│ └── ui/ # shadcn/ui-based custom components
83+
├── contexts/ # Theme and language context providers
10884
├── hooks/ # Custom React hooks
109-
├── layouts/ # Layout components
110-
│ └── AppLayout.tsx # Main application layout
111-
├── pages/ # Application pages
112-
│ ├── Dashboard.tsx # Main dashboard
113-
│ ├── Analytics.tsx # Analytics and reports
114-
│ ├── Settings.tsx # Application settings
115-
│ ├── Profile.tsx # User profile
116-
│ ├── Notifications.tsx # Notifications center
117-
│ ├── Login.tsx # Authentication
118-
│ ├── Register.tsx # User registration
119-
│ └── ... # Other pages
85+
├── layouts/ # Layout components (sidebar, header, etc.)
86+
├── pages/ # Main application pages
12087
├── lib/ # Utility functions
121-
└── main.tsx # Application entry point
88+
└── main.tsx # Application entry point
12289
```
12390

124-
## 🎯 Key Components
125-
126-
### Theme Context
127-
Manages application theme (light/dark/system) with localStorage persistence and system preference detection.
128-
129-
### Language Context
130-
Provides internationalization support with dynamic language switching and translation management.
131-
132-
### AppLayout
133-
Main application layout with responsive header, sidebar, and content area.
134-
135-
### AppSidebar
136-
Navigation sidebar with collapsible menu items and user profile section.
91+
---
13792

13893
## 🎨 Customization
13994

140-
### Adding New Pages
141-
1. Create a new component in `src/pages/`
142-
2. Add the route to `src/App.tsx`
143-
3. Update navigation in `src/components/AppSidebar.tsx`
144-
145-
### Adding New Languages
146-
1. Update translations in `src/contexts/LanguageContext.tsx`
147-
2. Add language selector option in `src/layouts/AppLayout.tsx`
95+
- **Add a New Page**
96+
1. Create a component in `src/pages/`
97+
2. Add the route in `src/App.tsx`
98+
3. Update navigation in `src/components/AppSidebar.tsx`
99+
- **Add a New Language**
100+
1. Extend translations in `src/contexts/LanguageContext.tsx`
101+
2. Add the language selector in `src/layouts/AppLayout.tsx`
102+
- **Modify Themes**
103+
- Edit Tailwind configuration in `tailwind.config.ts`
104+
- Update logic in `src/contexts/ThemeContext.tsx`
148105

149-
### Customizing Themes
150-
1. Modify Tailwind CSS configuration in `tailwind.config.ts`
151-
2. Update theme context in `src/contexts/ThemeContext.tsx`
106+
---
152107

153108
## 📱 Responsive Design
154109

155-
The template is fully responsive and includes:
156110
- Mobile-first approach
157111
- Collapsible sidebar on small screens
158112
- Touch-friendly interface elements
159-
- Optimized layouts for all screen sizes
113+
- Optimized layouts for all devices
114+
115+
---
116+
117+
## 🧑‍💻 Tech Stack
118+
119+
- **React 19** with TypeScript
120+
- **Tailwind CSS**
121+
- **shadcn/ui** component library
122+
- **Lucide React** icon set
123+
- **Recharts** for data visualization
124+
- **React Router DOM** for routing
125+
- **React Context API** for state management
126+
- **Vite** as the build tool
127+
- **npm** or **bun** as package manager
128+
129+
---
130+
131+
## ⚙️ Development Scripts
160132

161-
## 🔧 Development
133+
- `npm run dev` – Start development server
134+
- `npm run build` – Build for production
135+
- `npm run preview` – Preview production build
136+
- `npm run lint` – Run ESLint checks
162137

163-
### Available Scripts
164-
- `npm run dev` - Start development server
165-
- `npm run build` - Build for production
166-
- `npm run preview` - Preview production build
167-
- `npm run lint` - Run ESLint
138+
**Code Standards:**
139+
TypeScript, ESLint, Prettier
168140

169-
### Code Style
170-
- TypeScript for type safety
171-
- ESLint for code quality
172-
- Prettier for code formatting
173-
- Consistent component structure
141+
---
174142

175143
## 📄 License
176144

177-
This project is licensed under the MIT License - see the LICENSE file for details.
145+
This project is licensed under the MIT License – see the [LICENSE](LICENSE) file for details.
146+
147+
---
178148

179149
## 🤝 Contributing
180150

@@ -184,13 +154,13 @@ This project is licensed under the MIT License - see the LICENSE file for detail
184154
4. Add tests if applicable
185155
5. Submit a pull request
186156

187-
## 📞 Support
188-
189-
For support and questions:
190-
- Create an issue in the repository
157+
For support or questions:
158+
- [Open an issue](https://github.com/sametuca/react19-clapton-admin-template-free/issues)
191159
- Check the documentation
192160
- Review existing issues and discussions
193161

194162
---
195163

196-
**Built with ❤️ using React 19, TypeScript, and Tailwind CSS**
164+
_Built with ❤️ using React 19, TypeScript, and Tailwind CSS._
165+
166+
---

0 commit comments

Comments
 (0)