npm - create-pnpm-custom-app - Versions diffs - 1.0.0 - Mend

create-pnpm-custom-app 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (77) hide show

package/README.md +217 -0
package/bin/cli.js +185 -0
package/package.json +39 -0
package/templates/.github/copilot-instructions.md +184 -0
package/templates/.nvmrc +1 -0
package/templates/.vscode/settings.json +51 -0
package/templates/CONTRIBUTING.md +184 -0
package/templates/LICENSE +21 -0
package/templates/README.md +324 -0
package/templates/apps/api/.env.example +36 -0
package/templates/apps/api/.prettierrc.json +7 -0
package/templates/apps/api/eslint.config.js +17 -0
package/templates/apps/api/gitignore +45 -0
package/templates/apps/api/jest.config.ts +22 -0
package/templates/apps/api/package.json +49 -0
package/templates/apps/api/src/app.ts +121 -0
package/templates/apps/api/src/config/config.ts +38 -0
package/templates/apps/api/src/config/logger.ts +57 -0
package/templates/apps/api/src/db/mongo.ts +30 -0
package/templates/apps/api/src/index.ts +40 -0
package/templates/apps/api/src/middlewares/middleware.ts +75 -0
package/templates/apps/api/src/models/example.model.ts +89 -0
package/templates/apps/api/src/routes/routes.ts +54 -0
package/templates/apps/api/src/schemas/swagger.schema.ts +58 -0
package/templates/apps/api/src/services/example.service.ts +63 -0
package/templates/apps/api/src/tests/health.test.ts +90 -0
package/templates/apps/api/src/tests/helpers/test-helpers.ts +40 -0
package/templates/apps/api/src/tests/mocks/mocks.ts +29 -0
package/templates/apps/api/src/tests/setup.ts +11 -0
package/templates/apps/api/src/types/fastify.d.ts +44 -0
package/templates/apps/api/tsconfig.json +24 -0
package/templates/apps/web/.env.example +25 -0
package/templates/apps/web/.prettierignore +7 -0
package/templates/apps/web/.prettierrc +9 -0
package/templates/apps/web/app/ICONS.md +42 -0
package/templates/apps/web/app/[locale]/(routes)/layout.tsx +13 -0
package/templates/apps/web/app/[locale]/(routes)/page.tsx +49 -0
package/templates/apps/web/app/[locale]/[...not-found]/page.tsx +8 -0
package/templates/apps/web/app/[locale]/layout.tsx +35 -0
package/templates/apps/web/app/[locale]/not-found.tsx +12 -0
package/templates/apps/web/app/components/layout/Footer.component.tsx +30 -0
package/templates/apps/web/app/components/layout/Nav.component.tsx +34 -0
package/templates/apps/web/app/components/ui/README.md +39 -0
package/templates/apps/web/app/components/ui/atoms/README.md +55 -0
package/templates/apps/web/app/components/ui/molecules/README.md +51 -0
package/templates/apps/web/app/globals.css +104 -0
package/templates/apps/web/app/icon.svg +5 -0
package/templates/apps/web/app/layout.tsx +37 -0
package/templates/apps/web/app/manifest.json +22 -0
package/templates/apps/web/app/providers.tsx +25 -0
package/templates/apps/web/app/robots.ts +12 -0
package/templates/apps/web/app/sitemap.ts +18 -0
package/templates/apps/web/eslint.config.mjs +16 -0
package/templates/apps/web/gitignore +56 -0
package/templates/apps/web/hooks/README.md +25 -0
package/templates/apps/web/i18n/config.ts +9 -0
package/templates/apps/web/i18n/request.ts +15 -0
package/templates/apps/web/interfaces/README.md +5 -0
package/templates/apps/web/lib/README.md +45 -0
package/templates/apps/web/lib/utils.ts +18 -0
package/templates/apps/web/messages/en.json +34 -0
package/templates/apps/web/messages/es.json +34 -0
package/templates/apps/web/next.config.ts +50 -0
package/templates/apps/web/package.json +34 -0
package/templates/apps/web/postcss.config.mjs +7 -0
package/templates/apps/web/proxy.ts +17 -0
package/templates/apps/web/public/README.md +7 -0
package/templates/apps/web/tsconfig.json +27 -0
package/templates/apps/web/types/README.md +3 -0
package/templates/docs/README.md +13 -0
package/templates/gitignore-root +51 -0
package/templates/package.json +30 -0
package/templates/packages/shared/eslint.config.js +26 -0
package/templates/packages/shared/package.json +22 -0
package/templates/packages/shared/src/index.ts +39 -0
package/templates/packages/shared/tsconfig.json +19 -0
package/templates/pnpm-workspace.yaml +3 -0

