https://github.com/codingcodax/reexjs-cli

An interactive CLI automation tool 🛠️ for creating react.js and next.js projects most fast and efficiently. ⚛️
https://github.com/codingcodax/reexjs-cli

cli cli-app creating-react es6 javascript nextjs react reactjs reexjs-cli tool typescript

Last synced: 1 day ago
JSON representation

An interactive CLI automation tool 🛠️ for creating react.js and next.js projects most fast and efficiently. ⚛️

• Host: GitHub
• URL: https://github.com/codingcodax/reexjs-cli
• Owner: codingcodax
• License: mit
• Created: 2021-04-30T18:03:44.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2021-10-18T18:02:51.000Z (about 3 years ago)
• Last Synced: 2024-10-28T16:13:50.111Z (11 days ago)
• Topics: cli, cli-app, creating-react, es6, javascript, nextjs, react, reactjs, reexjs-cli, tool, typescript
• Language: JavaScript
• Homepage: https://codingcodax.github.io/reexjs-cli/
• Size: 3.78 MB
• Stars: 27
• Watchers: 2
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        


    

      

    



[![npm](https://img.shields.io/npm/v/reexjs-cli?style=flat&logo=appveyor)](https://www.npmjs.com/package/reexjs-cli)

[![MIT License](https://img.shields.io/apm/l/atomic-design-ui.svg?style=flat&logo=appveyor)](https://github.com/tterb/atomic-design-ui/blob/master/LICENSEs)

An interactive CLI automation tool 🛠️ for creating react.js and next.js projects most fast and efficiently. ⚛️




## About ℹ️

[ReexJs CLI](https://github.com/a12989x/reexjs-cli) is an interactive CLI that automates the process of creating a React / Next App.

Usually developers we spent a lot of time installing dependencies, creating folders, etc., before having our initial configuration and start working on the application.

The goal of [ReexJs CLI](https://github.com/a12989x/reexjs-cli) It is that we can start working on our application without worrying about the initial configuration.

## Features 🎉

-   Create a react.js or next.js app. ⚛️

-   Choose from commonly used folders (assets, components, hooks, services, utils, e.t.c.) to create.

-   Or create folders with custom names.📂

-   Setup routing with user defined routes if you choose react.js.

-   Or create pages for nextjs.

-   Add supports popularly used CSS preprocessor SASS! 👓

-   And installs dependencies and dev dependencies.

## Requirements 📝

-   [Node.js](https://nodejs.org/en/) installed on your system.

-   An active internet connection for CLI to work.

## Installation 🚀

From your terminal run:

```shell

# install the package with NPM

$ npx reexjs-cli

# or install it with YARN

$ yarn reexjs-cli

```

## Documentation 📘

ReexJs CLI installs reexjs-cli command in your system. To run the tool, you need to invoke this command from your terminal:

```shell

# if you install it globally

$ reexjs-cli

```

As soon as run the command you are greeted by the CLI and you must choose between the options, the most approached your desired configuration.



Then you have to answer some questions to configure your react.js or next.js app



### Config ⚙️

Depending on the fact that Framework is chosen, different questions will be asked:

-   **App Name**:


    Enter your app name. By default it fallbacks to _reexjs-app_.

    



    ✅ Valid App Names:

    -   my-app

    -   onl1n3

    -   one-2-three

    ❌ Invalid App Names:

    -   My-App

    -   Onl1n3

    -   One-2-Three

-   **Framework**:


    Choose the Framework of your application. _Next.js_ or _React.js_.

-   **Pages Names**: (_Next.Js_)


    Enter space separated pages for next.js application.

-   **React Routing**: (_React.Js_)


    Choose if react routes is needed. Yes or No.


    If required, enter space separated routes names.

    ✅ Valid Route Names:

    -   my-route

    -   one-two-three

    ❌ Invalid Route Names:

    -   My-Route:

    -   one-2-three

    -   some-route/

    -   some.route

    -   some?route

-   **Create Folders**:


    -   Predefined:

        -   You can choose from commonly use folders to create: _assets_, _components_, _utils_, _lib_.

    -   Custom:

        -   You can enter space separated folders. The conventions would be same as routes in react routing. E.g. `context hooks`

-   **Style scripting**:


    Choose if you want use SASS preprocessor in your styles. _SCSS_, _SASS_ or _CSS_.

-   **Dependencies**: (`npm i `)


    You can enter space separated dependencies. The conventions would be same as routes in react routing. E.g. `react-bootstrap lodash moment`.

    This script run the code

-   **Dev Dependencies**: (`npm i -D `)


    You can enter separated dev dependencies. The conventions would be same as routes in react routing. E.g. `prettier husky lint-staged`.

### Examples 🤖

-   `npx reexjs-cli`. Run reexjs normally.

-   `npx reexjs-cli -n` Run reexjs with next default configuration.

-   `npx reexjs-cli -r` Run reexjs with react default configuration.

### TODOs ✅

-   Get notification every time an update is available. 🔔

-   Choose JavaScript and TypeScript. 🔥

-   Choose preferred export type: named or default. 🤔

-   Add Redux/MobX/useContext state management setup. ⚙️

-   Style your app EXACTLY Like Google. 😎

## License

ReexJs CLI is licensed under the terms of [MIT](https://choosealicense.com/licenses/mit/)

**Built with ❤️ by [Codax](https://github.com/a12989x).**