# Modern.js

> The Modern.js framework is a progressive web framework based on React. At ByteDance, we use Modern.js to build upper-level frameworks that have supported the development of thousands of web applications.

## guide

- [Introduction](/guides/get-started/introduction.md)
- [Quick Start](/guides/get-started/quick-start.md)
- [Upgrading](/guides/get-started/upgrade.md)
- [Glossary](/guides/get-started/glossary.md)
- [Tech Stack](/guides/get-started/tech-stack.md)
- [Page Entry](/guides/concept/entries.md)
- [Build Engine](/guides/concept/builder.md)
- [Web Server](/guides/concept/server.md)
- [Routing](/guides/basic-features/routes.md)
- [Data Fetching](/guides/basic-features/data/data-fetch.md)
- [Data Writing](/guides/basic-features/data/data-write.md)
- [Data Caching](/guides/basic-features/data/data-cache.md)
- [Server-Side Rendering](/guides/basic-features/render/ssr.md)
- [Streaming SSR](/guides/basic-features/render/streaming-ssr.md)
- [Rendering Cache](/guides/basic-features/render/ssr-cache.md)
- [Static Site Generation](/guides/basic-features/render/ssg.md)
- [Render Preprocessing](/guides/basic-features/render/before-render.md)
- [Styling](/guides/basic-features/css/css.md)
- [Use CSS Modules](/guides/basic-features/css/css-modules.md)
- [Using CSS-in-JS](/guides/basic-features/css/css-in-js.md)
- [Using Tailwind CSS](/guides/basic-features/css/tailwindcss.md)
- [HTML Template](/guides/basic-features/html.md)
- [Import Static Assets](/guides/basic-features/static-assets.md)
- [Import JSON Files](/guides/basic-features/static-assets/json-files.md)
- [Import SVG Assets](/guides/basic-features/static-assets/svg-assets.md)
- [Import Wasm Assets](/guides/basic-features/static-assets/wasm-assets.md)
- [Data Mocking](/guides/basic-features/debug/mock.md)
- [Network Proxy](/guides/basic-features/debug/proxy.md)
- [Using Rsdoctor](/guides/basic-features/debug/rsdoctor.md)
- [Using Storybook](/guides/basic-features/debug/using-storybook.md)
- [Playwright](/guides/basic-features/testing/playwright.md)
- [Vitest](/guides/basic-features/testing/vitest.md)
- [Jest](/guides/basic-features/testing/jest.md)
- [Cypress](/guides/basic-features/testing/cypress.md)
- [Path Alias](/guides/basic-features/alias.md)
- [Environment Variables](/guides/basic-features/env-vars.md)
- [Output Files](/guides/basic-features/output-files.md)
- [Deploy Application](/guides/basic-features/deploy.md)
- [Using Rspack](/guides/advanced-features/rspack-start.md)
- [BFF](/guides/advanced-features/bff.md)
- [Basic Usage](/guides/advanced-features/bff/function.md)
- [Runtime Framework](/guides/advanced-features/bff/frameworks.md)
- [Extend BFF Server](/guides/advanced-features/bff/extend-server.md)
- [Extend Request SDK](/guides/advanced-features/bff/sdk.md)
- [File Upload](/guides/advanced-features/bff/upload.md)
- [Cross-Project Invocation](/guides/advanced-features/bff/cross-project.md)
- [Code Splitting](/guides/advanced-features/page-performance/code-split.md)
- [Inline Static Assets](/guides/advanced-features/page-performance/inline-assets.md)
- [Bundle Size Optimization](/guides/advanced-features/page-performance/optimize-bundle.md)
- [Improve Build Performance](/guides/advanced-features/build-performance.md)
- [Browser Compatibility](/guides/advanced-features/compatibility.md)
- [Low-Level Tools](/guides/advanced-features/low-level.md)
- [Source Code Build Mode](/guides/advanced-features/source-build.md)
- [Monitors](/guides/advanced-features/server-monitor/monitors.md)
- [Logs Events](/guides/advanced-features/server-monitor/logger.md)
- [Metrics Events](/guides/advanced-features/server-monitor/metrics.md)
- [Custom Server](/guides/advanced-features/custom-server.md)
- [Custom Web Server (Not Recommended)](/guides/advanced-features/web-server.md)
- [Introduction](/guides/topic-detail/module-federation/introduce.md)
- [Getting Started](/guides/topic-detail/module-federation/usage.md)
- [Application-Level Modules](/guides/topic-detail/module-federation/application.md)
- [Server-Side Rendering](/guides/topic-detail/module-federation/ssr.md)
- [Deployment](/guides/topic-detail/module-federation/deploy.md)
- [Introduction](/guides/topic-detail/micro-frontend/c01-introduction.md)
- [Development](/guides/topic-detail/micro-frontend/c02-development.md)
- [Develop Main App](/guides/topic-detail/micro-frontend/c03-main-app.md)
- [Communicate](/guides/topic-detail/micro-frontend/c04-communicate.md)
- [Mixed Stack](/guides/topic-detail/micro-frontend/c05-mixed-stack.md)
- [Quick Start](/guides/topic-detail/model/quick-start.md)
- [Define a Model](/guides/topic-detail/model/define-model.md)
- [Use Models](/guides/topic-detail/model/use-model.md)
- [Derived State](/guides/topic-detail/model/computed-state.md)
- [Management Effect](/guides/topic-detail/model/manage-effects.md)
- [Automatically Generated Actions](/guides/topic-detail/model/auto-actions.md)
- [Model Communication](/guides/topic-detail/model/model-communicate.md)
- [Performance Optimization](/guides/topic-detail/model/performance.md)
- [TS Best Practices](/guides/topic-detail/model/typescript-best-practice.md)
- [Redux Ecosystem Integration](/guides/topic-detail/model/redux-integration.md)
- [Using Reduck Separately](/guides/topic-detail/model/use-out-of-modernjs.md)
- [FAQ](/guides/topic-detail/model/faq.md)
- [Dependencies FAQ](/guides/troubleshooting/dependencies.md)
- [CLI FAQ](/guides/troubleshooting/cli.md)
- [Build FAQ](/guides/troubleshooting/builder.md)
- [HMR FAQ](/guides/troubleshooting/hmr.md)
- [Deprecated](/guides/deprecated.md)

