y3-app
Version:
CLI to add your project structure
53 lines (46 loc) • 1.3 kB
JavaScript
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.getReadme = getReadme;
function getReadme(projectName, projectType) {
return `# Project ${projectName}
## Project Structure
This project is a ${projectType === 'fullstack'
? 'Fullstack TypeScript (React + Node.js)'
: projectType === 'react'
? 'React TypeScript'
: 'Node.js TypeScript'} application.
## Getting Started
### Local Development
1. Install dependencies:
\`\`\`bash
pnpm install
\`\`\`
2. Run the development server:
\`\`\`bash
npm run dev
\`\`\`
### Docker Development
1. Build and start the development container:
\`\`\`bash
npm run docker:dev
\`\`\`
### Docker Production
1. Build the production image:
\`\`\`bash
npm run docker:build
\`\`\`
2. Start the production container:
\`\`\`bash
npm run docker:prod
\`\`\`
3. Stop the container:
\`\`\`bash
pnpm run docker:down
\`\`\`
${projectType === 'fullstack'
? 'This will start both the frontend (Vite on port 3000) and backend (Node.js on port 4000) concurrently.'
: projectType === 'react'
? 'This will start the Vite development server on port 3000.'
: 'This will start the Node.js development server on port 3000.'}
`;
}