Skip to content

Commit 2aa1737

Browse files
committed
Merge dev to master
2 parents 504aaac + b8f0a93 commit 2aa1737

File tree

260 files changed

+12844
-9623
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

260 files changed

+12844
-9623
lines changed

.env

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
NODE_PATH=src/
2+
GENERATE_SOURCEMAP=false

.gitignore

Lines changed: 2 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,2 @@
1-
# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
2-
3-
# dependencies
4-
/node_modules
5-
/.pnp
6-
.pnp.js
7-
.idea/
8-
9-
# testing
10-
/coverage
11-
12-
# production
13-
/build
14-
15-
# misc
16-
.DS_Store
17-
.env.local
18-
.env.development.local
19-
.env.test.local
20-
.env.production.local
21-
22-
npm-debug.log*
23-
yarn-debug.log*
24-
yarn-error.log*
1+
/node_modules/
2+
/.idea/

.prettierrc

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
{
2+
"singleQuote": true,
3+
"tabWidth": 2,
4+
"trailingComma": "all",
5+
"quoteProps": "as-needed",
6+
"jsxSingleQuote": true,
7+
"bracketSpacing": true,
8+
"bracketSameLine": false,
9+
"arrowParens": "always"
10+
}

Dockerfile

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
FROM node:14
2+
3+
# Create app directory
4+
WORKDIR /usr/src/app
5+
6+
# Install app dependencies
7+
# A wildcard is used to ensure both package.json AND package-lock.json are copied
8+
# where available (npm@5+)
9+
COPY package*.json ./
10+
11+
RUN yarn install
12+
# If you are building your code for production
13+
# RUN npm ci --only=production
14+
15+
# Bundle app source
16+
COPY . .
17+
18+
EXPOSE 3000
19+
CMD [ "yarn", "start:backend" ]

README.md

Lines changed: 40 additions & 75 deletions
Original file line numberDiff line numberDiff line change
@@ -1,106 +1,71 @@
1-
# React Material Admin Full — Material-UI Dashboard Template
1+
# React Material Admin Full
22

