create-mkx-app

Create Mkx App

A simple CLI tool to scaffold new MKX applications quickly and efficiently.

Features

• Automatically creates a new project structure.
• Pre-configured with a template directory for easy setup.
• Includes React and Express integration for full-stack development.

Installation

You can install the package globally or use it directly via npx.

Option 1: Use with npx

Run the following command to scaffold a new app without installing the package globally:

npx create-mkx-app my-app

Option 2: Install Globally

Install the package globally using npm:

npm install -g create-mkx-app

Then, run:

create-mkx-app my-app

Usage

Creating a New App

To create a new application, run the following command:

npx create-mkx-app my-app

or (if installed globally):

create-mkx-app my-app

This will create a new directory called my-app in your current working directory, containing the pre-configured project files.

Project Structure

After running the command, the generated project will look like this:

my-app/
├── node_modules/
├── public/
│   └── index.html
├── src/
│   ├── App.jsx
│   ├── index.js
│   └── styles.css
├── server.js
├── package.json
└── README.md

Key Files:

• server.js: An Express server to handle backend logic.
• src/: Contains the React frontend.
• public/: Contains static files like index.html.

Getting Started

After creating the app, follow these steps to get started:

• Navigate to the project directory:

cd my-app

• Install dependencies:

npm install

• Start the development server:

npm start

• Open your browser and navigate to:

http://localhost:3000

Dependencies

The following packages are included in the project:

• Express: For backend server functionality.
• React: For building the frontend user interface.
• fs-extra: For file system operations.
• chalk: For colored terminal output.
• commander: For building the CLI interface.

Contributing

Contributions are welcome! If you’d like to contribute, please follow these steps:

• Fork the repository.
• Create a feature branch (git checkout -b feature-name).
• Commit your changes (git commit -m "Add feature").
• Push to the branch (git push origin feature-name).
• Open a pull request.

License

This project is licensed under the MIT License.

Author

Mani Kant Sharma Feel free to reach out with any questions or feedback!