create-fe-boilerplate 0.4.1 → 0.5.1

package/README.md

@@ -0,0 +1,65 @@
+# create-fe-boilerplate
+
+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.
+
+## 🚀 Features
+
+- **Frameworks**: React.js, Next.js
+- **Languages**: TypeScript, JavaScript
+- **Styling**: Tailwind CSS, SCSS (Modular)
+- **API & State Management**: Axios, Redux Toolkit (RTK) Query
+- **Auth Flow**: Built-in Login, Signup, and OTP Verification components
+- **Modern UI**: Clean, responsive, and easy-to-customize designs
+
+## 📦 Installation
+
+You can use the CLI directly via `npx`:
+
+```bash
+npx create-fe-boilerplate
+```
+
+Or install it globally:
+
+```bash
+npm install -g create-fe-boilerplate
+```
+
+## 🛠️ Usage
+
+Simply run the command and follow the interactive prompts to choose your project configuration:
+
+```bash
+create-fe-boilerplate
+```
+
+### Prompt Options:
+
+1. **Project Name**: Enter the name of your project.
+2. **Framework**: Choose between `React` or `Next.js`.
+3. **Language**: Choose `TypeScript` or `JavaScript`.
+4. **Styling**: Choose `Tailwind CSS` or `SCSS`.
+5. **API/State Management**: Choose `Axios` or `Redux Toolkit (RTK)`.
+
+## 📂 Project Structure
+
+The generated project will have a clean and organized structure:
+
+- `src/api`: API configuration and helper functions.
+- `src/components`: Reusable UI components (including Auth modals).
+- `src/pages` or `src/app`: Application routes and page components.
+- `src/styles`: Global and component-specific styles.
+- `src/utils`: Utility functions (Encryption, etc.).
+
+## 🔐 Authentication Flow
+
+The boilerplate includes a pre-built authentication flow:
+
+- **Login**: Email/Password login with optional OTP trigger.
+- **Signup**: User registration.
+- **OTP Verification**: A modal-based OTP verification system.
+- **Auth Guard**: Protected routes to ensure only authenticated users can access specific pages.
+
+## 📄 License
+
+This project is licensed under the ISC License.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-fe-boilerplate",
-  "version": "0.4.1",
+  "version": "0.5.1",
   "description": "CLI to scaffold React boilerplates with authentication, OTP, Tailwind and Axios",
   "type": "module",
   "bin": {

package/templates/next/js/scss/axios/README.md

@@ -0,0 +1,36 @@
+This is a [Next.js](https://nextjs.org) project bootstrapped with [`create-next-app`](https://nextjs.org/docs/app/api-reference/cli/create-next-app).
+
+## Getting Started
+
+First, run the development server:
+
+```bash
+npm run dev
+# or
+yarn dev
+# or
+pnpm dev
+# or
+bun dev
+```
+
+Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
+
+You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file.
+
+This project uses [`next/font`](https://nextjs.org/docs/app/building-your-application/optimizing/fonts) to automatically optimize and load [Geist](https://vercel.com/font), a new font family for Vercel.
+
+## Learn More
+
+To learn more about Next.js, take a look at the following resources:
+
+- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
+- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.
+
+You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js) - your feedback and contributions are welcome!
+
+## Deploy on Vercel
+
+The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js.
+
+Check out our [Next.js deployment documentation](https://nextjs.org/docs/app/building-your-application/deploying) for more details.

package/templates/next/js/scss/axios/eslint.config.mjs

@@ -0,0 +1,18 @@
+import { defineConfig, globalIgnores } from "eslint/config";
+import nextVitals from "eslint-config-next/core-web-vitals";
+import nextTs from "eslint-config-next/typescript";
+
+const eslintConfig = defineConfig([
+  ...nextVitals,
+  ...nextTs,
+  // Override default ignores of eslint-config-next.
+  globalIgnores([
+    // Default ignores of eslint-config-next:
+    ".next/**",
+    "out/**",
+    "build/**",
+    "next-env.d.ts",
+  ]),
+]);
+
+export default eslintConfig;

package/templates/next/js/scss/axios/jsconfig.json

@@ -0,0 +1,8 @@
+{
+  "compilerOptions": {
+    "baseUrl": ".",
+    "paths": {
+      "@/*": ["./src/*"]
+    }
+  }
+}

package/templates/next/js/scss/axios/next.config.js

@@ -0,0 +1,5 @@
+const nextConfig = {
+  /* config options here */
+};
+
+export default nextConfig;