README.md

React Admin Dashboard - mmCMS Demo

React Admin Dashboard - mmCMS Demo, is a ReactJS admin app built on top of an mmCMS demo API project. This project was bootstrapped with CoreUI React on top of Create React App. You can find the app in action here.

You can find documentation around installation and usage of mmCMS here

Table of Contents

• Development
• Build
• Technologies Used
• Versioning
• License

Development

# clone the repo
$ git clone https://github.com/thtg88/mmcms-demo-react-admin.git my-project

# go into app's directory
$ cd my-project

# install app's dependencies
$ npm install

In order for your mmCMS REST API to work you have to create a .env file containing a variable pointing to the base URL of your API e.g. REACT_APP_API_BASE_URL=https://api.domain.com/v1

# dev server with hot module replacement at http://localhost:3000
$ npm start

Navigate to http://localhost:3000. The app will automatically reload if you change any of the source files.

mmCMS Admin supports saving the Redux state on local storage. To enable that, add the following to your .env file REACT_APP_STATE_DRIVER=localStorage

Build

Run build to build the project. The build artifacts will be stored in the build/ directory.

# build for production with minification
$ npm run build

Technologies Used

• mmCMS Demo API
• ES6+
• Bootstrap with reactstrap
• FontAwesome Icons
• Google ReCaptcha v2 with react-google-recaptcha
• JSX
• React
  • Core UI Free React Admin Template
  • Create React App
  • Error Boundaries
  • Higher-Order Components
  • PropTypes
  • React Router
• Redux
  • Redux-Saga
• Sentry
• Webpack Hot Module Replacement
• Yup

Versioning

mmCMS Admin is maintained under the Semantic Versioning guidelines.

See the change-log of the project for changelogs for each release version.

License

Code released under the MIT license.