create-ashk-app

create-ashk-app is a command-line tool to bootstrap a new React project with different predefined templates. It simplifies the process of setting up a new React project by allowing users to choose from multiple templates based on their needs.

Templates

The available templates are:

• simple: A basic React project structure.
• by-file: A project structured by files.
• by-file-and-feature: A project structured by files and features.
• by-feature-and-module: A project structured by features and modules.

Usage

To create a new project using a specified template, use the following command:

npx create-ashk-app <project-name> --template <template-name>

For example, to create a new project named my-bullet-journal using the simple template, you would run:

npx create-ashk-app my-bullet-journal --template simple

Available Templates

If you forget to include the --template flag or provide an incorrect template name, the tool will guide you with clear instructions and available options.

Example

1. Without Template Flag:

   $ npx create-ashk-app my-project
   
   Usage: create-ashk-app <project-name> --template <template-name>
   Available templates:
   - simple
   - by-file
   - by-file-and-feature
   - by-feature-and-module

2. Invalid Template Name:

   $ npx create-ashk-app my-project --template nonexistent-template
   
   Template "nonexistent-template" does not exist.
   Available templates:
   - simple
   - by-file
   - by-file-and-feature
   - by-feature-and-module

3. Correct Usage:

   $ npx create-ashk-app my-bullet-journal --template simple
   Template "simple" copied to /path/to/current/directory/my-bullet-journal

Contributing

If you would like to contribute to this project, please fork the repository and submit a pull request. For major changes, please open an issue first to discuss what you would like to change.

License

This project is licensed under the MIT License.

Author

Created by Ashkan HeidaryFazel. Feel free to reach out if you have any questions or suggestions!