3-
Built with [React](https://facebook.github.io/react/), [Material-UI](https://material-ui.com), [React Router](https://reacttraining.com/react-router/).
4-
**No jQuery and Bootstrap!**
3+
## This project was generated by Flatlogic Platform.
54

6-
**This version uses React 16.14.0, React Router v5, MaterialUI v4, built with React Hooks and React Context (No Redux)**
5+
## To start the project:
76

8-
[Demo](https://flatlogic.com/admin-dashboards/react-material-admin/demo). Use any credentials to log in.
7+
Install dependencies via npm or yarn
98

10-
[![image](https://user-images.githubusercontent.com/24964748/55800639-df780300-5adc-11e9-84b7-7c2437088516.png)](https://flatlogic.com/admin-dashboards/react-material-admin/demo)
9+
```shell
10+
npm install
11+
```
1112

12-
## Features
13+
```shell
14+
yarn
15+
```
1316

14-
- React (**16.14.0**)
15-
- React Hooks
16-
- React Context
17-
- **No jQuery and Bootstrap!**
18-
- Mobile friendly layout (responsive)
19-
- Create-react-app under the hood
20-
- React Router v5
21-
- Material-UI v4
22-
- Modular Architecture
23-
- CSS-in-JS styles
24-
- Styled Components
25-
- Webpack build
26-
- Stylish, clean, responsive layout
27-
- Authentication
17+
Run development server
2818

29-
## Pages
19+
```shell
20+
yarn start
21+
```
3022

31-
We have implemented some basic pages, so you can see our template in action.
23+
## Support
3224

33-
- Profile
34-
- Dashboard
35-
- E-commerce (Product Management, Products Grid, Product Page)
36-
- Typography
37-
- Tables (Static, dynamic)
38-
- Forms
39-
- Notifications
40-
- Charts
41-
- Icons
42-
- Maps
43-
- Login
44-
- Error
25+
For any additional information please refer to [Flatlogic homepage](https://flatlogic.com).
4526

46-
## Quick Start
27+
## To start the project with Docker:
4728

48-
#### 1. Get the latest version
29+
## Description:
4930

50-
You can start by cloning the latest version of React Dashboard on your
51-
local machine by running:
31+
The project contains the **docker folder** and the `Dockerfile`.
5232

53-
```shell
54-
$ git clone https://github.com/flatlogic/react-material-admin.git MyApp
55-
$ cd MyApp
56-
```
33+
The `Dockerfile` is used to Deploy the project to Google Cloud.
5734

58-
#### 2. Run `yarn install`
35+
The **docker folder** contains a couple of helper scripts:
5936

60-
This will install both run-time project dependencies and developer tools listed
61-
in [package.json](package.json) file.
37+
- `docker-compose.yml` (all our services: web, backend, db are described here)
38+
- `start-backend.sh` (starts backend, but only after the database)
39+
- `wait-for-it.sh` (imported from https://github.com/vishnubob/wait-for-it)
6240

63-
#### 3. Run `yarn start`
41+
> To avoid breaking the application, we recommend you don't edit the following files: everything that includes the **docker folder** and `Dokerfile`.
6442
65-
Runs the app in the development mode.
43+
## Run services:
6644

67-
Open http://localhost:3000 to view it in the browser. Whenever you modify any of the source files inside the `/src` folder,
68-
the module bundler ([Webpack](http://webpack.github.io/)) will recompile the
69-
app on the fly and refresh all the connected browsers.
45+
1. Install docker compose (https://docs.docker.com/compose/install/)
7046

71-
#### 4. Run `yarn build`
47+
2. Move to `docker` folder. All next steps should be done from this folder.
7248

73-
Builds the app for production to the build folder.
74-
It correctly bundles React in production mode and optimizes the build for the best performance.
49+
`cd docker`
7550

76-
The build is minified and the filenames include the hashes.
77-
Your app is ready to be deployed!
51+
3. Make executables from `wait-for-it.sh` and `start-backend.sh`:
7852

79-
## Support
53+
`chmod +x start-backend.sh && chmod +x wait-for-it.sh`
8054

81-
For any additional information please refer to [Support forum](https://flatlogic.com/forum).
55+
4. Download dependend projects for services.
8256

83-
## How can I support developers?
57+
5. Review the docker-compose.yml file. Make sure that all services have Dockerfiles. Only db service doesn't require a Dockerfile.
8458

85-
- Star our GitHub repo :star:
86-
- [Tweet about it](https://twitter.com/intent/tweet?text=Amazing%20dashboard%20built%20with%20NodeJS,%20React%20and%20Bootstrap!&url=https://github.com/flatlogic/react-material-template&via=flatlogic).
87-
- Create pull requests, submit bugs, suggest new features or documentation updates :wrench:
88-
- Follow [@flatlogic on Twitter](https://twitter.com/flatlogic).
89-
- Subscribe to Flatlogic newsletter at [flatlogic.com](https://flatlogic.com/)
90-
- Like our page on [Facebook](https://www.facebook.com/flatlogic/) :thumbsup:
59+
6. Make sure you have needed ports (see them in `ports`) available on your local machine.
9160

92-
## More from Flatlogic
61+
7. Start services:
9362

94-
- [React Native Starter](https://github.com/flatlogic/react-native-starter) - 🚀 A powerful react native starter template that bootstraps development of your mobile application
95-
- [Sing App](https://github.com/flatlogic/sing-app) - 💥 Free and open-source admin dashboard template built with Bootstrap 4
96-
- [Awesome Bootstrap Checkboxes & Radios](https://github.com/flatlogic/awesome-bootstrap-checkbox) - ✅ Pure css way to make inputs look prettier
97-
- [React Dashboard](https://github.com/flatlogic/react-dashboard) - 🔥 React Dashboard - isomorphic admin dashboard template with GraphQL
98-
- [Light Blue Dashboard](https://github.com/flatlogic/light-blue-dashboard) - 💦 Free and open-source admin dashboard template built with Bootstrap
63+
7.1. With an empty database `rm -rf data && docker-compose up`
9964

100-
## Premium themes
65+
7.2. With a stored (from previus runs) database data `docker-compose up`
10166

102-
Looking for premium themes and templates? Check out more [admin dashboard templates at flatlogic.com](https://flatlogic.com/admin-dashboards).
67+
8. Check http://localhost:3000
10368

104-
## License
69+
9. Stop services:
10570

106-
[MIT](https://github.com/flatlogic/react-material-dashboard/blob/master/LICENSE.txt).
71+
9.1. Just press `Ctr+C`

babel.config.js

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,7 @@
11
module.exports = {
2-
"presets": [
3-
"react-app"
4-
],
5-
"plugins": [
6-
"@babel/plugin-proposal-class-properties",
7-
"@babel/plugin-proposal-optional-chaining"
8-
]
9-
};
2+
presets: ['react-app'],
3+
plugins: [
4+
'@babel/plugin-proposal-class-properties',
5+
'@babel/plugin-proposal-optional-chaining',
6+
],
7+
};

0 commit comments

Comments
 (0)