You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+42-28Lines changed: 42 additions & 28 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,12 +10,10 @@ Full Featured Mobile HTML Framework For Building iOS & Android Apps
10
10
11
11
## Getting Started
12
12
*[Getting Started Guide](https://framework7.io/docs/introduction.html)
13
-
* Clone/download this repo
14
-
* Start building your App from changing Kitchen Sink, or using a clean template.
15
13
16
-
## Build
14
+
## Framework7 Development
17
15
18
-
Framework7 uses `gulp` and `rollup` to build a development (build) and productuin (dist) versions.
16
+
Framework7 uses `gulp` and `rollup` to build a development (build) and production versions.
19
17
20
18
First you need to have `gulp-cli` which you should install globally.
21
19
@@ -29,46 +27,61 @@ Then install all dependencies, in repo's root:
29
27
$ npm install
30
28
```
31
29
32
-
And build development version of Framework7:
33
-
```
34
-
$ npm run build:dev
35
-
```
30
+
## Development Builds
36
31
37
-
The result is available in `build/` folder.
32
+
The following npm scripts are available to create development builds:
38
33
39
-
## Dist/Release
34
+
*`build:dev` - build development versions of all packages (Core, Vue, React)
35
+
*`build-core:dev` - build development version of Core (vanilla JS) Framework7
36
+
*`build-react:dev` - build development version of Framework7 React package
37
+
*`build-vue:dev` - build development version of Framework7 Vue package
40
38
41
-
To build production version of Framework7:
39
+
Compiled results will be available in `build/` folder.
42
40
43
-
```
44
-
$ npm run build:prod
45
-
```
41
+
## Production builds
46
42
47
-
Production version will be available in `dist/` folder.
43
+
To build production versions the following npm scripts are available:
44
+
45
+
*`build:prod` - build prodiction versions of all packages (Core, Vue, React)
46
+
*`build-core:prod` - build prodiction version of Core (vanilla JS) Framework7
47
+
*`build-react:prod` - build prodiction version of Framework7 React package
48
+
*`build-vue:prod` - build prodiction version of Framework7 Vue package
49
+
50
+
Compiled results will be available in `packages/` folder.
48
51
49
52
## Kitchen Sink
50
53
51
-
Kitchen Sink uses Ajax for navigation between pages so you will need a server.
54
+
To Run Kitchen Sink with development environment (development version will be built first) use the following npm scripts:
52
55
53
-
Run Kitchen Sink with development environment (development version will be built first):
56
+
*`dev` - build development versions of all packages (Core, Vue, React) and run local server. With this common script it will watch for changes in all `src/` files and rebuild all packages (Core, Vue, React)
57
+
*`core:dev` - build development version of Core (vanilla JS) Framework7 package and run core Kitchen Sink
58
+
*`react:dev` - build development version of Framework7 React package and run React Kitchen Sink
59
+
*`vue:dev` - build development version of Framework7 Vue package and run Vue Kitchen Sink
54
60
55
-
```
56
-
$ npm run dev
57
-
```
61
+
To Run Kitchen Sink with production builds (already compiled `/packages/` will be used), use the following npm scripts:
58
62
59
-
Run Kitchen Sink with production environment (configured to scripts and styles from `dist/` folder):
63
+
*`prod` - build Kitchen Sinks with production versions
64
+
*`core:prod` - run core Kitchen Sink with production Framework7 core package
65
+
*`react:prod` - run React Kitchen Sink with production build of Framework7 React
66
+
*`vue:prod` - run Vue Kitchen Sink with production build of Framework7 Vue
60
67
61
-
```
62
-
$ npm run prod
63
-
```
68
+
## Source Code
69
+
70
+
Whole source code is locaed under `/src/` folder.
71
+
72
+
Framework7 uses Phenome compiler to generate React & Vue components. So all the React & Vue related code is under the `/src/phenome/` folder
73
+
74
+
Framework7 core library source code is under `/src/core/` folder
64
75
65
76
## Contributing
66
77
67
78
Before you open an issue please review the [contributing](https://github.com/framework7io/framework7/blob/master/CONTRIBUTING.md) guideline.
68
79
69
-
All changes should be commited to `src/` files. Framework7 uses LESS for CSS compliations, and ES modules JS files.
80
+
**All changes should be commited to `src/` files only!**.
81
+
82
+
Framework7 uses LESS for CSS compliations, and ES modules JS files.
70
83
71
-
The project uses [.editorconfig](http://editorconfig.org/) to define the coding style of each file. We recommend that you install the Editor Config extension for your preferred IDE.
84
+
The project uses [.editorconfig](http://editorconfig.org/)and [ESLint](https://eslint.org/)to define and lint the coding style of each file. We recommend that you install the Editor Config and ESLint extension for your preferred IDE.
72
85
73
86
If you want to help in Framework7 development and make it event better visit this page: http://framework7.io/contribute/
74
87
@@ -88,6 +101,7 @@ Tutorials available at http://framework7.io/tutorials/
88
101
89
102
Appstore apps made with Framework7: http://framework7.io/showcase/
90
103
91
-
## v1
104
+
## Previous Versions
92
105
93
-
Old v1 version of Framework7 is still available at [v1 branch](https://github.com/framework7io/Framework7/tree/v1)
0 commit comments