Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
278 changes: 147 additions & 131 deletions index.js
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,15 @@
import { input, select, confirm, checkbox } from "@inquirer/prompts"
import { select as selectPro } from 'inquirer-select-pro';
import path from "path";
import { run, createFolder, deleteFile } from './lib/utils.js';
import { initializePWA } from './lib/pwa.js';
import { setupCSSFramework } from './lib/css-frameworks.js';
import { createAxiosSetup, createAppComponent, createPWAReadme } from './lib/templates.js';
import { run, createFolder, deleteFile } from "./lib/utils.js";
import { initializePWA } from "./lib/pwa.js";
import { setupCSSFramework } from "./lib/css-frameworks.js";
import {
createAxiosSetup,
createAppComponent,
setupRouterMain,
createPWAReadme,
} from "./lib/templates.js";
import { setupRoutingFramework } from "./lib/router-setup.js";

const getExtraPackages = async (input) => {
Expand All @@ -25,132 +30,143 @@ const getExtraPackages = async (input) => {
};

(async () => {
// 1. Collect user inputs
const projectName = await input({ message: "Enter project name:", required: true });
const cssFramework = await select({
message: "Choose a CSS framework:",
choices: ["Tailwind", "Bootstrap (CDN)", "React Bootstrap", "MUI"]
});
const routingFramework = await select({
message: "Choose a routing framework:",
choices: ["React Router", "Tanstack Router",]
})
const isPWA = await confirm({ message: "Do you want to make this a Progressive Web App (PWA)?", default: false });

const packages = await checkbox({
message: "Select optional packages:",
choices: [
{ name: "Axios", value: "axios" },
{ name: "React Icons", value: "react-icons" },
{ name: "React Hook Form", value: "react-hook-form" },
{ name: "Yup", value: "yup" },
{ name: "Formik", value: "formik" },
{ name: "Moment.js", value: "moment" }
]
});

const extraPackages = await selectPro({
message: 'Search extra packages to add',
multiple: true,
clearInputWhenSelected: true,
pageSize: 10,
options: getExtraPackages,
theme: {
style: {
renderSelectedOptions: (selectedOptions) => {
return selectedOptions.map(option => option.value).join(', ');
}
}
}
});

let selectedExtraPackages = [];
if (extraPackages.length > 0) {
selectedExtraPackages = await checkbox({
message: "These extra packages will be installed:",
choices: extraPackages.map(pkg => ({
name: pkg,
value: pkg,
checked: true,
})),
})
// 1. Collect user inputs
const answers = await inquirer.prompt([
{
type: "input",
name: "projectName",
message: "Enter project name:",
},
{
type: "list",
name: "cssFramework",
message: "Choose a CSS framework:",
choices: ["Tailwind", "Bootstrap (CDN)", "React Bootstrap", "MUI"],
},
{
type: "list",
name: "routingFramework",
message: "Choose a routing framework:",
choices: ["React Router", "Tanstack Router"],
},
{
type: "confirm",
name: "isPWA",
message: "Do you want to make this a Progressive Web App (PWA)?",
default: false,
},
{
type: "checkbox",
name: "packages",
message: "Select optional packages:",
choices: [
{ name: "Axios", value: "axios" },
{ name: "React Icons", value: "react-icons" },
{ name: "React Hook Form", value: "react-hook-form" },
{ name: "Yup", value: "yup" },
{ name: "Formik", value: "formik" },
{ name: "Moment.js", value: "moment" },
{ name: "ReduxJs/Toolkit", value: "@reduxjs/toolkit" },
{ name: "React Bindings (React-Redux)", value: "react-redux" }
],
},
{
type: "checkbox",
name: "devPackages",
message: "Select dev packages to install:",
choices: [{ name: "Jest", value: "jest" }],
},
]);

const { projectName, cssFramework, routingFramework, isPWA, packages, devPackages } = answers;
const projectPath = path.join(process.cwd(), projectName);

console.log(
`\n🚀 Creating ${projectName}${isPWA ? " with PWA capabilities" : ""}...`
);

// 2. Create Vite project
run(`npm create vite@latest ${projectName} -- --template react`);

// 3. Create all necessary folder structure first
const folders = ["components", "pages", "hooks", "store", "utils", "assets"];
const routingConfig = {
"Tanstack Router": {
folders: ["routes"],
packages: ["@tanstack/react-router", "@tanstack/react-router-devtools"],
devPackages: ["@tanstack/router-plugin"]
},
"React Router": {
folders: [],
packages: ["react-router-dom"],
devPackages: []
}
};
const config = routingConfig[routingFramework] || { folders: [], packages: [], devPackages: [] };
folders.push(...config.folders);
folders.forEach((folder) => {
createFolder(path.join(projectPath, "src", folder));
});

// 4. Install packages
const allPackages = [...config.packages, ...packages];
if (allPackages.length > 0) {
run(`npm install ${allPackages.join(" ")}`, projectPath);
}
if (devPackages.length > 0 || config.devPackages.length > 0) {
run(`npm install --save-dev ${[...devPackages, ...config.devPackages].join(" ")}`, projectPath);
}

// 5. Setup PWA if selected (after folder structure is created)
if (isPWA) {
initializePWA(projectPath, projectName);
}

// 6. Setup CSS framework
setupCSSFramework(cssFramework, projectPath);

// 7. Setup Axios if selected
if (packages.includes("axios")) {
createAxiosSetup(projectPath);
}

// 8. Clean up default boilerplate files
deleteFile(path.join(projectPath, "src", "App.css"));
if (cssFramework !== "Tailwind") {
deleteFile(path.join(projectPath, "src", "index.css"));
}

// 9. Generate clean templates
createAppComponent(projectPath, projectName, isPWA);
setupRouterMain(projectPath, cssFramework);

// 10. Create comprehensive README
createPWAReadme(projectPath, projectName, cssFramework, packages, isPWA);

// 11. Success message
console.log("\n✅ Setup complete!");
if (isPWA) {
console.log(
"📱 PWA features enabled - your app can be installed on mobile devices!"
);
console.log(
"⚠️ Important: Replace placeholder SVG icons with proper PNG icons for production"
);
}
console.log(
`\nNext steps:\n cd ${projectName}\n npm install\n npm run dev`
);

if (isPWA) {
console.log(
`\n📱 To test PWA:\n npm run build\n npm run preview\n Open http://localhost:5173 and test install/offline features`
);
}

const projectPath = path.join(process.cwd(), projectName);

console.log(`\n🚀 Creating ${projectName}${isPWA ? ' with PWA capabilities' : ''}...`);

// 2. Create Vite project
run(`npm create vite@latest ${projectName} -- --template react`);

// 3. Create all necessary folder structure first
const folders = ["components", "pages", "hooks", "store", "utils", "assets"];

// Create the routes folder (for tanstack router) and the necessary packages for Router setup
const routingConfig = {
"Tanstack Router": {
folders: ["routes"],
packages: ["@tanstack/react-router", "@tanstack/react-router-devtools"],
devPackages: ["@tanstack/router-plugin"]
},
"React Router": {
folders: [],
packages: ["react-router"],
devPackages: []
}
};

const config = routingConfig[routingFramework] || { folders: [], packages: [], devPackages: [] };
folders.push(...config.folders);
const routingPackages = config.packages;
folders.forEach((folder) => {
createFolder(path.join(projectPath, "src", folder));
});

// 4. Install packages
const allPackages = [...routingPackages, ...packages, ...selectedExtraPackages];
if (allPackages.length > 0) {
run(`npm install ${allPackages.join(" ")}`, projectPath);
if (config.devPackages.length > 0) {
run(`npm i -D ${config.devPackages.join(" ")}`, projectPath);
}
}

// 5. Setup PWA if selected (after folder structure is created)
if (isPWA) {
initializePWA(projectPath, projectName);
}

// 6. Setup CSS framework
setupCSSFramework(cssFramework, projectPath);

// 7. Setup Axios if selected
if (packages.includes("axios")) {
createAxiosSetup(projectPath);
}

// 8. Clean up default boilerplate files
deleteFile(path.join(projectPath, "src", "App.css"));
if (cssFramework !== "Tailwind") {
deleteFile(path.join(projectPath, "src", "index.css"));
}

// 9. Generate clean templates
createAppComponent(projectPath, projectName, isPWA);
setupRoutingFramework(projectPath, routingFramework, cssFramework);

// 10. Create comprehensive README
createPWAReadme(projectPath, projectName, cssFramework, packages, isPWA);

// 11. Success message
console.log("\n✅ Setup complete!");
if (isPWA) {
console.log("📱 PWA features enabled - your app can be installed on mobile devices!");
console.log("⚠️ Important: Replace placeholder SVG icons with proper PNG icons for production");
}
console.log(`\nNext steps:\n cd ${projectName}\n npm install\n npm run dev`);

if (isPWA) {
console.log(`\n📱 To test PWA:\n npm run build\n npm run preview\n Open http://localhost:5173 and test install/offline features`);
}
})();
if (devPackages.includes("jest")) {
console.log(
"Setting up Jest configuration... \n Add the following to your package.json:"
);
console.log(`\n "scripts": {\n "test": "jest"\n }`);
}
})();
24 changes: 24 additions & 0 deletions test/test-react/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# Logs
logs
*.log
npm-debug.log*
yarn-debug.log*
yarn-error.log*
pnpm-debug.log*
lerna-debug.log*

node_modules
dist
dist-ssr
*.local

# Editor directories and files
.vscode/*
!.vscode/extensions.json
.idea
.DS_Store
*.suo
*.ntvs*
*.njsproj
*.sln
*.sw?
Loading