https://github.com/heyjul3s/react-rtk

A ReactJS template with Redux Toolkit
https://github.com/heyjul3s/react-rtk

chakra-ui cypress eslint react redux redux-toolkit redux-toolkit-query typescript vitejs

Last synced: about 2 months ago
JSON representation

A ReactJS template with Redux Toolkit

• Host: GitHub
• URL: https://github.com/heyjul3s/react-rtk
• Owner: heyjul3s
• Created: 2021-10-12T11:27:29.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2022-06-25T04:48:15.000Z (over 2 years ago)
• Last Synced: 2023-03-03T21:44:30.880Z (almost 2 years ago)
• Topics: chakra-ui, cypress, eslint, react, redux, redux-toolkit, redux-toolkit-query, typescript, vitejs
• Language: TypeScript
• Homepage:
• Size: 646 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# React RTKQ

A React + Redux Toolkit PWA kit powered by ViteJS, Redux Toolkit, Chakra UI, Cypress and friends

At a glance:

| Dependency                                                          | Version |

| ------------------------------------------------------------------- | ------- |

| [react](https://reactjs.org/docs/getting-started.html)              | 18.2.0  |

| [@axe-core/react](https://www.npmjs.com/package/@axe-core/react)    | 4.4.3   |

| [@chakra-ui/react](https://chakra-ui.com/docs/getting-started)      | 2.2.1   |

| [typescript](https://www.typescriptlang.org/docs/)                  | 4.7.4   |

| [redux](https://redux.js.org/introduction/getting-started)          | 4.2.0   |

| [redux-thunk](https://github.com/reduxjs/redux-thunk)               | 2.4.1   |

| [@reduxjs/toolkit](https://redux-toolkit.js.org/api/configureStore) | 1.8.2   |

| [react-hook-form](https://react-hook-form.com)                      | 7.32.2  |

| [cypress](https://docs.cypress.io/)                                 | 10.1.0  |

Featuring

- New JSX transform. Learn more [here](https://reactjs.org/blog/2020/09/22/introducing-the-new-jsx-transform.html).

## Getting Started

The template is running on Yarn (Yarn v1 as v2 doesn't seem to compatible wit NextJS as of writing) and uses an **.nvmrc** file.

To get started:

- Run `nvm use` to ensure you're running the correct Node version

- Run `yarn` to install dependencies

- After dependencies have been installed, run `yarn dev` to get it up and running locally

## Scripts

| Script        | What it does                                                    |

| ------------- | --------------------------------------------------------------- |

| dev           | starts the application in development mode w/ lint concurrently |

| build         | creates an optimised production build of your application       |

| preview       | runs a preview                                                  |

| preview:https | runs a preview via https protocol                               |

| test:jest     | runs Jest tests                                                 |

For full list of scripts, please refer to the root package.json file

## File Structure

### Overall Structure

```

project

|   .babelrc

|   .eslintrc.js

|   .gitignore

|   .nvmrc

|   .prettierignore

|   prettier.config.js

|   package.json

|   README.md

└───requests

└───components

└───hooks

└───pages

└───store

└───theme

```