• Stars
    star
    142
  • Rank 258,495 (Top 6 %)
  • Language
    JavaScript
  • Created over 2 years ago
  • Updated over 1 year ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

Professional React app generator. Comes with an exposed, unopinionated, high performance configuration. Jest, SWC, Storybook, Typescript 5, Webpack 5.

Screenshot 2023-04-19 at 12 52 14

ALRIGHT REACT APP

Professional React app generator. Comes with an exposed, unopinionated, high performance configuration. Jest, SWC, Storybook 7, Typescript 5, Webpack 5.

screenshot

GETTING STARTED

In your terminal, type:

npx alright-react-app

The npx command is available if npm is installed globally on your computer. Alright React App will ask you to enter an application name. Then you just have to press enter.

The following folder will be created at the root of your current working directory:

my-app
β”œβ”€β”€ webpack.config.js
β”œβ”€β”€ tsconfig.json
β”œβ”€β”€ README.md
β”œβ”€β”€ package.json
β”œβ”€β”€ jest.swc.config.js
β”œβ”€β”€ custom.d.ts
β”œβ”€β”€ .swcrc
β”œβ”€β”€ .gitignore
β”œβ”€β”€ .eslintrc.js
β”œβ”€β”€ .eslintignore
β”œβ”€β”€ .env
└── src
    β”œβ”€β”€ index.tsx
    β”œβ”€β”€ index.html
    β”œβ”€β”€ app.tsx
    β”œβ”€β”€ app.test.ts
    └── pages
        └── home
            β”œβ”€β”€ index.tsx
            β”œβ”€β”€ home.css
    └── components
        └── error-boundary
            β”œβ”€β”€ index.tsx
            β”œβ”€β”€ layout.tsx
        └── title
            β”œβ”€β”€ index.tsx
            β”œβ”€β”€ stories.tsx
     └── assets
        └── images
            β”œβ”€β”€ favicon.png
        └── svg
            β”œβ”€β”€ logo.svg
└── .storybook
    β”œβ”€β”€ main.js
    β”œβ”€β”€ preview.js

Once the application is created, type `cd my-app'.

COMMANDS

DEV: yarn|npm run dev

BUILD: yarn|npm run build

STORYBOOK: yarn|npm run storybook

TEST: yarn|npm run test

STORYBOOK

You must install Storybook globally: npm i -g @storybook/cli to use it.

CREDITS

DoneDeal0

SUPPORT

If you or your company is using the Alright React App, please show your support by buying me a coffee: https://www.buymeacoffee.com/donedeal0



CONTRIBUTING

Pull requests are welcome!