Skip to content

Latest commit

 

History

History
112 lines (84 loc) · 2.98 KB

README.md

File metadata and controls

112 lines (84 loc) · 2.98 KB
Raw

An out-of-box UI solution for enterprise applications as a React boilerplate.

Demo · Report Bug · Request Feature

Preview
Shadow

Features

  • Elegant and customizable UI using Tailwindcss and Ant Design.
  • Single page application using React Router.
  • Mock API request using reqres.
  • Powerful layout and table using @ant-design/pro-components.
  • Code splitting and lazy loading component using @loadable/component.
  • State management using react-redux and @reduxjs/toolkit.
  • Persistent redux state using redux-persist.
  • Loading progress bar using nprogress.
  • ESLint and Prettier enabled.
  • Option to enable Progressive Web App (PWA). (Only available in production build)
  • Axios interceptor enabled to handle API authorization.
  • Automated workflow for checking new Pull Request.

Demo

https://reforge.netlify.app

Credentials

Usage

  • Clone the project and change directory.

    git clone https://github.com/arifszn/reforge.git
cd reforge

  • Install dependencies.

    npm install

  • Run dev server.

    npm run dev

  • Finally, visit http://localhost:5173 from your browser. Credentials can be found above.

Config

Settings including app name, theme color, meta tags, etc. can be controlled from one single file config.ts located at the project's root.

//config.ts
const CONFIG = {
  appName: 'Reforge',
  enablePWA: true,
  theme: {
    accentColor: '#818cf8',
    sidebarLayout: 'mix',
    showBreadcrumb: true,
  },
  metaTags: {
    title: 'Reforge',
    description:
      'An out-of-box UI solution for enterprise applications as a React boilerplate.',
    imageURL: 'logo.svg',
  },
};

export default CONFIG;

Support

You can show your support by starring this project. ★

Github Star

Contribute

To contribute, see the Contributing guide.

License

MIT