Skip to content

Latest commit

 

History

History
90 lines (70 loc) · 2.25 KB

README.md

File metadata and controls

90 lines (70 loc) · 2.25 KB
Raw

TS React Redux boilerplate

A React starter kit(based on create-react-app) that includes an already setup for routing(react-router) , state managment (Redux/thunk) , internationalization(i18n), theming (theme/Material UI), Http support(Axios) and a scalable file structure

Quick start

  1. Make sure that you have Node.js and npm are installed.
  2. Clone this repo using git clone https://github.com/medaymenTN/ts-react-redux-hooks-boilerplate.git
  3. Move to the appropriate directory: ts-react-redux-hooks-boilerplate
  4. Start your project using: npm run start

File Structure

├── README.md
├── node_modules
├── package.json
├── .gitignore
├── public
│ ├── favicon.ico
│ ├── index.html
│ └── manifest.json
└── src
| |__asssets
| | |__images
| |
| |__components
| |__containers
| |__i18n
| | |__locales
| | |__i18next.ts
| |__middlewares
| | |__middleware.ts
| |__routes
| | |__routes.ts
| |__store
| | |__UserStore
| | | |__action.enum.ts
| | | |__types.d.ts
| | | |__user.action.creators.ts
| | | |__user.action.ts
| | | |__user.reducer.ts
| | |
| | |__rootReducer.ts
| | |__store.ts
| | |__types.d.ts
| |
| |__helpers
| |__services(xhr)
├── App.css
├── App.js
├── App.test.js
├── index.css
├── index.js
└── serviceWorker.js
└── setupTests.js

Available Scripts

In the project directory, you can run:

npm run start

Runs the app in the development mode.
Open http://localhost:3000 to view it in the browser.

npm run test

Launches the test runner in the interactive watch mode.

npm run build

Builds the app for production to the build folder.
It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.
Your app is ready to be deployed!

npm run lint

ESLint command that lints all your files

npm run lint:fix

ESLint command that lints and fixes all your files

npm run format

Prettier command to format file with the option --write which is similar to the --fix option of ESLint. For example the following command formats every .ts or .tsx or .js or .jsx file located in a src folder