framework7 README

The project's README from github.com/framework7io/framework7. As one markdown file: README.md.

Framework7

Full Featured Mobile HTML Framework For Building iOS & Android Apps

Supporting Framework7

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.

Sponsors

Getting Started

Getting Started Guide

Framework7 Development

First, install all dependencies:

$ npm install

Development Builds

The following npm scripts are available to create development builds:

build:dev - build development versions of all packages (Core, Vue, React, Svelte)
build-core:dev - build development version of Core (vanilla JS) Framework7
build-react:dev - build development version of Framework7 React package
build-vue:dev - build development version of Framework7 Vue package
build-svelte:dev - build development version of Framework7 Svelte package

Compiled results will be available in build/ folder.

Production Builds

To build production versions the following npm scripts are available:

build:prod - build production versions of all packages (Core, Vue, React, Svelte)
build-core:prod - build production version of Core (vanilla JS) Framework7
build-react:prod - build production version of Framework7 React package
build-vue:prod - build production version of Framework7 Vue package
build-svelte:prod - build production version of Framework7 Svelte package

Compiled results will be available in packages/ folder.

Kitchen Sink

To run Kitchen Sink with development environment (development version will be built first) use the following npm scripts:

core - build development version of Core (vanilla JS) Framework7 package and run core Kitchen Sink
react - build development version of Framework7 React package and run React Kitchen Sink
vue - build development version of Framework7 Vue package and run Vue Kitchen Sink
svelte - build development version of Framework7 Svelte package and run Svelte Kitchen Sink

Source Code

Whole source code is located under the /src/ folder.

Contributing

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/

Forum

If you have questions about Framework7 or want to help others you are welcome to special forum at https://forum.framework7.io/

Docs

Documentation available at https://framework7.io/docs/

Tutorials

Tutorials available at https://framework7.io/tutorials/

Showcase

Appstore apps made with Framework7: https://framework7.io/showcase/

Previous Versions

Searching Database…

18.8K ·GitHub

这是什么东西？

Framework7 是一个免费的开源 HTML 框架，采用 MIT 许可证，用于开发在 iOS 和 Android 上具有原生外观和手感的移动应用。

那我需要写 Swift 或 Kotlin 吗，还是全部都是网页代码？

全部都是网页代码——HTML、CSS 和 JavaScript。Framework7 提供各种 UI 组件，样式做得和原生 iOS 以及 Android Material Design 一致。

用它开发应用的第一步是什么？

README 里链接了官方入门指南，项目网站上还有文档和教程。如果想参与 Framework7 本身的开发：克隆仓库，运行 npm install，然后使用 npm 的构建脚本。

它是独立自包含的，还是依赖其他库？

有几个小的运行时依赖：用于 DOM 操作的 Dom7、用于触摸滑动轮播的 Swiper，另外还有 path-to-regexp、skeleton-elements、ssr-window 和 htm。

可以免费商用吗？

可以——采用 MIT 许可证，完全免费，包括商业用途；后续开发由 Patreon 上的赞助者提供资金支持。

有没有用 Framework7 开发的真实应用可以参考？

有——README 里链接了一个案例展示（Showcase），收录了用 Framework7 开发并上架 App Store 的应用，可以借此了解用它做出的正式应用实际是什么样子。

Framework7 现在还在积极维护吗？

在维护——这个仓库从 2014 年开始持续开发，没有被归档，目前在 GitHub 上约有 18.7k 颗星，文档、论坛和教程也都仍然可用。

如果我现在开始用，会用到哪个版本？

文档中介绍的当前最新版本。旧的大版本 v1 到 v7 在仓库中以分支的形式保留，用于维护老应用。

What are similar projects?

capacitor, ionic-framework, mdb-ui-kit, mui, NativeScript, vux, bootstrap-table, react-native-paper

Which topics is it in?

material, touch, components, svelte, material-design, mobile-development, mobile-app, vue, ui-components, css, html, mobile

Creator: framework7io
Size: 100.8 MB
Stars: 18.8K
Updated: CommitOct 15 Releasev9.2.0Sep 28
Age: 12y
Commits · 90 Days