create-fe-boilerplate 0.5.0 → 0.5.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +65 -0
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,65 @@
|
|
|
1
|
+
# create-fe-boilerplate
|
|
2
|
+
|
|
3
|
+
A powerful CLI tool to quickly scaffold modern React and Next.js applications. It comes pre-configured with essential features like authentication, OTP verification, and multiple styling and state management options.
|
|
4
|
+
|
|
5
|
+
## 🚀 Features
|
|
6
|
+
|
|
7
|
+
- **Frameworks**: React.js, Next.js
|
|
8
|
+
- **Languages**: TypeScript, JavaScript
|
|
9
|
+
- **Styling**: Tailwind CSS, SCSS (Modular)
|
|
10
|
+
- **API & State Management**: Axios, Redux Toolkit (RTK) Query
|
|
11
|
+
- **Auth Flow**: Built-in Login, Signup, and OTP Verification components
|
|
12
|
+
- **Modern UI**: Clean, responsive, and easy-to-customize designs
|
|
13
|
+
|
|
14
|
+
## 📦 Installation
|
|
15
|
+
|
|
16
|
+
You can use the CLI directly via `npx`:
|
|
17
|
+
|
|
18
|
+
```bash
|
|
19
|
+
npx create-fe-boilerplate
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
Or install it globally:
|
|
23
|
+
|
|
24
|
+
```bash
|
|
25
|
+
npm install -g create-fe-boilerplate
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
## 🛠️ Usage
|
|
29
|
+
|
|
30
|
+
Simply run the command and follow the interactive prompts to choose your project configuration:
|
|
31
|
+
|
|
32
|
+
```bash
|
|
33
|
+
create-fe-boilerplate
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
### Prompt Options:
|
|
37
|
+
|
|
38
|
+
1. **Project Name**: Enter the name of your project.
|
|
39
|
+
2. **Framework**: Choose between `React` or `Next.js`.
|
|
40
|
+
3. **Language**: Choose `TypeScript` or `JavaScript`.
|
|
41
|
+
4. **Styling**: Choose `Tailwind CSS` or `SCSS`.
|
|
42
|
+
5. **API/State Management**: Choose `Axios` or `Redux Toolkit (RTK)`.
|
|
43
|
+
|
|
44
|
+
## 📂 Project Structure
|
|
45
|
+
|
|
46
|
+
The generated project will have a clean and organized structure:
|
|
47
|
+
|
|
48
|
+
- `src/api`: API configuration and helper functions.
|
|
49
|
+
- `src/components`: Reusable UI components (including Auth modals).
|
|
50
|
+
- `src/pages` or `src/app`: Application routes and page components.
|
|
51
|
+
- `src/styles`: Global and component-specific styles.
|
|
52
|
+
- `src/utils`: Utility functions (Encryption, etc.).
|
|
53
|
+
|
|
54
|
+
## 🔐 Authentication Flow
|
|
55
|
+
|
|
56
|
+
The boilerplate includes a pre-built authentication flow:
|
|
57
|
+
|
|
58
|
+
- **Login**: Email/Password login with optional OTP trigger.
|
|
59
|
+
- **Signup**: User registration.
|
|
60
|
+
- **OTP Verification**: A modal-based OTP verification system.
|
|
61
|
+
- **Auth Guard**: Protected routes to ensure only authenticated users can access specific pages.
|
|
62
|
+
|
|
63
|
+
## 📄 License
|
|
64
|
+
|
|
65
|
+
This project is licensed under the ISC License.
|