Skip to content

react-cli-jup is a command-line tool designed to streamline the creation of React projects using Vite. This tool simplifies the setup process, making it easier to get started with modern React development.

Notifications You must be signed in to change notification settings

Jhonatanup/react-cli-jup

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

3 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

react-cli-jup 🦥

react-cli-jup is a command-line tool designed to streamline the creation of React projects using Vite. This tool simplifies the setup process, making it easier to get started with modern React development.

Features

  • Initializes a new React app using Vite.
  • Supports JavaScript and TypeScript templates.
  • Provides a simple and intuitive CLI for project creation.

Installation

To use react-cli-jup locally during development:

  1. Clone the repository:

    git clone <repository-url>
    cd react-cli-jup
  2. Link the CLI locally:

    npm link

    This will make the react-cli-jup command available globally on your system.


Usage

Run the following command to create a new React project:

react-cli-jup --name <project-name> [--typescript]

Options

  • --name: Specifies the name of the project (default: my-app).
  • --typescript: Sets up the project with TypeScript (default: JavaScript).

Example

To create a new React app named awesome-app with TypeScript:

react-cli-jup --name awesome-app --typescript

Development

Current Status

The tool currently supports:

  • Initializing React apps with Vite.
  • Basic support for JavaScript and TypeScript templates.

Roadmap

  1. Add ESLint configuration setup.
  2. Add Prettier configuration setup.
  3. Integrate Cypress for end-to-end testing.

Testing

The project includes unit tests to ensure reliable functionality. To run tests:

  1. Install development dependencies:

    npm install
  2. Run the tests:

    npm test

Contributing

Contributions are welcome! If you’d like to contribute:

  1. Fork the repository.
  2. Create a new branch for your feature/bugfix.
  3. Submit a pull request with a detailed description of your changes.

License

This project is licensed under the MIT License. See the LICENSE file for details.

About

react-cli-jup is a command-line tool designed to streamline the creation of React projects using Vite. This tool simplifies the setup process, making it easier to get started with modern React development.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published