Skip to content
/ paper-and-ink Public template

An awesome Material Dashboard crafted with ReactJs based on Material UI’s components!

License

Notifications You must be signed in to change notification settings

georgesimos/paper-and-ink

Repository files navigation

Paper and Ink

ReactJs, Material-UI

GitHub license

Paper and Ink is a Free React Dashboard built with:

  • React - React is a JavaScript library for building user interfaces.
  • Material UI - React components for faster and easier web development.
  • Recharts - Redefined chart library built with React and D3.

Features

  • CSS-in-JS styles
  • Create-react-app under the hood
  • Material-UI v4
  • React v16
  • React Hooks
  • React Context
  • React Router Dom v5

Getting Started

clone the repository

$ git clone https://github.com/georgesimos/paper-and-ink.git myproject
$ cd myproject

Install the dependencies and devDependencies

$ npm install

Set environment variables

cp .env.example .env

Start the server

$ npm start

Pages

We have implemented some basic pages, so you can see our template in action.

  • Dashboard
  • Tables
  • Typography
  • Icons

Application Structure


├── public
│   └── images
│   └── favicon.ico
│   └── index.html
│   └── manifest.json
├── src
│   └── assets
│   └── components
│   └── layout
│   └── pages
│   └── routes
│   └── theme
│   └── App.js
│   └── App.test.js
│   └── history.js
│   └── index.js
│   └── serviceWorker.js
│   └── setupTests.js
├── .env.example
├── .eslintrc
├── .gitignore
├── .prettierrc
├── .CHANGELOG.md
├── .jsconfig.json
├── LICENSE
├── package.json
├── README.md
├── yarn.lock

Plugins

Paper and Ink is currently extended with the following plugins. Instructions on how to use them in your own application are linked below.

Plugin README
material-ui plugins/material-ui/README.md
testing-library plugins/testing-library/README.md
node-sass plugins/node-sass/README.md
react plugins/react/README.md
react-router plugins/react-router/README.md
recharts plugins/recharts/README.md
eslint plugins/eslint/README.md
prettier plugins/prettier/README.md
Screenshots

Basil Theme

Crane Theme

Material Theme

Material Dark Theme

Pinky Theme

Rally Theme

Reply Theme

License

MIT