## configure

- [Configuration](/configure/app/usage.md)
- [assetPrefix](/configure/app/dev/asset-prefix.md)
- [beforeStartUrl](/configure/app/dev/before-start-url.md)
- [client](/configure/app/dev/client.md)
- [hmr](/configure/app/dev/hmr.md)
- [host](/configure/app/dev/host.md)
- [https](/configure/app/dev/https.md)
- [liveReload](/configure/app/dev/live-reload.md)
- [port](/configure/app/dev/port.md)
- [progressBar](/configure/app/dev/progress-bar.md)
- [proxy](/configure/app/dev/proxy.md)
- [setupMiddlewares](/configure/app/dev/setup-middlewares.md)
- [startUrl](/configure/app/dev/start-url.md)
- [watchFiles](/configure/app/dev/watch-files.md)
- [writeToDisk](/configure/app/dev/write-to-disk.md)
- [enableHandleWeb](/configure/app/bff/enable-handle-web.md)
- [prefix](/configure/app/bff/prefix.md)
- [appIcon](/configure/app/html/app-icon.md)
- [crossorigin](/configure/app/html/crossorigin.md)
- [disableHtmlFolder](/configure/app/html/disable-html-folder.md)
- [faviconByEntries](/configure/app/html/favicon-by-entries.md)
- [favicon](/configure/app/html/favicon.md)
- [injectByEntries](/configure/app/html/inject-by-entries.md)
- [inject](/configure/app/html/inject.md)
- [metaByEntries](/configure/app/html/meta-by-entries.md)
- [meta](/configure/app/html/meta.md)
- [mountId](/configure/app/html/mount-id.md)
- [outputStructure](/configure/app/html/output-structure.md)
- [scriptLoading](/configure/app/html/script-loading.md)
- [tagsByEntries](/configure/app/html/tags-by-entries.md)
- [tags](/configure/app/html/tags.md)
- [templateByEntries](/configure/app/html/template-by-entries.md)
- [templateParametersByEntries](/configure/app/html/template-parameters-by-entries.md)
- [templateParameters](/configure/app/html/template-parameters.md)
- [template](/configure/app/html/template.md)
- [titleByEntries](/configure/app/html/title-by-entries.md)
- [title](/configure/app/html/title.md)
- [autoprefixer](/configure/app/tools/autoprefixer.md)
- [babel](/configure/app/tools/babel.md)
- [bundlerChain](/configure/app/tools/bundler-chain.md)
- [cssExtract](/configure/app/tools/css-extract.md)
- [cssLoader](/configure/app/tools/css-loader.md)
- [devServer](/configure/app/tools/dev-server.md)
- [esbuild](/configure/app/tools/esbuild.md)
- [htmlPlugin](/configure/app/tools/html-plugin.md)
- [less](/configure/app/tools/less.md)
- [lightningcssLoader](/configure/app/tools/lightningcss-loader.md)
- [minifyCss](/configure/app/tools/minify-css.md)
- [postcss](/configure/app/tools/postcss.md)
- [pug](/configure/app/tools/pug.md)
- [rspack](/configure/app/tools/rspack.md)
- [sass](/configure/app/tools/sass.md)
- [styleLoader](/configure/app/tools/style-loader.md)
- [styledComponents](/configure/app/tools/styled-components.md)
- [swc](/configure/app/tools/swc.md)
- [tailwindcss](/configure/app/tools/tailwindcss.md)
- [terser](/configure/app/tools/terser.md)
- [tsChecker](/configure/app/tools/ts-checker.md)
- [tsLoader](/configure/app/tools/ts-loader.md)
- [webpackChain](/configure/app/tools/webpack-chain.md)
- [webpack](/configure/app/tools/webpack.md)
- [aliasStrategy](/configure/app/source/alias-strategy.md)
- [alias](/configure/app/source/alias.md)
- [configDir](/configure/app/source/config-dir.md)
- [decorators](/configure/app/source/decorators.md)
- [define](/configure/app/source/define.md)
- [disableDefaultEntries](/configure/app/source/disable-default-entries.md)
- [disableEntryDirs](/configure/app/source/disable-entry-dirs.md)
- [enableAsyncEntry](/configure/app/source/enable-async-entry.md)
- [enableCustomEntry](/configure/app/source/enable-custom-entry.md)
- [entriesDir](/configure/app/source/entries-dir.md)
- [entries](/configure/app/source/entries.md)
- [exclude](/configure/app/source/exclude.md)
- [globalVars](/configure/app/source/global-vars.md)
- [include](/configure/app/source/include.md)
- [mainEntryName](/configure/app/source/main-entry-name.md)
- [moduleScopes](/configure/app/source/module-scopes.md)
- [preEntry](/configure/app/source/pre-entry.md)
- [resolveExtensionPrefix](/configure/app/source/resolve-extension-prefix.md)
- [resolveMainFields](/configure/app/source/resolve-main-fields.md)
- [transformImport](/configure/app/source/transform-import.md)
- [baseUrl](/configure/app/server/base-url.md)
- [port](/configure/app/server/port.md)
- [publicRoutes](/configure/app/server/public-routes.md)
- [routes](/configure/app/server/routes.md)
- [ssrByEntries](/configure/app/server/ssr-by-entries.md)
- [ssr](/configure/app/server/ssr.md)
- [assetPrefix](/configure/app/output/asset-prefix.md)
- [assetsRetry](/configure/app/output/assets-retry.md)
- [charset](/configure/app/output/charset.md)
- [cleanDistPath](/configure/app/output/clean-dist-path.md)
- [convertToRem](/configure/app/output/convert-to-rem.md)
- [copy](/configure/app/output/copy.md)
- [cssModuleLocalIdentName](/configure/app/output/css-module-local-ident-name.md)
- [cssModules](/configure/app/output/css-modules.md)
- [dataUriLimit](/configure/app/output/data-uri-limit.md)
- [disableCssExtract](/configure/app/output/disable-css-extract.md)
- [disableCssModuleExtension](/configure/app/output/disable-css-module-extension.md)
- [disableFilenameHash](/configure/app/output/disable-filename-hash.md)
- [disableInlineRuntimeChunk](/configure/app/output/disable-inline-runtime-chunk.md)
- [disableMinimize](/configure/app/output/disable-minimize.md)
- [disableNodePolyfill](/configure/app/output/disable-node-polyfill.md)
- [disableSourceMap](/configure/app/output/disable-source-map.md)
- [disableSvgr](/configure/app/output/disable-svgr.md)
- [disableTsChecker](/configure/app/output/disable-ts-checker.md)
- [distPath](/configure/app/output/dist-path.md)
- [enableAssetFallback](/configure/app/output/enable-asset-fallback.md)
- [enableAssetManifest](/configure/app/output/enable-asset-manifest.md)
- [enableCssModuleTSDeclaration](/configure/app/output/enable-css-module-tsdeclaration.md)
- [disableInlineRouteManifests](/configure/app/output/enable-inline-route-manifests.md)
- [enableInlineScripts](/configure/app/output/enable-inline-scripts.md)
- [enableInlineStyles](/configure/app/output/enable-inline-styles.md)
- [enableLatestDecorators](/configure/app/output/enable-latest-decorators.md)
- [externals](/configure/app/output/externals.md)
- [filenameHash](/configure/app/output/filename-hash.md)
- [filename](/configure/app/output/filename.md)
- [injectStyles](/configure/app/output/inject-styles.md)
- [inlineScripts](/configure/app/output/inline-scripts.md)
- [inlineStyles](/configure/app/output/inline-styles.md)
- [legalComments](/configure/app/output/legal-comments.md)
- [minify](/configure/app/output/minify.md)
- [overrideBrowserslist](/configure/app/output/override-browserslist.md)
- [polyfill](/configure/app/output/polyfill.md)
- [sourceMap](/configure/app/output/source-map.md)
- [splitRouteChunks](/configure/app/output/split-route-chunks.md)
- [ssg](/configure/app/output/ssg.md)
- [svgDefaultExport](/configure/app/output/svg-default-export.md)
- [tempDir](/configure/app/output/temp-dir.md)
- [microFrontend](/configure/app/deploy/microFrontend.md)
- [plugins](/configure/app/plugins.md)
- [checkSyntax](/configure/app/security/check-syntax.md)
- [nonce](/configure/app/security/nonce.md)
- [sri](/configure/app/security/sri.md)
- [Introduce](/configure/app/runtime/0-intro.md)
- [masterApp](/configure/app/runtime/master-app.md)
- [plugins](/configure/app/runtime/plugins.md)
- [router](/configure/app/runtime/router.md)
- [state](/configure/app/runtime/state.md)
- [buildCache](/configure/app/performance/build-cache.md)
- [bundleAnalyze](/configure/app/performance/bundle-analyze.md)
- [chunkSplit](/configure/app/performance/chunk-split.md)
- [dnsPrefetch](/configure/app/performance/dns-prefetch.md)
- [preconnect](/configure/app/performance/preconnect.md)
- [prefetch](/configure/app/performance/prefetch.md)
- [preload](/configure/app/performance/preload.md)
- [printFileSize](/configure/app/performance/print-file-size.md)
- [profile](/configure/app/performance/profile.md)
- [removeConsole](/configure/app/performance/remove-console.md)
- [removeMomentLocale](/configure/app/performance/remove-moment-locale.md)
- [transformLodash](/configure/app/performance/transform-lodash.md)
- [lazyCompilation](/configure/app/experiments/lazy-compilation.md)
- [sourceBuild](/configure/app/experiments/source-build.md)
- [builderPlugins](/configure/app/builder-plugins.md)
- [autoLoadPlugins](/configure/app/auto-load-plugin.md)

