UNPKG

create-next-bricks

Version:

create-next-bricks is a CLI tool designed to scaffold a modular and scalable structure for Next.js applications. Inspired by the concept of `bricks` as reusable building blocks, this tool helps developers quickly set up a well-structured Next.js project w

106 lines (73 loc) • 3.14 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
# 🚀 Next.js Project Generator A powerful CLI tool to scaffold a scalable, modular **Next.js** project with best practices, essential dependencies, and opinionated architecture—ready for real-world development. --- ## 📦 Features - ✅ **Modular folder structure** - 🧠 **Redux Toolkit + Persist** pre-configured - 🌍 **i18next** for localization - 🎨 **Material-UI** and **SCSS** support - ⚙️ **TypeScript**, strict linting, and Prettier - 🔐 Auth module boilerplate - 🗃️ `.env.local` with default variables - 🧪 Testing ready structure - 🛠️ Easily extendable (e.g., Socket.IO, internationalization) --- ## 🛠️ How to Use ```bash # Run npx create-next-bricks ``` If no app name is passed, it defaults to `app-name`. --- ## 📁 Generated Folder Structure ``` your-app-name/ ├── public/ ├── src/ │ ├── app/ # Next.js App Router │ ├── config/ # Environment configs │ ├── modules/ │ │ └── auth/ # Auth-related logic │ ├── shared/ # Shared UI/components │ ├── store/ # Redux Toolkit store setup │ ├── types/ # Global TypeScript types │ └── styles/ # Global SCSS files └── .env.local # Local environment variables ``` > Temporary folders include `.temp` files to prevent deletion during initial Git commits. --- ## 📚 Pre-installed Packages | Category | Packages | |-------------------|--------------------------------------------------------------------------| | **Core** | `next`, `react`, `react-dom`, `typescript`, `sass` | | **UI Framework** | `@mui/material`, `@mui/icons-material`, `@emotion/react`, `styled` | | **State Mgmt** | `@reduxjs/toolkit`, `react-redux`, `redux-persist` | | **Utilities** | `axios`, `i18next`, `react-i18next` | | **Dev Tools** | `@types/react`, `@types/node`, `prettier` | --- ## ⚙️ Configuration Included - `package.json` with common scripts - `tsconfig.json` with `@/*` path aliases - `next.config.js` with SVG support - `store` with Redux Toolkit + persistence - Localization setup with i18next - Global layout, styles, and sample components - Auth module boilerplate (slice + login page) - API helper (`api.ts`) using Axios --- ## 💬 Need Socket.IO Support? You can easily extend this with **Socket.IO**. > 💡 Just ans: > > **1. Do you want to include Socket.IO setup? (yes/no):** > **2. Do you want to add sample chat ui? (yes/no):** It generate a Socket.IO integration with: - Socket initialization via custom hook - Connection and event handling - Folder structure that fits into `shared` or `modules/chat` --- ## 🧑‍💻 Contributing This CLI generator is meant for rapid prototyping and scaling production apps. Fork it, modify it, and use it across teams! --- ## 📄 License **MIT** — Free to use, modify, and distribute.