1.0.1 โข Published 4 months ago
project-launchkit v1.0.1
๐ 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
- All tests pass (npm test)
- Code coverage meets thresholds (npm run test:coverage)
- No linting errors exist (npm run lint)
- No unused dependencies (npm run depcheck)
- TypeScript compiles successfully (npm run build)
- Fork the repository
- Create your feature branch (git checkout -b feature/amazing-feature)
- Make your changes
- 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
- Commit your changes (git commit -m 'Add some amazing feature')
- Push to the branch (git push origin feature/amazing-feature)
- 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.