React SaaS Template

Remains of a SaaS business I once tried to build. Now transformed into a template for building an SaaS/admin application using React + Material-UI.

Check out the demo

Getting Started

Prerequisites

Node.js 12+ (versions below could work, but are not tested)

Linux:
```
sudo apt install nodejs npm
```
Windows or macOS:

https://nodejs.org/en/

Installing

Clone the repository

git clone https://github.com/dunky11/react-saas-template

Install dependencies, this can take a minute
```
cd react-saas-template
npm install
```
Start the local server
```
npm start
```

Your browser should now open and show the app. Otherwise open http://localhost:3000/ in your browser. Editing files will automatically refresh the page.

What to do next?

If you are new to React, you should watch a basic React tutorial first.

If you already know React, then most of the information you need is in the Material-UI documentation.

You can go into src/theme.js and change the primary and secondary color codes at the top of the script to the values you like and some magic will happen.

Deployment

If you are happy with the state of your website you can run:

npm run build

It will create a folder named build with your compiled project inside. After that copy its content into your webroot and you are ready to go.

Build With

Create-React-App - Used to bootstrap the development
Material-UI - Material Design components
React-Router - Routing of the app
Pace - Loading bar at the top
Emoji-Mart - Picker for the emojis
React-Dropzone - File drop component for uploads
Recharts - Charting library I used for the statistics
Aos - Animations based on viewport
React-Cropper - Cropper for the image uploads
React-Stripe-js - Stripes payment elements

Things im currently working on

Improving the encapsulation of components
Transforming class components into functional components, to be on a par with the Material-UI docs
smoothScrollTop() sometimes stops scrolling top when components with big height are still rendering
When a Dialog is opened there is a margin on the right side of the viewport (could be that this is not fixable without shaking the viewport on dialog open)
shadeColor() throws errors on certain color codes
Adding iDEAL, FBX and PaymentRequestButton to avaible payment methods

Contribute

Show your support by ⭐ the project.

License

This project is licensed under the MIT License - see the LICENSE.md file for details.

imaginarystargazer / react-saas-template Goto Github PK