create-dynamic-app/next-templates/readme.ts

CLI tool to generate sample applications using Dynamic's web3 authentication

/**
 * Generates README.md content for Next.js applications
 */

export function generateNextReadme(appName: string): string {
	return `# ${appName}

This project was generated with [Create Dynamic App](https://github.com/dynamic-labs/create-dynamic-app).

## Getting Started

### Set up your environment variables

Copy the \`.env.example\` file to \`.env.local\`:

\`\`\`bash
cp .env.example .env.local
\`\`\`

Update the \`NEXT_PUBLIC_DYNAMIC_ENVIRONMENT_ID\` in the \`.env.local\` file with your own environment ID from [Dynamic Dashboard](https://app.dynamic.xyz).

### Install dependencies

\`\`\`bash
npm install
# or
yarn
# or
pnpm install
# or
bun install
\`\`\`

### Development

Run the development server:

\`\`\`bash
npm run dev
# or
yarn dev
# or
pnpm dev
# or
bun dev
\`\`\`

Open [http://localhost:3000](http://localhost:3000) to view your application in the browser.

## Available Scripts

- \`dev\`: Starts the development server
- \`build\`: Builds the app for production
- \`start\`: Starts the production server
- \`lint\`: Lints the codebase

## Learn More

- [Dynamic Documentation](https://docs.dynamic.xyz)
- [Next.js Documentation](https://nextjs.org/docs)
- [React Documentation](https://react.dev)
`
}