https://github.com/isan-rivkin/-react-saas-template
https://github.com/isan-rivkin/-react-saas-template
Last synced: 4 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/isan-rivkin/-react-saas-template
- Owner: Isan-Rivkin
- License: mit
- Created: 2022-06-08T14:27:29.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2023-03-03T05:07:57.000Z (almost 3 years ago)
- Last Synced: 2023-03-03T22:02:45.713Z (almost 3 years ago)
- Language: JavaScript
- Size: 3.05 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 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**](https://reactsaastemplate.com)
[](https://github.com/prettier/prettier)
[
](https://reactsaastemplate.com "Go to demo website")
## 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
1. Clone the repository
```
git clone https://github.com/dunky11/react-saas-template
```
2. Install dependencies, this can take a minute
```
cd react-saas-template
npm install
```
3. 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](https://www.youtube.com/results?search_query=react+tutorial) first.
If you know React, then most of the information you need is in the [Material-UI documentation](https://material-ui.com/getting-started/usage/).
You can go into [src/theme.js](/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 satisfied 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.
## Built With
* [Create-React-App](https://github.com/facebook/create-react-app) - Used to bootstrap the development
* [Material-UI](https://github.com/mui-org/material-ui) - Material Design components
* [React-Router](https://github.com/ReactTraining/react-router) - Routing of the app
* [Pace](https://github.com/HubSpot/pace) - Loading bar at the top
* [Emoji-Mart](https://github.com/missive/emoji-mart) - Picker for the emojis
* [React-Dropzone](https://github.com/react-dropzone/react-dropzone) - File drop component for uploads
* [Recharts](https://github.com/recharts/recharts) - Charting library I used for the statistics
* [Aos](https://github.com/michalsnik/aos) - Animations based on viewport
* [React-Cropper](https://github.com/roadmanfong/react-cropper) - Cropper for the image uploads
* [React-Stripe-js](https://github.com/stripe/react-stripe-js) - Stripes payment elements
## Contribute
Show your support by ⭐ the project. Pull requests are always welcome.
## License
This project is licensed under the MIT License - see the [LICENSE.md](https://github.com/dunky11/react-saas-template/blob/master/LICENSE) file for details.