Skeleton for React & Redux Apps written in TypeScript (with integrated SASS, ESLint, Prettier, and Husky)
This project was bootstrapped with Create React App, using the Redux and Redux Toolkit template.
-
Frontend-reactjs is an typescript boilerplate which is basically a set of web pages, built with HTML, CSS, and Javascript or any javascript libraries (in our case ReactJS in conjunction with typescript) used to create a quick start boilerplate web application. In this we using SEO stratergy to improve the visibility of the website,Implemented Localization,with auth-guard we have provided authentication,Integrated redux-toolkit,and quick start
-
ReactJS improves performance due to virtual DOM. The DOM is a cross-platform and programming API which deals with HTML, XML or XHTML. Most of the developers faced the problem when the DOM was updated, which slowed down the performance of the application. ReactJS solved this problem by introducing virtual DOM.
-
ReactJS is choosen by most of the web developers. It is because it offers a very rich JavaScript library. The JavaScript library provides more flexibility to the web developers to choose the approch they want to follow.
Take it for a test drive. We'd love to hear any feedback you have or if you've thought of a new feature.
- With this boilerplate, you can easily quick start a react boilerplate using Reactjs.
- Rather than spending time on the project setup, get on with the important stuff right away.
- Features
- Getting started
- Project Structure
- Documentation
- Miscellaneous
- Trainings
- Video Tutorials
- Contributing To This Project
- Stay in touch
- Quick start
- Integrated ESLint, Prettier and Husky
- Simple and Standard scaffolding
- Production-Ready Skeleton
- Common Error Handler
- Auth Guard
- Localization
- SEO stratergy
- Next generation Sass
- Form Validation Using Regex
- Testing: unit and integration tests using Jest
- Environment variables: segregated env files for easier variable management.
- CI: Continuous integration
- Docker support
- Git hooks: with husky
- Linting: with ESLint and Prettier
Makes easier to write good redux applications and speeds up development.
- Node https://nodejs.org/en/ use the LTS version
- NPM
Use template strings, object destructuring, arrow functions, Interfaces, JSX syntax and more.
// clone the application
$ git clone https://github.com/NeoSOFT-Technologies/frontend-reactjs// Install the required npm modules
$ npm installThe env file should be placed in root folder with the following variables.
.env: Default Environment File.env.test: Test Environment File.env.production: Production Environment File.env.staging: Staging Environment File
# .env example
PORT= <port_no_for_application>
REACT_APP_API_BASEURL=<backend_api_base_url>
REACT_APP_CDN_URL=/global
REACT_APP_IMAGES_CDN_URL=<baseurl_where_images_is_situated>
REACT_APP_HOST=<frontend_api_base_url>
# development
$ npm run start
# production mode
$ npm run start:prodFor this project, We chose Jest as our test framework.
# unit tests
$ npm run test
# test coverage
$ npm run test:coverageAll the different build steps are orchestrated via npm scripts.
Npm scripts basically allow us to call (and chain) terminal commands via npm.
This is nice because most JavaScript tools have easy to use command line utilities allowing us to not need grunt or gulp to manage our builds.
If you open package.json, you will see a scripts section with all the different scripts you can call.
To call a script, simply run npm run <script-name> from the command line.
You'll notice that npm scripts can call each other which makes it easy to compose complex builds out of simple individual build scripts.
Below is a list of all the scripts this template has available:
| Npm Script | Description |
|---|---|
start |
Start project in development mode |
start:prod |
this script runs project in production mode |
build |
Full build. Runs ALL build tasks |
clean |
On Run clean the installed node packages |
clean:cdn |
On Run clean css from build |
build:prod |
Runs build and build:css together |
test |
Runs tests using Jest test runner |
eject |
Runs react-scripts eject |
format |
Runs prettier roles on project files |
test:coverage |
Gives the code coverage infrom to table |
lint |
Runs ESLint on project files |
lint:fix |
Runs lint and fix the resolve able errors |
lint:quiet |
Run lint to show errors only |
prepare |
install husky |
precommit |
Runs lint:fix and format before commit |
prepush |
Runs lint before push |
Node Modules folder is the repository of modules/library which you are using inside your project. What ever you are importing in your project that module or library should present inside the mode_module folder.When you do npm install that time that module or the library install inside the node_module folder and one entry added in package.json file. In your case frontend and backend are different project than obviously there will be 2 different node_modules folder for each of them. To check the list of modules used by us in this boilerplate click here
| Name | Description |
|---|---|
| wiki/ | You can add project documentation and insructions file here |
| src | Contains your source code that will be compiled to the build dir |
| src/components/ | UI Components |
| src/pages/ | We can also call this "features" if we break the pages based on what will be served in the browser |
| src/resources/ | Constant Variables such as images and strings |
| src/routes/ | Routing Configuration |
| src/store/ | Contains slice and hooks |
| src/store/${page-name}/slice.ts | Contains slice configuration {state, action and reducers} |
| src/store/index.ts | Entry point for store configuration |
| src/styles/ | SASS styles |
| src/types/ | Schema or Types |
| src/utils/ | Reusable utlity like api http client |
| src/index.ts | Entry point to your frontend app |
| package.json | File that contains npm dependencies |
| tsconfig.json | Config settings for compiling server code written in TypeScript |
| .eslintrc.json | Config settings for ESLint code style checking |
| .eslintignore | Config settings for paths to exclude from linting |
| prettierrc.json | Config settings for Prettier code format checking |
| .prettierignore | Config settings for paths to exclude from formatting |
| .vscode | Contains VS Code specific settings |
| .github | Contains GitHub settings and configurations, including the GitHub Actions workflows |
| .husky | Contains Husky settings and configurations |
| build | Contains the distributable (or output) from your TypeScript build. This is the code you ship |
| node_modules | Contains all your npm |
| dependencies |
Below is the basic flow for setting up the store and slice and using them in components. The official documentation can be found here if you would like more information.
graph TD;
A1[UI]--Main Component connected via Provider-->B1[Create Store and Define Root State and Dispatch Types];
A1-->A2[Landing Page Component];
B1--configureStore, RootState and AppDispatch-->C1[Define Typed Hooks];
C1--useAppDispatch and useAppSelector-->D1[Application Usage];
D1--createSlice-->E1[Define Slice State and Action Types]
E1--landing-->F1[name]
E1--initialState-->G1[State]
E1--extraReducers-->H1[reducers]
E1-->I1[Actions]
I1-->i1[pending]
I1-->i2[fulfilled]
I1-->i3[rejected]
E1-->J1[Middleware]
E1-->K1[Enitity Adapter]
E1--Add Slice Reducers to the Store-->B1
H1-->H2[Export Reducers]
H2--Use Typed Hooks in Components-->A2
- Eslint
- Axios
- Env
- Husky
- i18next
- Prettier
- React-Dom
- React-router-dom
- React-redux
- React-script
- React-toastify
- Redux-mock-store
- Redux-toolkit
- Testing
- Tyescript
- react-helmet
- Plop
- Concepts
- Getting started /Installation
- How to create components
- Redux Toolkit Flow of implementation
- Unit Test cases and its implementation(jest)
- Unit Test cases and its implementation(axios-mock-adaptor)
- API Factory
- i18next implementation
- Auth Guard Strategy
- SEO Strategy
- Project walkthrough
- Auth Guard Strategy
- SEO Strategy
- How to create a component
- Jest Testing
- Axios mock adapter
- Redux toolkit
Contributions are welcome from anyone and everyone. We encourage you to review the guiding principles for contributing
- Website - https://www.neosofttech.com/
- Twitter - @neosofttech
- Meetup - https://www.meetup.com/neosoft-technologies/
- Medium - https://medium.com/@neosofttech-technologies-blog
- GitHub - https://github.com/NeoSOFT-Technologies
- Discord - ReactJS