## plugin-menu

- [Plugin API](/plugin/server-plugins/api.md)
- [Life Cycle](/plugin/server-plugins/life-cycle.md)
- [Introduction](/plugin/introduction.md)
- [Plugin System](/plugin/plugin-system.md)
- [CLI Plugin API](/plugin/cli-plugins/api.md)
- [Life Cycle](/plugin/cli-plugins/life-cycle.md)
- [Plugin Migration](/plugin/cli-plugins/migration.md)
- [Plugin API](/plugin/runtime-plugins/api.md)
- [Life Cycle](/plugin/runtime-plugins/life-cycle.md)
- [Plugin Migration](/plugin/runtime-plugins/migration.md)
- [Overview](/plugin/official/cli-plugins.md)
- [Tailwind CSS Plugin](/plugin/official/cli-plugins/plugin-tailwind.md)
- [BFF Plugin](/plugin/official/cli-plugins/plugin-bff.md)
- [SSG Plugin](/plugin/official/cli-plugins/plugin-ssg.md)
- [SWC Plugin](/plugin/official/cli-plugins/plugin-swc.md)
- [Overview](/plugin/official/rsbuild-plugins.md)
- [Esbuild Plugin](/plugin/official/rsbuild-plugins/plugin-esbuild.md)

## apis