package/templates/CONTRIBUTING.md ADDED Viewed

@@ -0,0 +1,184 @@
+# Contributing to {{PROJECT_NAME}}
+Thank you for your interest in contributing to this project! We welcome contributions from the community.
+## Table of Contents
+- [Code of Conduct](#code-of-conduct)
+- [Getting Started](#getting-started)
+- [Development Setup](#development-setup)
+- [Making Changes](#making-changes)
+- [Commit Guidelines](#commit-guidelines)
+- [Pull Request Process](#pull-request-process)
+- [Coding Standards](#coding-standards)
+## Code of Conduct
+This project adheres to a code of conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to [project-email@example.com].
+## Getting Started
+1. Fork the repository
+2. Clone your fork: `git clone https://github.com/your-username/{{PROJECT_NAME}}.git`
+3. Add upstream remote: `git remote add upstream https://github.com/original-owner/{{PROJECT_NAME}}.git`
+4. Create a new branch: `git checkout -b feature/your-feature-name`
+## Development Setup
+### Prerequisites
+- Node.js 20+ (use the version specified in `.nvmrc`)
+- pnpm 9+
+- MongoDB (for local development)
+### Installation
+```bash
+# Install dependencies
+pnpm install
+# Copy environment files
+cp apps/web/.env.example apps/web/.env.local
+cp apps/api/.env.example apps/api/.env
+# Start development servers
+pnpm --filter web dev    # Frontend on http://localhost:3000
+pnpm --filter api dev    # Backend on http://localhost:3002
+```
+## Making Changes
+### Branch Naming
+- Feature: `feature/description`
+- Bug fix: `fix/description`
+- Documentation: `docs/description`
+- Refactor: `refactor/description`
+### Code Style
+- Follow existing code patterns
+- Use TypeScript for all new code
+- Add JSDoc comments for functions and components
+- Ensure your code passes linting: `pnpm run lint`
+- Format code with Prettier (automatic on save if configured)
+### Testing
+```bash
+# Run tests
+pnpm run test
+# Run tests in watch mode
+pnpm --filter api test:watch
+```
+## Commit Guidelines
+We follow [Conventional Commits](https://www.conventionalcommits.org/):
+```
+<type>(<scope>): <subject>
+<body>
+<footer>
+```
+### Types
+- `feat`: New feature
+- `fix`: Bug fix
+- `docs`: Documentation changes
+- `style`: Code style changes (formatting, etc.)
+- `refactor`: Code refactoring
+- `test`: Adding or updating tests
+- `chore`: Maintenance tasks
+### Examples
+```bash
+feat(auth): add Google OAuth integration
+fix(api): resolve MongoDB connection timeout
+docs(readme): update installation instructions
+```
+## Pull Request Process
+1. **Update documentation** - Update README.md if needed
+2. **Add tests** - Ensure new features have test coverage
+3. **Run quality checks**:
+   ```bash
+   pnpm run lint
+   pnpm run build
+   pnpm run test
+   ```
+4. **Create pull request** - Use a clear title and description
+5. **Link issues** - Reference related issues in the PR description
+6. **Wait for review** - Address feedback from maintainers
+### PR Template
+```markdown
+## Description
+Brief description of changes
+## Type of Change
+- [ ] Bug fix
+- [ ] New feature
+- [ ] Breaking change
+- [ ] Documentation update
+## Testing
+Describe the tests you ran
+## Checklist
+- [ ] Code follows project style guidelines
+- [ ] Self-review completed
+- [ ] Comments added for complex code
+- [ ] Documentation updated
+- [ ] No new warnings generated
+- [ ] Tests added/updated
+- [ ] All tests passing
+```
+## Coding Standards
+### TypeScript
+- Use strict TypeScript (`strict: true`)
+- Avoid `any` - use proper types
+- Define interfaces for props and data structures
+- Use descriptive variable and function names
+### React/Next.js
+- Use Server Components by default
+- Add `'use client'` only when necessary
+- Use `forwardRef` for components that need refs
+- Implement proper error boundaries
+- Optimize images with Next.js Image component
+### Tailwind CSS
+- Use utility classes only (no custom CSS)
+- Follow mobile-first responsive design
+- Use design tokens from `globals.css`
+- Maintain consistent spacing and sizing
+### Backend/API
+- Write descriptive Swagger documentation
+- Validate all input with proper schemas
+- Handle errors consistently
+- Add JSDoc comments for all functions
+- Use Mongoose models for database operations
+## Questions?
+If you have questions, please:
+1. Check existing documentation
+2. Search existing issues
+3. Create a new issue with the `question` label
+Thank you for contributing! 🎉

package/templates/LICENSE ADDED Viewed

@@ -0,0 +1,21 @@
+MIT License
+Copyright (c) 2026 [Your Name or Organization]
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/templates/README.md ADDED Viewed

@@ -0,0 +1,324 @@
+# {{PROJECT_NAME}}
+> A professional full-stack monorepo with Next.js 16, Fastify, MongoDB, and TypeScript
+[![TypeScript](https://img.shields.io/badge/TypeScript-5.x-blue.svg)](https://www.typescriptlang.org/)
+[![Next.js](https://img.shields.io/badge/Next.js-16.x-black.svg)](https://nextjs.org/)
+[![Fastify](https://img.shields.io/badge/Fastify-5.x-green.svg)](https://www.fastify.io/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](./LICENSE)
+## Table of Contents
+- [Features](#features)
+- [Tech Stack](#tech-stack)
+- [Project Structure](#project-structure)
+- [Getting Started](#getting-started)
+- [Development](#development)
+- [Building for Production](#building-for-production)
+- [Testing](#testing)
+- [Documentation](#documentation)
+- [Contributing](#contributing)
+- [License](#license)
+## Features
+- **Modern UI** - Next.js 16 with App Router and React Server Components
+- **Type-Safe** - Full TypeScript coverage across frontend and backend
+- **Internationalization** - Built-in i18n support with next-intl (English/Spanish)
+- **Tailwind CSS 4** - Utility-first styling with custom design system
+- **Fast API** - Fastify backend with MongoDB and Mongoose
+- **Authentication** - JWT-based auth with secure cookie handling
+- **API Documentation** - Interactive Swagger/OpenAPI documentation
+- **Testing Ready** - Jest configured for both frontend and backend
+- **Monorepo** - pnpm workspaces for efficient dependency management
+- **Shared Types** - Common interfaces between frontend and backend
+## Tech Stack
+### Frontend (`apps/web`)
+- **Framework**: Next.js 16.1.1+ (App Router)
+- **Language**: TypeScript 5+
+- **Styling**: Tailwind CSS 4
+- **i18n**: next-intl
+### Backend (`apps/api`)
+- **Framework**: Fastify 5+
+- **Language**: TypeScript 5+
+- **Database**: MongoDB + Mongoose
+- **Authentication**: @fastify/jwt + bcrypt
+- **Validation**: Fastify schemas
+- **Documentation**: @fastify/swagger + @fastify/swagger-ui
+- **Logging**: Pino
+- **Testing**: Jest + Supertest
+### Shared (`packages/shared`)
+- TypeScript interfaces and types
+- Shared utilities and constants
+## Project Structure
+```txt
+{{PROJECT_NAME}}/
+├── apps/
+│   ├── web/                    # Next.js frontend
+│   │   ├── app/
+│   │   │   ├── [locale]/       # Internationalized routes
+│   │   │   │   ├── (routes)/   # Main application routes
+│   │   │   │   │   ├── layout.tsx
+│   │   │   │   │   └── page.tsx
+│   │   │   │   ├── layout.tsx
+│   │   │   │   └── not-found.tsx
+│   │   │   ├── api/            # API routes (if needed)
+│   │   │   ├── components/     # React components
+│   │   │   │   ├── layout/     # Layout components
+│   │   │   │   └── ui/         # UI components
+│   │   │   │       ├── atoms/  # Basic components
+│   │   │   │       └── molecules/ # Composite components
+│   │   │   ├── globals.css     # Global styles + Tailwind config
+│   │   │   ├── layout.tsx      # Root layout
+│   │   │   └── providers.tsx   # Context providers
+│   │   ├── hooks/              # Custom React hooks
+│   │   ├── i18n/               # Internationalization config
+│   │   ├── interfaces/         # TypeScript interfaces
+│   │   ├── lib/                # Utility functions and API clients
+│   │   ├── messages/           # Translation files
+│   │   │   ├── en.json
+│   │   │   └── es.json
+│   │   ├── public/             # Static assets
+│   │   ├── types/              # TypeScript type definitions
+│   │   └── package.json
+│   │
+│   └── api/                    # Fastify backend
+│       ├── src/
+│       │   ├── config/         # Configuration files
+│       │   │   ├── config.ts   # Environment config
+│       │   │   └── logger.ts   # Pino logger setup
+│       │   ├── db/             # Database connection
+│       │   │   └── mongo.ts    # MongoDB connection
+│       │   ├── middlewares/    # Custom middlewares
+│       │   ├── models/         # Mongoose models
+│       │   ├── routes/         # API route handlers
+│       │   ├── schemas/        # Validation and Swagger schemas
+│       │   ├── services/       # Business logic services
+│       │   ├── tests/          # Test files
+│       │   ├── types/          # TypeScript types
+│       │   ├── app.ts          # Fastify app setup
+│       │   └── index.ts        # Entry point
+│       └── package.json
+│
+├── packages/
+│   └── shared/                 # Shared code between apps
+│       └── src/
+│           └── index.ts        # Exported types and utilities
+│
+├── docs/                       # Project documentation
+├── .github/                    # GitHub specific files
+│   └── copilot-instructions.md # AI assistant guidelines
+├── .vscode/                    # VS Code settings
+│   └── settings.json
+├── .nvmrc                      # Node version
+├── pnpm-workspace.yaml         # pnpm workspace config
+├── package.json                # Root package.json
+├── CONTRIBUTING.md             # Contribution guidelines
+├── LICENSE                     # MIT License
+└── README.md                   # This file
+```
+## Getting Started
+### Prerequisites
+Ensure you have the following installed:
+- **Node.js** 20+ (specified in `.nvmrc`)
+- **pnpm** 9+
+- **MongoDB** (local or remote instance)
+### Installation
+1. **Clone the repository**
+   ```bash
+   git clone https://github.com/your-username/{{PROJECT_NAME}}.git
+   cd {{PROJECT_NAME}}
+   ```
+2. **Install dependencies**
+   ```bash
+   pnpm install
+   ```
+3. **Configure environment variables**
+   **Frontend** (`apps/web/.env.local`):
+   ```env
+   # API Configuration
+   NEXT_PUBLIC_API_URL=http://localhost:3002
+   # Add other environment variables as needed
+   ```
+   **Backend** (`apps/api/.env`):
+   ```env
+   # Server
+   PORT=3002
+   NODE_ENV=development
+   # Database
+   MONGODB_URI=mongodb://localhost:27017/your-database
+   # Authentication
+   JWT_SECRET=your-super-secret-jwt-key-change-this
+   BCRYPT_ROUNDS=10
+   # CORS
+   CORS_ORIGIN=http://localhost:3000
+   ```
+4. **Start development servers**
+   ```bash
+   # Frontend (http://localhost:3000)
+   pnpm --filter web dev
+   # Backend (http://localhost:3002)
+   pnpm --filter api dev
+   ```
+## Development
+### Available Scripts
+#### Root Level
+```bash
+pnpm install          # Install all dependencies
+pnpm run lint         # Lint all packages
+pnpm run build        # Build all packages
+pnpm run test         # Run all tests
+```
+#### Frontend Development (`apps/web`)
+```bash
+pnpm --filter web dev         # Start dev server
+pnpm --filter web build       # Build for production
+pnpm --filter web start       # Start production server
+pnpm --filter web lint        # Lint code
+```
+#### Backend Development (`apps/api`)
+```bash
+pnpm --filter api dev         # Start dev server
+pnpm --filter api build       # Build TypeScript
+pnpm --filter api start       # Start production server
+pnpm --filter api test        # Run tests
+pnpm --filter api lint        # Lint code
+```
+### Code Style
+This project uses:
+- **ESLint** for code linting
+- **Prettier** for code formatting
+- **TypeScript** for type safety
+Configuration files:
+- `.eslintrc.*` - ESLint rules
+- `.prettierrc` - Prettier formatting rules
+- `tsconfig.json` - TypeScript configuration
+## Building for Production
+### Frontend
+```bash
+pnpm --filter web build
+pnpm --filter web start
+```
+The build will be optimized for production with:
+- Static page generation where possible
+- Image optimization
+- Code splitting
+- Minification
+### Backend
+```bash
+pnpm --filter api build
+NODE_ENV=production pnpm --filter api start
+```
+## Testing
+### Run All Tests
+```bash
+pnpm run test
+```
+### Backend Tests
+```bash
+pnpm --filter api test          # Run once
+pnpm --filter api test:watch    # Watch mode
+pnpm --filter api test:coverage # With coverage
+```
+### Writing Tests
+Example test structure:
+```typescript
+import { describe, it, expect } from '@jest/globals';
+describe('Feature Name', () => {
+  it('should do something', () => {
+    expect(true).toBe(true);
+  });
+});
+```
+## Documentation
+- **API Documentation**: Available at `http://localhost:3002/docs` when running the backend
+- **Copilot Instructions**: See `.github/copilot-instructions.md` for AI-assisted development guidelines
+- **Contributing Guide**: See `CONTRIBUTING.md` for contribution guidelines
+## Contributing
+We welcome contributions! Please see [CONTRIBUTING.md](./CONTRIBUTING.md) for details.
+### Quick Contribution Guide
+1. Fork the repository
+2. Create your feature branch (`git checkout -b feature/amazing-feature`)
+3. Commit your changes (`git commit -m 'feat: add amazing feature'`)
+4. Push to the branch (`git push origin feature/amazing-feature`)
+5. Open a Pull Request
+## License
+This project is licensed under the MIT License - see the [LICENSE](./LICENSE) file for details.
+## Acknowledgments
+- Built with [Next.js](https://nextjs.org/)
+- Powered by [Fastify](https://www.fastify.io/)
+- Styled with [Tailwind CSS](https://tailwindcss.com/)
+- Created with [create-pnpm-custom-app](https://github.com/your-username/create-pnpm-custom-app)
+---
+**Made by [Your Name]**

package/templates/apps/api/.env.example ADDED Viewed

@@ -0,0 +1,36 @@
+# ==================================================
+# SERVER CONFIGURATION
+# ==================================================
+PORT=3002
+NODE_ENV=development
+# ==================================================
+# DATABASE
+# ==================================================
+# MongoDB connection string
+# Local: mongodb://localhost:27017/your-database
+# Atlas: mongodb+srv://username:password@cluster.mongodb.net/database
+MONGODB_URI=mongodb://localhost:27017/your-database
+# ==================================================
+# AUTHENTICATION
+# ==================================================
+# Secret key for JWT tokens (generate a strong random string)
+JWT_SECRET=your-super-secret-jwt-key-change-this-in-production
+BCRYPT_ROUNDS=10
+# ==================================================
+# CORS
+# ==================================================
+# Allowed origins for CORS (comma-separated for multiple origins)
+# Development: http://localhost:3000
+# Production: https://your-domain.com
+CORS_ORIGIN=http://localhost:3000
+# ==================================================
+# THIRD-PARTY SERVICES (Examples)
+# ==================================================
+# EMAIL_SERVICE_API_KEY=
+# STRIPE_SECRET_KEY=
+# AWS_ACCESS_KEY_ID=
+# AWS_SECRET_ACCESS_KEY=

package/templates/apps/api/.prettierrc.json ADDED Viewed

@@ -0,0 +1,7 @@
+{
+  "semi": true,
+  "singleQuote": true,
+  "tabWidth": 2,
+  "trailingComma": "es5",
+  "printWidth": 100
+}

package/templates/apps/api/eslint.config.js ADDED Viewed

@@ -0,0 +1,17 @@
+import eslint from '@eslint/js';
+import tseslint from 'typescript-eslint';
+export default tseslint.config(
+  eslint.configs.recommended,
+  ...tseslint.configs.recommended,
+  {
+    ignores: ['node_modules/**', 'dist/**', 'coverage/**'],
+  },
+  {
+    rules: {
+      '@typescript-eslint/no-explicit-any': 'error',
+      '@typescript-eslint/explicit-function-return-type': 'off',
+      '@typescript-eslint/no-unused-vars': ['error', { argsIgnorePattern: '^_' }],
+    },
+  }
+);

package/templates/apps/api/gitignore ADDED Viewed

@@ -0,0 +1,45 @@
+# Dependencies
+node_modules/
+.pnp
+.pnp.js
+# Production
+dist/
+build/
+# Environment variables
+.env
+.env.local
+.env.*.local
+!.env.example
+# Logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+pnpm-debug.log*
+lerna-debug.log*
+# Testing
+coverage/
+.nyc_output
+# OS
+.DS_Store
+*.pem
+Thumbs.db
+# IDE
+.vscode/*
+!.vscode/settings.json
+!.vscode/extensions.json
+.idea/
+*.swp
+*.swo
+*~
+# Temporary files
+*.tmp
+.cache
+.tsbuildinfo

package/templates/apps/api/jest.config.ts ADDED Viewed

@@ -0,0 +1,22 @@
+export default {
+  preset: 'ts-jest/presets/default-esm',
+  testEnvironment: 'node',
+  roots: ['<rootDir>/src'],
+  testMatch: ['**/__tests__/**/*.ts', '**/?(*.)+(spec|test).ts'],
+  setupFilesAfterEnv: ['<rootDir>/src/tests/setup.ts'],
+  transform: {
+    '^.+\\.ts$': [
+      'ts-jest',
+      {
+        useESM: true,
+      },
+    ],
+  },
+  moduleNameMapper: {
+    '^(\\.{1,2}/.*)\\.js$': '$1',
+  },
+  extensionsToTreatAsEsm: ['.ts'],
+  coverageDirectory: 'coverage',
+  collectCoverageFrom: ['src/**/*.ts', '!src/**/*.test.ts', '!src/**/*.d.ts'],
+  coveragePathIgnorePatterns: ['/node_modules/', '/dist/'],
+};