Skip to content

Latest commit

 

History

History
69 lines (48 loc) · 2.47 KB

README.md

File metadata and controls

69 lines (48 loc) · 2.47 KB

create-sf-app

NPM version Build Status Code Style: Prettier

A one-stop-shop CLI tool for setting up new or existing Salesforce applications with modern development tooling and best practices.

Features

  • 🎯 Project Initialization: Quickly scaffold new Salesforce projects with best-practice file structures
  • 🛠️ Development Tools: Pre-configured setup for SFDX, Jest, ESLint, and Prettier
  • 📦 Package Management: Automated package.json setup with recommended dependencies
  • 🔄 CI/CD Templates: Ready-to-use GitHub Actions workflows for Salesforce deployments
  • 🤝 Contributor Tooling: Automated contributor recognition and pull request templates
  • 📈 Release Management: Streamlined release process with changelog generation
  • 🔒 Security: Built-in security checks and best practices

Usage

🚀 Coming soon! Stay tuned for the first release.

What's Included

create-sf-app sets up your Salesforce project with:

Development

  • SFDX project structure and configuration
  • TypeScript support for Lightning Web Components
  • ESLint configuration with Salesforce-specific rules
  • Prettier for consistent code formatting
  • Jest for unit testing
  • Apex PMD for static code analysis

GitHub Repository

  • Issue and pull request templates
  • GitHub Actions workflows for CI/CD
  • Automated dependency updates
  • Release management configuration
  • Contributing guidelines

Documentation

  • README.md template
  • Code of Conduct
  • Contributing guidelines
  • Security policy
  • License file

Options

✨ Coming soon! Configuration options will be available in the first release.

Contributing

We'd love your help improving create-sf-app! Please see our Contributing Guidelines for how to get involved.

Support

License

MIT

Acknowledgements

Inspired by create-typescript-app and built with 💙 for the Salesforce development community.