Repository files navigation

Opinionated React starter template using TypeScript, Redux, React Router, Redux Saga, SCSS, PostCSS and more, offering PWA and offline capabilities and many more.

In order to use this setup you need to have installed the following dependencies:

1. Node - min v8.15.0
2. NPM - min v5.6.0or
3. Yarn - min v1.3.2
4. Bash terminal (Default on OSX/Linux, GitBash or similar on Windows)

npx create-react-app-ts&& yarn&& yarn start

Just a quick note: You should manually create a.gitignore file if you plan on keeping your project in Git.

You can download this setupdirectly and extract it.

Then navigate to thereact-template-ts folder and proceed with the rest of the instructions.

yarn# ornpm i

yarn start# ornpm start

yarn build# ornpm run build

yarn lint# ornpm run lint

yarntest# ornpm runtest

1. Folder structure:

   📦 project┣ 📂 assets - all fonts, images, videos, translation files, etc┣ ┣ 📂 locale - all translations┣ ┣ 📂 styles - all shared stylesheets┃ ┃ ┗ 📜 app.scss - Application's global SCSS entry point┃ ┃ ┗ 📜 mixins.scss - Application's SCSS mixins┃ ┃ ┗ 📜 functions.scss - Application's SCSS functions┃ ┃ ┗ 📜 settings.scss - Application's SCSS settings (variables, etc)┣ 📂 components - stateless components┣ 📂 containers - statefull components. Each container can export more than one component. An example folder structure is included in (`src/containers/.boilerplate`)┣ 📂 i18n - configuration settings for i18n (internationalization)┣ 📂 store - The application Redux store┣ ┣ 📂 branches - all store branches┣ ┣┣ ┣ 📂 $BRANCH - A branch in the Redux store┃ ┃ ┃ ┗ 📜 enums.ts - Each branch has its own enums┃ ┃ ┃ ┗ 📜 interfaces.ts - Each branch has its own interfaces┃ ┃ ┃ ┗ 📜 reducer.ts - The branch reducer┃ ┃ ┃ ┗ 📜 selectors.ts - The branch selectors (hooks)┃ ┃ ┃ ┗ 📜 sagas.ts - The branch sagas┃ ┗ 📜 enums.ts - Store's enums┃ ┗ 📜 index.ts - Application's main store┃ ┗ 📜 interfaces.ts - Store's interfaces┃ ┗ 📜 root-reducer.ts - Application's root reducer┃ ┗ 📜 sagas.ts - Application's sagas┣ 📂 utilities - helpers and utility functions┗ 📜 app.tsx - Application's main component┗ 📜 custom.d.ts - Custom type definitions┗ 📜 index.html - Application's HTML file┗ 📜 index.tsx - The main entry point┗ 📜 loadables.tsx - Code split and lazy loaded components

2. Latest EcmaScript support

   • Usage of the latest features in EcmaScript
   • UsingTypeScript to transpile to ES5
   • Minification of the bundled file
   • Source maps

3. Aliases: Checkout the aliases property in thevite.config.ts andtsconfig.json files.

4. SCSS usage.

5. Lint your files: ESLint (with TypeScript ESLint installed and configured) and Stylelint included

6. Tests using Jest and React testing library. The Test environment has been configured so you don't have to

7. PWA ready - Install as a native app on Android and iOS

8. Code splitting and lazy loading

9. i18n included:

   1. add your locales in/src/i18n/locales
   2. add your po files which are based on thetranslations.pot file located in/src/assets/locale
   3. runyarn locale to generate${locale}.json file from your${locale}.po file.
   4. update your UI to reflect the newly added locale

10. Prerendering - All pages are prerendered based on defined routes. This is included in the build step and needsno additional configuration.

This setup usesBrowserslist to target browsers.

The default list of supported browsers is listed in thepackage.json file:

{"browserslist": ["> 1%","last 2 versions"]}

This means that supported browsers vary based on current usage data and current browser versions.

In general, this setup supports the two most recent versions of all browsers.

The start template contains a ready-to-use auth flow with Login, Logout, Sign up and Forgotten password forms with validation included. The auth flow includes also route guarding and redirects based on auth status. Please take a look at the/src/containers/auth folder for more details.

The starting files also include ready-to-use layout components such asHeader,Footer,Wrapper,Button,Icon and formFields.

MIT