- [Commands](/apis/app/commands.md)
- [App.[tj]sx](/apis/app/hooks/src/app.md)
- [entry.[tj]s](/apis/app/hooks/src/entry.md)
- [entry.server.[tj]sx](/apis/app/hooks/src/entry.server.md)
- [index.[tj]s](/apis/app/hooks/src/index_.md)
- [modern.runtime.[tj]s](/apis/app/hooks/src/modern.runtime.md)
- [routes/](/apis/app/hooks/src/routes.md)
- [*.[server|node].[tj]sx](/apis/app/hooks/src/server.md)
- [**/*.stories.[tj]sx](/apis/app/hooks/src/stories.md)
- [lambda/*.[tj]s](/apis/app/hooks/api/lambda.md)
- [index.[tj]s](/apis/app/hooks/server/index_.md)
- [modern.server.[tj]s](/apis/app/hooks/server/server.md)
- [shared/](/apis/app/hooks/shared.md)
- [html/](/apis/app/hooks/config/html.md)
- [favicon.*](/apis/app/hooks/config/favicon.md)
- [icon.*](/apis/app/hooks/config/icon.md)
- [mock/](/apis/app/hooks/config/mock.md)
- [public/](/apis/app/hooks/config/public.md)
- [upload/](/apis/app/hooks/config/upload.md)
- [modern.config.[tj]s](/apis/app/hooks/modern-config.md)
- [bootstrap](/apis/app/runtime/core/bootstrap.md)
- [createApp](/apis/app/runtime/core/create-app.md)
- [createRoot](/apis/app/runtime/core/create-root.md)
- [render](/apis/app/runtime/core/render.md)
- [useLoader](/apis/app/runtime/core/use-loader.md)
- [useModuleApps](/apis/app/runtime/core/use-module-apps.md)
- [useRuntimeContext](/apis/app/runtime/core/use-runtime-context.md)
- [defineConfig](/apis/app/runtime/app/define-config.md)
- [router](/apis/app/runtime/router/router.md)
- [Provider](/apis/app/runtime/model/Provider.md)
- [Auto actions](/apis/app/runtime/model/auto-actions.md)
- [connect](/apis/app/runtime/model/connect.md)
- [createApp](/apis/app/runtime/model/create-app.md)
- [createStore](/apis/app/runtime/model/create-store.md)
- [handleEffect](/apis/app/runtime/model/handle-effect.md)
- [model](/apis/app/runtime/model/model_.md)
- [useLocalModel](/apis/app/runtime/model/use-local-model.md)
- [useModel](/apis/app/runtime/model/use-model.md)
- [useStaticModel](/apis/app/runtime/model/use-static-model.md)
- [useStore](/apis/app/runtime/model/use-store.md)
- [NoSSR](/apis/app/runtime/ssr/no-ssr.md)
- [PreRender](/apis/app/runtime/ssr/pre-render.md)
- [renderStreaming](/apis/app/runtime/ssr/renderStreaming.md)
- [renderString](/apis/app/runtime/ssr/renderString.md)
- [createRequestHandler](/apis/app/runtime/ssr/requestHandler.md)
- [useHonoContext](/apis/app/runtime/bff/use-hono-context.md)
- [Hook](/apis/app/runtime/web-server/hook.md)
- [Middleware](/apis/app/runtime/web-server/middleware.md)
- [Unstable Middleware](/apis/app/runtime/web-server/unstable_middleware.md)
- [CSS-In-JS API](/apis/app/runtime/utility/css-in-js.md)
- [Head](/apis/app/runtime/utility/head.md)
- [loadable](/apis/app/runtime/utility/loadable.md)

## tutorials

- [Introduction](/tutorials/foundations/introduction.md)
- [Create Project](/tutorials/first-app/c01-start.md)
- [Add UI Components](/tutorials/first-app/c02-component.md)
- [Add Style](/tutorials/first-app/c03-css.md)
- [Add Client Route](/tutorials/first-app/c04-routes.md)
- [Add Loader](/tutorials/first-app/c05-loader.md)
- [Add Model](/tutorials/first-app/c06-model.md)
- [Add Container](/tutorials/first-app/c07-container.md)
- [Add Application Entry](/tutorials/first-app/c08-entries.md)
- [Route Authorization](/tutorials/examples/csr-auth.md)

## community

- [Showcase](/community/showcase.md)
- [Meet the Team](/community/team.md)
- [Releases](/community/releases.md)
- [Contributing Guide](/community/contributing-guide.md)
- [Overview](/community/blog/overview.md)
- [Modern.js v2 发布](/community/blog/v2-release-note.md)
- [2022 年 9 ~ 10 月更新内容](/community/blog/2022-0910-updates.md)
- [2022 年 7 ~ 8 月更新内容](/community/blog/2022-0708-updates.md)