Full Featured Mobile HTML Framework For Building iOS & Android Apps
Framework7 is an MIT-licensed open source project with its ongoing development made possible entirely by the support of these awesome backers. If you'd like to join them, please consider becoming a backer or sponsor on Patreon.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Framework7 uses gulp and rollup to build a development (build) and production versions.
First you need to have gulp-cli which you should install globally.
$ npm install --global gulp
Then install all dependencies, in repo's root:
$ npm install
The following npm scripts are available to create development builds:
build:dev- build development versions of all packages (Core, Vue, React)build-core:dev- build development version of Core (vanilla JS) Framework7build-react:dev- build development version of Framework7 React packagebuild-vue:dev- build development version of Framework7 Vue packagebuild-svelte:dev- build development version of Framework7 Svelte package
Compiled results will be available in build/ folder.
To build production versions the following npm scripts are available:
build:prod- build production versions of all packages (Core, Vue, React)build-core:prod- build production version of Core (vanilla JS) Framework7build-react:prod- build production version of Framework7 React packagebuild-vue:prod- build production version of Framework7 Vue packagebuild-svelte:prod- build production version of Framework7 Svelte package
Compiled results will be available in packages/ folder.
To run Kitchen Sink with development environment (development version will be built first) use the following npm scripts:
dev- build development versions of all packages (Core, Vue, React) and run local server. With this common script it will watch for changes in allsrc/files and rebuild all packages (Core, Vue, React)core:dev- build development version of Core (vanilla JS) Framework7 package and run core Kitchen Sinkreact:dev- build development version of Framework7 React package and run React Kitchen Sinkvue:dev- build development version of Framework7 Vue package and run Vue Kitchen Sinksvelte:dev- build development version of Framework7 Svelte package and run Svelte Kitchen Sink
To Run Kitchen Sink with production builds (already compiled /packages/ will be used), use the following npm scripts:
prod- build Kitchen Sinks with production versionscore:prod- run core Kitchen Sink with production Framework7 core packagereact:prod- run React Kitchen Sink with production build of Framework7 Reactvue:prod- run Vue Kitchen Sink with production build of Framework7 Vuesvelte:prod- run Svelte Kitchen Sink with production build of Framework7 Svelte
Whole source code is located under /src/ folder.
Framework7 uses Phenome compiler to generate React & Vue components. So all the React & Vue related code is under the /src/phenome/ folder
Framework7 core library source code is under /src/core/ folder
Before you open an issue please review the contributing guideline.
All changes should be committed to src/ files only!.
Framework7 uses LESS for CSS compilations, and ES modules JS files.
The project uses .editorconfig and ESLint 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.
If you want to help in Framework7 development and make it event better visit this page: https://framework7.io/contribute/
If you have questions about Framework7 or want to help others you are welcome to special forum at https://forum.framework7.io/
Documentation available at https://framework7.io/docs/
Tutorials available at https://framework7.io/tutorials/
Appstore apps made with Framework7: https://framework7.io/showcase/