1.0.1 โ€ข Published 4 months ago

project-launchkit v1.0.1

Weekly downloads
-
License
Apache-2.0
Repository
github
Last release
4 months ago

๐Ÿš€ Project LaunchKit

โœจ Features

๐Ÿ“ธ Screenshots

๐Ÿ“‹ Requirements

  • Node.js >= 16.x
  • npm >= 7.x

๐Ÿ’ป Installation

# Global installation
npm install -g project-launchkit

# Or run directly with npx
npx project-launchkit

๐Ÿ”ง Usage

# Start the interactive CLI
launchkit

# Or with npx
npx project-launchkit

๐Ÿ“š Supported Templates

๐Ÿ‘จโ€๐Ÿ’ป Development

# Clone the repository
git clone https://github.com/TheRealPerson98/LaunchKit-CLI.git
cd LaunchKit-CLI

# Install dependencies
npm install

# Run in development mode
npm run dev

# Build the project
npm run build

# Run the built version
npm start

๐Ÿงช Testing and Quality Assurance

๐Ÿ“ Project Structure

LaunchKit-CLI/
โ”œโ”€โ”€ src/           # Source code
โ”‚   โ”œโ”€โ”€ config/    # Template configurations
โ”‚   โ”œโ”€โ”€ types/     # TypeScript types
โ”‚   โ””โ”€โ”€ utils/     # Utility functions
โ”œโ”€โ”€ __test__/      # Test files
โ”œโ”€โ”€ dist/          # Compiled output (generated)
โ””โ”€โ”€ coverage/      # Test coverage reports (generated)

๐Ÿค Contributing

  1. All tests pass (npm test)
  2. Code coverage meets thresholds (npm run test:coverage)
  3. No linting errors exist (npm run lint)
  4. No unused dependencies (npm run depcheck)
  5. TypeScript compiles successfully (npm run build)
  1. Fork the repository
  2. Create your feature branch (git checkout -b feature/amazing-feature)
  3. Make your changes
  4. Run the quality checks:
    npm run build        # Ensure it builds
    npm test            # Run all tests
    npm run lint        # Check code style
    npm run depcheck    # Check dependencies
  5. Commit your changes (git commit -m 'Add some amazing feature')
  6. Push to the branch (git push origin feature/amazing-feature)
  7. Open a Pull Request
  • Maintain test coverage above 80%
  • Follow the existing code style
  • Include tests for new features
  • Update documentation as needed
  • Keep dependencies minimal and up-to-date

๐Ÿ“œ License

This project is licensed under the Apache License 2.0 - see the LICENSE file for details.

๐Ÿ™ Acknowledgments