Skip to content

Commit 329c4bf

Browse files
app-generatorapp-generator
committed
Import v1.0.3
1 parent 869040b commit 329c4bf

117 files changed

Lines changed: 22453 additions & 1 deletion

File tree

Some content is hidden

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

‎.dockerignore‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
**/node_modules
2+
**/npm-debug.log
3+
build

‎.gitignore‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
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+
8+
# testing
9+
/coverage
10+
11+
# production
12+
/build
13+
14+
# misc
15+
.DS_Store
16+
.env.local
17+
.env.development.local
18+
.env.test.local
19+
.env.production.local
20+
21+
npm-debug.log*
22+
yarn-debug.log*
23+
yarn-error.log*
24+
/.idea/
25+
26+
.env

‎.prettierrc‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
{
2+
"bracketSpacing": true,
3+
"printWidth": 140,
4+
"singleQuote": true,
5+
"trailingComma": "none",
6+
"tabWidth": 4,
7+
"useTabs": false
8+
}

‎CHANGELOG.md‎

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
# Change Log
2+
3+
## [v1.0.3] 2022-11-13
4+
### Improvements
5+
6+
- Added `deployer` file
7+
- Used by AppSeed [Go-LIVE](https://appseed.us/go-live/) service
8+
9+
## [v1.0.2] 2022-11-08
10+
### Improvements
11+
12+
- Save Compat matrix in `package.json`
13+
- `build` node
14+
- Yarn, NPM
15+
- NodeJS versions
16+
17+
## [1.0.1] 2022-11-05
18+
### Improvements
19+
20+
- Added `env.sample`
21+
- `API_URL` can be specified in `env` (optional)
22+
- data used in `src/config.js`
23+
24+
## [1.0.0] 2022-11-05
25+
### Improvements
26+
27+
- `Update DOCS` (README)
28+
- Added `compatibility matrix` for Node, yarn & NPM
29+
- Testing tool: [Render API Wrapper](https://github.com/app-generator/deploy-automation-render)
30+
31+
## [0.0.5] 2021-07-09
32+
### Added Docker Support
33+
34+
- Usage documented in the README - new files:
35+
- Dokerfile
36+
- docker-compose.yml
37+
38+
## [0.0.4] 2021-07-09
39+
### Minor Update
40+
41+
- Code & Links cleanUp
42+
43+
## [0.0.3] 2021-07-08
44+
### Improvements
45+
46+
- Isolate API URL in config. Impacted files:
47+
- `src/config.js`
48+
- `src/layout/.../ProfileSection/index.js`
49+
- `src/views/pages/auth/.../RestLogin.js`
50+
- `src/views/pages/auth/.../RestRegister.js`
51+
52+
## [0.0.2] 2021-07-08
53+
### Added JWT Authentication
54+
55+
- JWT Auth: login/register/logout
56+
57+
## [0.0.1] 2021-07-01
58+
### Initial import
59+
60+
- UI: Berry v1.3.0 (free version)
61+

‎Dockerfile‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# pull official base image
2+
FROM node:14-alpine
3+
4+
# set working directory
5+
WORKDIR /app
6+
7+
# add `/app/node_modules/.bin` to $PATH
8+
ENV PATH /app/node_modules/.bin:$PATH
9+
10+
# install app dependencies
11+
COPY package.json ./
12+
RUN npm install --silent
13+
RUN npm install react-scripts@4.0.0 -g --silent
14+
15+
# add app
16+
COPY . ./
17+
18+
# Expose port
19+
EXPOSE 3000
20+
21+
# start app
22+
CMD ["npm", "start"]

‎LICENSE.md‎

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# MIT License
2+
3+
Copyright (c) 2019 - present [CodedThemes](https://codedthemes.com/) / [AppSeed](http://appseed.us/)
4+
5+
<br />
6+
7+
## Licensing Information
8+
9+
<br />
10+
11+
| Item | - |
12+
| ---------------------------------- | --- |
13+
| License Type | MIT |
14+
| Use for print | **YES** |
15+
| Create single personal website/app | **YES** |
16+
| Create single website/app for client | **YES** |
17+
| Create multiple website/apps for clients | **YES** |
18+
| Create multiple SaaS applications | **YES** |
19+
| End-product paying users | **YES** |
20+
| Product sale | **YES** |
21+
| Remove footer credits | **YES** |
22+
| --- | --- |
23+
| Remove copyright mentions from source code | NO |
24+
| Production deployment assistance | NO |
25+
| Create HTML/CSS template for sale | NO |
26+
| Create Theme/Template for CMS for sale | NO |
27+
| Separate sale of our UI Elements | NO |
28+
29+
<br />
30+
31+
---
32+
For more information regarding licensing, please contact the AppSeed Service < *support@appseed.us* >

‎README.md‎

Lines changed: 180 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,180 @@
1-
# react-berry-dashboard
1+
# [React Berry Dashboard](https://appseed.us/product/berry-dashboard/api-server-nodejs/react/)
2+
3+
**Berry** is a creative **[React Dashboard](https://appseed.us/product/berry-dashboard/api-server-nodejs/react/)** built using the `Material-UI`. It is meant to be the best User Experience with highly customizable feature-riched pages. It is a complete game-changer **React Dashboard** with an easy and intuitive responsive design as on retina screens or laptops. The product comes with a simple JWT authentication flow: `login`/`register`/`logout` powered by an open-source **Node JS API** Backend via `Passport` Library.
4+
5+
- 👉 [React Node JS Berry](https://appseed.us/product/berry-dashboard/api-server-nodejs/react/) - product page
6+
- 👉 [React Node JS Berry](https://react-node-js-berry-dashboard.appseed-srv1.com/) - LIVE Demo
7+
8+
<br />
9+
10+
> 🚀 Built with **[React App Generator](https://appseed.us/generator/react/)**
11+
12+
- ✅ Modern aesthetics UI design - Designed by *CodedThemes*
13+
- ✅ React, Redux, Redux-persist
14+
- ✅ Authentication: JWT Login/Register/Logout
15+
- ✅ **Full-stack Ready** using a **Node JS API Server** (open-source project) - Server Features
16+
- `Typescript` / SQLite Persistence / TypeORM / Joy (validation)
17+
- Passport library - `passport-jwt` strategy.
18+
19+
![React Nodejs Berry - Open-source full-stack seed project crafted by CodedThemes and AppSeed.](https://user-images.githubusercontent.com/51070104/176936514-f1bccb21-bafe-4b43-9e4c-b6fe0ec9511d.png)
20+
21+
<br />
22+
23+
## Tests
24+
25+
> `Compatibility matrix` tested with [Render API Wrapper](https://github.com/app-generator/deploy-automation-render).
26+
27+
| NodeJS | NPM | YARN |
28+
| --- | --- | --- |
29+
| `v14.0.0` | ✅ | ✅ |
30+
| `v16.0.0` | ✅ | ✅ |
31+
| `v18.0.0` | ❌ | ❌ |
32+
33+
<br />
34+
35+
## Quick Start in [Docker](https://www.docker.com/)
36+
37+
> Get the code
38+
39+
```bash
40+
$ git clone https://github.com/app-generator/react-berry-dashboard.git
41+
$ cd react-berry-dashboard
42+
```
43+
44+
> Start the app in Docker
45+
46+
```bash
47+
$ docker-compose pull # download dependencies
48+
$ docker-compose build # local set up
49+
$ docker-compose up # start the app
50+
```
51+
52+
The React UI starts on port `3000` and expects an API server on port `5000` (saved in configuration).
53+
54+
<br />
55+
56+
> **Note**: This product can be used with other API Servers for a complete full-stack experience. **ALL API servers use a unified interface**
57+
58+
- [Django API Server](https://github.com/app-generator/api-server-django) - open-source product
59+
- [Flask API Server](https://github.com/app-generator/api-server-flask) - open-source product
60+
- [Node JS API Server](https://github.com/app-generator/api-server-nodejs) - open-source product / Typescript / SQLite / TypeORM / Joy for validation
61+
- [Node JS API Server PRO](https://github.com/app-generator/api-server-nodejs-pro) - **commercial product**
62+
- Typescript / SQLite / TypeORM / Joy Validation / Docker
63+
- Typescript / MongoDB / Mongoose / Joy Validation / Docker (separate branch, same project)
64+
65+
<br />
66+
67+
## How to use it
68+
69+
To use the product Node JS (>= 12.x) is required and GIT to clone/download the project from the public repository.
70+
71+
**Step 1** - Clone the project
72+
73+
```bash
74+
$ git clone https://github.com/app-generator/react-berry-dashboard.git
75+
$ cd react-berry-dashboard
76+
```
77+
78+
<br >
79+
80+
**Step 2** - Install dependencies via NPM or yarn
81+
82+
```bash
83+
$ npm i
84+
// OR
85+
$ yarn
86+
```
87+
88+
<br />
89+
90+
**Step 3** - Start in development mode
91+
92+
```bash
93+
$ npm run start
94+
// OR
95+
$ yarn start
96+
```
97+
98+
<br />
99+
100+
## Configure the backend server
101+
102+
The product comes with a usable JWT Authentication flow that provides only the basic requests: login/logout/register.
103+
104+
**API Server URL** - `src/config/constant.js`
105+
106+
```javascript
107+
const config = {
108+
...
109+
API_SERVER: 'http://localhost:5000/api/' // <-- The magic line
110+
};
111+
```
112+
113+
<br />
114+
115+
**API Server Descriptor** - POSTMAN Collection
116+
117+
The API Server signature is provided by the [Unified API Definition](https://docs.appseed.us/boilerplate-code/api-unified-definition)
118+
119+
- [API POSTMAN Collection](https://github.com/app-generator/api-server-unified/blob/main/api.postman_collection.json) - can be used to mock (simulate) the backend server or code a new one in your preferred framework.
120+
121+
<br />
122+
123+
## Node JS API Server
124+
125+
The product is also open-source and is already configured to work with Berry Dashboard Template - product features:
126+
127+
- Typescript / `NodeJS` / `Express` Server
128+
- JWT authentication (`passport-jwt` strategy)
129+
- Persistence: `SQLite` / `TypeORM`
130+
131+
> Links
132+
133+
- [Node JS API](https://github.com/app-generator/api-server-nodejs) - source code
134+
- [Node JS API](https://appseed.us/boilerplate-code/nodejs-starter) - product page
135+
136+
<br />
137+
138+
![Node JS API - Open-source API server built on top of Express Nodejs Framework.](https://user-images.githubusercontent.com/51070104/124934824-c210a700-e00d-11eb-9d01-e05bd8bfb608.png)
139+
140+
<br />
141+
142+
### Compile the API Server
143+
144+
**Step 1** - Clone the project
145+
146+
```bash
147+
$ git clone https://github.com/app-generator/api-server-nodejs.git
148+
$ cd api-server-nodejs
149+
```
150+
151+
**Step #2** - Install dependencies via NPM or Yarn
152+
153+
```bash
154+
$ npm i
155+
// OR
156+
$ yarn
157+
```
158+
159+
**Step 3** - Run the SQLite migration via TypeORM
160+
161+
```
162+
$ npm run typeorm migration:run
163+
// OR
164+
$ yarn typeorm migration:run
165+
```
166+
167+
**Step 4** - Start the API server (development mode)
168+
169+
```bash
170+
$ npm run dev
171+
// OR
172+
$ yarn dev
173+
```
174+
175+
The API server will start using the `PORT` specified in `.env` file (default 5000).
176+
177+
<br />
178+
179+
---
180+
[React Berry Dashboard](https://appseed.us/product/berry-dashboard/api-server-nodejs/react/) - Provided by [CodedThemes](https://codedthemes.com/) and **AppSeed [App Generator](https://appseed.us/generator)**.

‎deployer.json‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
{
2+
"api-server":"https://api-server-nodejs.appseed.us/api/",
3+
"name":"react-berry-dashboard",
4+
"framework": "react",
5+
"type": "static"
6+
7+
}

‎docker-compose.yml‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
version: '3.7'
2+
3+
services:
4+
5+
sample:
6+
container_name: react-berry
7+
build:
8+
context: .
9+
dockerfile: Dockerfile
10+
volumes:
11+
- '.:/app'
12+
- '/app/node_modules'
13+
ports:
14+
- 3000:3000
15+
environment:
16+
- CHOKIDAR_USEPOLLING=true
17+

‎env.sample‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
REACT_APP_BACKEND_SERVER='https://YOUR_API_URL/';

0 commit comments

Comments
 (0)