https://github.com/onlineeric/eric-react-template

https://github.com/onlineeric/eric-react-template

Last synced: 6 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/onlineeric/eric-react-template
• Owner: onlineeric
• Created: 2024-02-19T04:03:01.000Z (over 2 years ago)
• Default Branch: master
• Last Pushed: 2024-03-14T05:58:37.000Z (over 2 years ago)
• Last Synced: 2024-03-14T06:42:01.993Z (over 2 years ago)
• Language: TypeScript
• Size: 1.17 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# Eric React Template

This is an enhanced React Typescript template, initially based on the [MUI Free Dashboard Template](https://github.com/mui/material-ui/tree/v5.15.12/docs/data/material/getting-started/templates/dashboard). 

![React](https://img.shields.io/badge/-React-61DAFB?logo=react&logoColor=white&style=flat)

![TypeScript](https://img.shields.io/badge/-TypeScript-007ACC?logo=typescript&logoColor=white&style=flat)

![Redux](https://img.shields.io/badge/-Redux-764ABC?logo=redux&logoColor=white&style=flat)

![Material-UI](https://img.shields.io/badge/-Material--UI-0081CB?logo=material-ui&logoColor=white&style=flat)

![GitHub](https://img.shields.io/badge/-GitHub-181717?logo=github&logoColor=white)

![Azure](https://img.shields.io/badge/-Azure-0089D6?logo=microsoft-azure&logoColor=white)

## Added features

- Side Panel app page routing

- React Redux store for state management

- A basic login page

- MUI Theme implementation with light and dark mode switching

## Getting Started

To use this template, you can either download it directly or clone the repository from [here](https://github.com/onlineeric/eric-react-template.git).

Once you have the template, follow these steps to get it up and running:

```bash

yarn install  # Install the necessary dependencies

yarn start    # Start the development server

```

## About this template

This template uses Material UI with [Create React App](https://github.com/facebookincubator/create-react-app) in [TypeScript](https://github.com/Microsoft/TypeScript). It includes several key packages:

- `@mui/material`: Material UI's core components

- [Emotion](https://emotion.sh/docs/introduction): The default style engine in Material UI v5

- [React-Redux](https://react-redux.js.org/): A state management tool that allows for efficient data flow in your application

- [ESLint](https://eslint.org/): A tool for identifying and reporting on patterns in JavaScript

- [Prettier](https://prettier.io/): An opinionated code formatter

These packages, along with their peer dependencies, are all included, providing a robust foundation for your React project.

ESLint and Prettier are integrated to ensure consistent code formatting and to help identify potential issues early in the development process.

## The idea behind the template

In my demo project, available on [my Github page](https://github.com/onlineeric), I aim to use a React Single Page App as the UI to showcase my skills.

This template serves as a base from which I plan to add more features. It's an ideal starting point for any new React project.

## Demo Site

You can view a live demo of a project built using this template at my [Eric React Template Demo](https://proud-ground-0f99e0a00.5.azurestaticapps.net/)

Here's a screenshot of the demo site:

![Demo Site Screenshot](public/Eric%20React%20Template%20-%20screenshot.png)