@ldons/mern-template-app v1.0.4

I'll help you create a comprehensive README for your npm package. Here's a draft:

MERN Template App

A CLI tool to quickly scaffold a full-stack MERN (MongoDB, Express, React, Node.js) project with TypeScript support.

Features

• Quickly generate a complete MERN stack project structure
• TypeScript support for both frontend and backend
• Preconfigured project setup
• Interactive project name selection

Prerequisites

• Node.js (version 14 or later)
• npm

Installation

You can install the package globally or use npx to run it:

# Global installation
npm install -g @ldons/mern-template-app

# Or use npx (recommended)
npx @ldons/mern-template-app

Usage

Simply run the CLI tool and follow the prompts:

npx @ldons/mern-template-app

You'll be asked to provide a project name. The tool will:

• Create a new directory with your project name
• Set up a client (React) directory
• Set up a server (Node.js) directory
• Configure package.json files
• Provide a basic project structure

Project Structure

After generating, your project will look like:

your-project-name/
├── client/          # Frontend React application
│   ├── public/
│   ├── src/
│   ├── index.html
│   ├── tsconfig.json
│   ├── vite.config.ts
│   └── package.json
├── server/          # Backend Node.js server
│   ├── src/
│   ├── tsconfig.json
│   └── package.json
├── LICENSE
└── README.md

Getting Started After Generation

1. Navigate to your project directory
2. Install frontend dependencies:

   cd client
   npm install
   npm run dev

3. In a new terminal, install backend dependencies:

   cd server
   npm install
   npm run dev

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

License

This project is licensed under the MIT License.

Author

ldons

Keywords

mern, typescript, react, node, mongodb, express, template, starter, cli