@rcdsoftware/cra-template-rcd-react v1.0.0

The RCD Software's Create-React-App Template allows for users to easily create React Apps with pre-installed that allow for many best practices and follows the philosophy of RCD Software. This template was originally developed for use in RCD Software react apps.

Quick Overview

Advanced Language Support

The template uses TypeScript and SASS for out-of-the-box advanced language support.

Pre-Configured Syntax Formatting

The template includes ESLint & Prettier configuration with common rules already implemented, though rules can be easily changed within the provided config files. In addition, the template includes Husky pre-commit hooks to automate the formatting prior to any commits.

Basic Styling Support

The template includes a deep and widely used CSS reset applied to allow for easier and more conistent styling through out the app. In addition MUI core package is installed by default to allow for quick utilization of the Material Design standard, this includes the use of Themes which has a basic implementation already provided.

Advanced File Structure

The template also includes a more fleshed out and advanced file structure then default create-react-apps. This file structure allows for more standardization across projects and is utilized extensively within RCD Software.

my-app
├── node_modules
├── public
│   ├── favicon.ico
│   ├── index.html
│   ├── manifest.json
│   └── robots.txt
├── src
│   ├── app
│   │   ├── assets
│   │   │   └── logo.svg
│   │   ├── components
│   │   ├── pages
│   │   └── services
│   │       └── validations
│   ├── App.scss
│   ├── App.tsx
│   ├── App.test.ts
│   ├── customTheme.ts
│   ├── index.scss
│   ├── index.tsx
│   ├── react-app-env.d.ts
│   ├── reportWebVitals.ts
│   └── setupTests.ts
├── .eslintignore
├── .eslintrc.js
├── .prettierignore
├── .prettierrc
├── .gitignore
├── package.json
├── README.md
└── tsconfig.json

Using the Template

Using our template is easy! Just like create any other Create-React-App you can use NPM / NPX to create the app with the name of your choice (replacing "my-app") and then specify the template.

npx create-react-app my-app --template rcd-react

Additional Recommended Libraries

Styles / Components

• RCD Software's MUI Extension

npm install rcd-mui-extension

• Material UI Lab

npm install @material-ui/lab

=== OR ===

yarn add @material-ui/lab

Icons

• MUI's Icon Library

npm install @material-ui/icons

=== OR ===

yarn add @material-ui/icons

• Font Awesome - (Install using directions provided on Docs)

Forms

• Formik

npm install formik --save

=== OR ===

yarn add formik

• RCD Software's MUI Extension w/ Formik

npm install rcd-mui-extension-formik

Validation

• Yup

npm install -S yup

State Management

• Redux

npm install @reduxjs/toolkit

=== OR ===

yarn add @reduxjs/toolkit

License

This project is licensed under the terms of the MIT license.