Git Product home page Git Product logo

nut's Introduction

nut logo

NUT Project

npm version dependencies node version build status npm downloads license

Features

  • Flexible layout mechanism
  • File-based router system
  • Customizable layouts and themes
  • Builtin markdown support
  • System events
  • Configuration management
  • Convenient hot reload during development
  • Plugin system

layout / theme HMR

hmr.gif

markdown theme HMR

markdown-theme-hmr.gif

System events

system-events.jpg

Route matching

route-match.jpg

Builtin layouts

default

ocean sakura
ocean sakura

saber

ocean sakura
ocean sakura

now

now

How to write a layout

...

How to write a plugin

A standard plugin looks like

export default {
  name: 'your-superb-plugin',
  // some special plugin need specify type,but you can ignore this in most cases
  type: 'login',
  apply( ctx = {}, options = {} ) {
    const { api, events } = ctx

    api.expose( 'method_name', () => {} )
    api.expose( 'prop', 'value' )

    events.on( 'system:before-startup', async ctx => {
      await api.axios() // do some request
      await events.pluginEmit( 'some-event', data ) // emit plugin event out
    } )
  }
}

You can expose some methods or props to application, or listen for system events, emit out some event in plugin

Using plugin

nut.config.js

module.exports = {
  plugins: {
    superb: {
      package: 'your-superb-plugin',
      enable: true,
    }
  }
}

superb is the name in current application

Use above plugin for example

// plugin exposed
ctx.use( 'superb', 'method_name' )
ctx.use( 'superb', 'prop' )

// plugin events
ctx.events.on( 'plugin:superb:some-event', async data => {} )

Get started

yarn global add @nut-project/cli
nut # develop locally
nut --prod # build for production

nut's People

Contributors

centmaster avatar fengzilong avatar renovate[bot] avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar

nut's Issues

Dependency Dashboard

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

Rate-Limited

These updates are currently rate-limited. Click on a checkbox below to force their creation now.

  • chore(deps): replace dependency babel-eslint with @babel/eslint-parser
  • fix(deps): update dependency @babel/preset-modules to v0.1.6
  • fix(deps): update dependency cheerio to v1.0.0-rc.12
  • fix(deps): update dependency cross-spawn to v7.0.3
  • fix(deps): update dependency fast-memoize to v2.5.2
  • fix(deps): update dependency globby to v10.0.2
  • fix(deps): update dependency gunzip-maybe to v1.4.2
  • fix(deps): update dependency optimize-css-assets-webpack-plugin to v5.0.8
  • fix(deps): update dependency postcss-preset-env to v6.7.2
  • fix(deps): update dependency raw-loader to v4.0.2
  • fix(deps): update dependency react-error-overlay to v6.0.11
  • fix(deps): update dependency sao to v1.7.1
  • fix(deps): update dependency sass-loader to v8.0.2
  • fix(deps): update dependency strip-ansi to v6.0.1
  • fix(deps): update dependency terser-webpack-plugin to v2.3.8
  • fix(deps): update dependency ts-loader to v6.2.2
  • fix(deps): update dependency tslint to v5.20.1
  • fix(deps): update dependency webpack-stats-plugin to v0.3.2
  • chore(deps): update dependency babel-eslint to v10.1.0
  • chore(deps): update dependency eslint to v6.8.0
  • chore(deps): update dependency lerna to v3.22.1
  • fix(deps): update babel monorepo (@babel/core, @babel/plugin-proposal-object-rest-spread, @babel/plugin-syntax-dynamic-import, @babel/plugin-transform-runtime, @babel/preset-env, @babel/preset-react, @babel/runtime)
  • fix(deps): update dependency @vue/babel-helper-vue-jsx-merge-props to v1.4.0
  • fix(deps): update dependency @vue/babel-preset-jsx to v1.4.0
  • fix(deps): update dependency @zeit-ui/vue to v2.5.1
  • fix(deps): update dependency address to v1.2.2
  • fix(deps): update dependency autoprefixer to v9.8.8
  • fix(deps): update dependency babel-loader to v8.3.0
  • fix(deps): update dependency boxen to v4.2.0
  • fix(deps): update dependency cac to v6.7.14
  • fix(deps): update dependency case-sensitive-paths-webpack-plugin to v2.4.0
  • fix(deps): update dependency chokidar to v3.6.0
  • fix(deps): update dependency copy-webpack-plugin to v5.1.2
  • fix(deps): update dependency css-loader to v3.6.0
  • fix(deps): update dependency debug to v4.3.4
  • fix(deps): update dependency deepmerge to v4.3.1
  • fix(deps): update dependency detect-port to v1.6.1
  • fix(deps): update dependency fast-copy to v2.1.7
  • fix(deps): update dependency file-loader to v4.3.0
  • fix(deps): update dependency fork-ts-checker-webpack-plugin to v1.6.0
  • fix(deps): update dependency front-matter to v3.2.1
  • fix(deps): update dependency html-webpack-plugin to v4.5.2
  • fix(deps): update dependency import-fresh to v3.3.0
  • fix(deps): update dependency jstransformer-handlebars to v1.2.0
  • fix(deps): update dependency less to v3.13.1
  • fix(deps): update dependency open to v7.4.2
  • fix(deps): update dependency popper.js to v1.16.1
  • fix(deps): update dependency postcss-flexbugs-fixes to v4.2.1
  • fix(deps): update dependency pretty-bytes to v5.6.0
  • fix(deps): update dependency prism-themes to v1.9.0
  • fix(deps): update dependency pug-plain-loader to v1.1.0
  • fix(deps): update dependency sass to v1.77.2
  • fix(deps): update dependency string-width to v4.2.3
  • fix(deps): update dependency style-loader to v1.3.0
  • fix(deps): update dependency stylus to ^0.63.0
  • fix(deps): update dependency tar-stream to v2.2.0
  • fix(deps): update dependency typescript to v3.9.10
  • fix(deps): update dependency url-loader to v2.3.0
  • fix(deps): update dependency v8-compile-cache to v2.4.0
  • fix(deps): update dependency vue-loader to v15.11.1
  • fix(deps): update dependency webpack to v4.47.0
  • fix(deps): update dependency webpack-bundle-analyzer to v3.9.0
  • fix(deps): update dependency webpack-chain to v6.5.1
  • fix(deps): update dependency webpack-dev-server to v3.11.3
  • fix(deps): update dependency why-is-node-running to v2.2.2
  • fix(deps): update mdx monorepo to v1.6.22 (@mdx-js/mdx, @mdx-js/vue)
  • fix(deps): update react monorepo to v16.14.0 (react, react-dom)
  • fix(deps): update vue monorepo to v2.7.16 (vue, vue-template-compiler)
  • chore(deps): update commitlint monorepo to v19 (major) (@commitlint/cli, @commitlint/config-conventional)
  • chore(deps): update dependency eslint to v9
  • chore(deps): update dependency husky to v9
  • chore(deps): update dependency lerna to v8
  • chore(deps): update dependency lint-staged to v15
  • fix(deps): update dependency @sindresorhus/slugify to v2
  • fix(deps): update dependency @zeit-ui/themes to v1
  • fix(deps): update dependency @zeit-ui/vue to v2
  • fix(deps): update dependency address to v2
  • fix(deps): update dependency autoprefixer to v10
  • fix(deps): update dependency babel-loader to v9
  • fix(deps): update dependency boxen to v7
  • fix(deps): update dependency chalk to v5
  • fix(deps): update dependency clean-webpack-plugin to v4
  • fix(deps): update dependency copy-webpack-plugin to v12
  • fix(deps): update dependency cosmiconfig to v9
  • fix(deps): update dependency css-loader to v7
  • fix(deps): update dependency fast-copy to v3
  • fix(deps): update dependency file-loader to v6
  • fix(deps): update dependency fork-ts-checker-webpack-plugin to v9
  • fix(deps): update dependency front-matter to v4
  • fix(deps): update dependency fs-extra to v11
  • fix(deps): update dependency globby to v14
  • fix(deps): update dependency gradient-string to v2
  • fix(deps): update dependency html-webpack-plugin to v5
  • fix(deps): update dependency import-from to v4
  • fix(deps): update dependency less to v4
  • fix(deps): update dependency less-loader to v12
  • fix(deps): update dependency mcss-loader to v2
  • fix(deps): update dependency mdast-util-toc to v7
  • fix(deps): update dependency mini-css-extract-plugin to v2
  • fix(deps): update dependency null-loader to v4
  • fix(deps): update dependency open to v10
  • fix(deps): update dependency optimize-css-assets-webpack-plugin to v6
  • fix(deps): update dependency pascalcase to v2
  • fix(deps): update dependency postcss-flexbugs-fixes to v5
  • fix(deps): update dependency postcss-loader to v8
  • fix(deps): update dependency postcss-preset-env to v9
  • fix(deps): update dependency pretty-bytes to v6
  • fix(deps): update dependency query-string to v9
  • fix(deps): update dependency quicklink to v2
  • fix(deps): update dependency rehype-slug to v6
  • fix(deps): update dependency sass-loader to v14
  • fix(deps): update dependency schema-utils to v4
  • fix(deps): update dependency string-width to v7
  • fix(deps): update dependency strip-ansi to v7
  • fix(deps): update dependency style-loader to v4
  • fix(deps): update dependency stylus-loader to v8
  • fix(deps): update dependency superstruct to v1
  • fix(deps): update dependency tapable to v2
  • fix(deps): update dependency tar-stream to v3
  • fix(deps): update dependency terser-webpack-plugin to v5
  • fix(deps): update dependency thread-loader to v4
  • fix(deps): update dependency tildify to v3
  • fix(deps): update dependency tippy.js to v6
  • fix(deps): update dependency ts-loader to v9
  • fix(deps): update dependency tslint to v6
  • fix(deps): update dependency typescript to v5
  • fix(deps): update dependency unist-util-visit to v5
  • fix(deps): update dependency url-loader to v4
  • fix(deps): update dependency vue to v3
  • fix(deps): update dependency vue-loader to v17
  • fix(deps): update dependency webpack to v5
  • fix(deps): update dependency webpack-bundle-analyzer to v4
  • fix(deps): update dependency webpack-dev-server to v5
  • fix(deps): update dependency webpack-node-externals to v3
  • fix(deps): update dependency webpack-sources to v3
  • fix(deps): update dependency webpack-stats-plugin to v1
  • fix(deps): update dependency webpackbar to v6
  • fix(deps): update mdx monorepo to v3 (major) (@mdx-js/mdx, @mdx-js/vue)
  • fix(deps): update react monorepo to v18 (major) (react, react-dom)
  • 🔐 Create all rate-limited PRs at once 🔐

Edited/Blocked

These updates have been manually edited so Renovate will no longer make changes. To discard all commits and start over, click on a checkbox.

Other Branches

These updates are pending. To force PRs open, click the checkbox below.

  • fix(deps): update dependency prismjs to v1.27.0 [security]

Open

These updates have all been created already. Click a checkbox below to force a retry/rebase of any.

Detected dependencies

npm
other-packages/webpack-mini-css-extract/package.json
  • loader-utils ^1.2.3
  • normalize-url ^4.3.0
  • schema-utils ^1.0.0
  • webpack-sources ^1.3.0
  • webpack ^4.4.0
  • node >=8.9.0
other-packages/webpack-virtual-modules/package.json
  • debug ^4.1.1
  • node >=8.9.0
package.json
  • @commitlint/cli 8.0.0
  • @commitlint/config-conventional 8.0.0
  • babel-eslint ^10.0.2
  • chalk ^2.4.2
  • dependency-check ^4.1.0
  • eslint 6.0.1
  • eslint-config-mo 0.5.2
  • eslint-formatter-friendly ^7.0.0
  • gh-pages 2.1.1
  • globby ^10.0.1
  • husky 3.0.0
  • lerna ^3.16.4
  • lint-staged 9.1.0
packages/babel-preset/package.json
  • @babel/plugin-proposal-object-rest-spread ^7.7.4
  • @babel/plugin-syntax-dynamic-import ^7.7.4
  • @babel/plugin-transform-runtime ^7.7.4
  • @babel/preset-env ^7.7.4
  • @babel/preset-modules ^0.1.3
  • @babel/runtime ^7.7.4
  • node >=8.9.0
packages/cli-pages/package.json
  • node >=8.9.0
packages/cli/package.json
  • node >=8.9.0
packages/core/package.json
  • cac ^6.5.3
  • chokidar ^3.1.0
  • exit ^0.1.2
  • fast-memoize ^2.5.1
  • import-fresh ^3.2.1
  • please-upgrade-node ^3.2.0
  • superstruct ^0.8.2
  • tapable ^1.1.3
  • v8-compile-cache ^2.1.0
  • node >=8.9.0
packages/dev-utils/package.json
  • chalk ^2.4.2
  • cosmiconfig ^5.2.1
  • cross-spawn ^7.0.1
  • deepmerge ^4.0.0
  • detect-port ^1.3.0
  • globby ^10.0.1
  • gradient-string ^1.2.0
  • import-from ^3.0.0
  • install-packages ^0.2.5
  • open ^7.0.0
  • signale ^1.4.0
  • node >=8.9.0
packages/driver-pages/package.json
  • @babel/core ^7.6.2
  • @babel/plugin-syntax-dynamic-import ^7.2.0
  • @babel/plugin-transform-runtime ^7.6.2
  • @babel/preset-env ^7.6.2
  • @babel/preset-react ^7.0.0
  • @babel/runtime ^7.6.2
  • @vue/babel-helper-vue-jsx-merge-props ^1.0.0
  • @vue/babel-preset-jsx ^1.1.0
  • autoprefixer ^9.6.1
  • babel-loader ^8.0.6
  • cache-loader ^4.1.0
  • case-sensitive-paths-webpack-plugin ^2.2.0
  • chokidar ^3.1.0
  • clean-webpack-plugin ^3.0.0
  • copy-webpack-plugin ^5.0.4
  • css-loader ^3.2.0
  • exit ^0.1.2
  • file-loader ^4.2.0
  • fork-ts-checker-webpack-plugin ^1.5.0
  • friendly-errors-webpack-plugin ^1.7.0
  • globby ^10.0.1
  • html-webpack-plugin ^3.2.0
  • import-fresh ^3.1.0
  • less ^3.10.3
  • less-loader ^5.0.0
  • optimize-css-assets-webpack-plugin ^5.0.3
  • postcss ^7.0.21
  • postcss-loader ^3.0.0
  • pretty-bytes ^5.2.0
  • pug ^2.0.4
  • pug-plain-loader ^1.0.0
  • raw-loader ^3.1.0
  • readline ^1.3.0
  • resolve-from ^5.0.0
  • sass ^1.23.3
  • sass-loader ^8.0.0
  • style-loader ^1.0.0
  • stylus ^0.54.7
  • stylus-loader ^3.0.2
  • tapable ^1.1.3
  • terser-webpack-plugin ^2.1.0
  • thread-loader ^2.1.3
  • tildify ^2.0.0
  • ts-loader ^6.1.2
  • tslint ^5.18.0
  • typescript ^3.6.3
  • url-loader ^2.1.0
  • vue ^2.6.10
  • vue-loader ^15.7.2
  • vue-template-compiler ^2.6.10
  • webpack-bundle-analyzer ^3.6.0
  • webpackbar ^4.0.0
  • why-is-node-running ^2.1.0
  • node >=8.9.0
packages/driver-webpack/package.json
  • @babel/core ^7.7.5
  • address ^1.1.2
  • autodll-webpack-plugin ^0.4.2
  • babel-loader ^8.0.6
  • boxen ^4.1.0
  • cache-loader ^4.1.0
  • chalk ^3.0.0
  • cheerio ^1.0.0-rc.3
  • clean-webpack-plugin ^3.0.0
  • copy-webpack-plugin ^5.0.5
  • css-loader ^3.2.0
  • exit ^0.1.2
  • fast-memoize ^2.5.1
  • file-loader ^4.3.0
  • friendly-errors-webpack-plugin 1.7.0
  • hash-sum ^2.0.0
  • html-webpack-plugin ^4.0.0-beta.4
  • less ^3.10.3
  • less-loader ^5.0.0
  • mcss ^0.5.1
  • mcss-loader ^1.0.1
  • mini-css-extract-plugin ^0.8.0
  • optimize-css-assets-webpack-plugin ^5.0.3
  • postcss-flexbugs-fixes ^4.1.0
  • postcss-loader ^3.0.0
  • postcss-preset-env ^6.7.0
  • pretty-bytes ^5.3.0
  • raw-loader ^4.0.0
  • react-error-overlay ^6.0.3
  • readline ^1.3.0
  • resolve-from ^5.0.0
  • sass ^1.23.7
  • sass-loader ^8.0.0
  • shell-quote ^1.7.2
  • strip-ansi ^6.0.0
  • style-loader ^1.0.0
  • stylus ^0.54.7
  • stylus-loader ^3.0.2
  • terser-webpack-plugin ^2.3.5
  • thread-loader ^2.1.3
  • url-loader ^2.3.0
  • vue-loader ^15.7.2
  • webpack-bundle-analyzer ^3.6.0
  • webpackbar ^4.0.0
  • node >=8.9.0
packages/musubi/package.json
  • cac ^6.5.3
  • node >=8.9.0
packages/presets-alpha/package.json
  • node >=8.9.0
packages/webpack/package.json
  • webpack ^4.41.0
  • webpack-chain ^6.0.0
  • webpack-dev-server ^3.8.1
  • node >=8.9.0
plugins/modern-build/package.json
  • fast-copy ^2.0.4
  • node >=8.9.0
plugins/pages/layout-kaola/package.json
  • chalk ^2.4.2
  • cosmiconfig ^5.2.1
  • globby ^10.0.1
  • gradient-string ^1.2.0
  • signale ^1.4.0
  • node >=8.9.0
plugins/pages/layout-now/package.json
  • chalk ^2.4.2
  • cosmiconfig ^5.2.1
  • globby ^10.0.1
  • gradient-string ^1.2.0
  • signale ^1.4.0
  • node >=8.9.0
plugins/pages/layout-saber/package.json
  • chalk ^2.4.2
  • cosmiconfig ^5.2.1
  • globby ^10.0.1
  • gradient-string ^1.2.0
  • signale ^1.4.0
  • node >=8.9.0
plugins/pages/layout-side/package.json
  • chalk ^2.4.2
  • cosmiconfig ^5.2.1
  • globby ^10.0.1
  • gradient-string ^1.2.0
  • signale ^1.4.0
  • node >=8.9.0
plugins/pages/materials/package.json
  • @zeit-ui/themes ^0.1.0
  • @zeit-ui/vue ^2.0.0-alpha.0
  • axios ^0.19.0
  • fs-extra ^8.1.0
  • gunzip-maybe ^1.4.1
  • jscodeshift ^0.6.4
  • pascalcase ^1.0.0
  • tar-stream ^2.1.0
  • vue-template-compiler ^2.6.10
  • node >=8.9.0
plugins/pages/microfrontends/package.json
  • @mapbox/rehype-prism ^0.3.1
  • @mdx-js/mdx ^1.0.21
  • @mdx-js/vue 1.0.20
  • @sindresorhus/slugify ^0.9.1
  • address ^1.1.2
  • axios ^0.19.0
  • boxen ^4.1.0
  • deepmerge ^4.0.0
  • docsearch.js ^2.6.3
  • front-matter ^3.0.1
  • fs-extra ^8.1.0
  • hash-sum ^2.0.0
  • headroom.js ^0.9.4
  • marked ^0.6.1
  • mdast-util-toc ^4.2.0
  • nprogress ^0.2.0
  • popper.js ^1.15.0
  • pretty-bytes ^5.2.0
  • prism-themes ^1.1.0
  • prismjs ^1.16.0
  • query-string 5
  • quicklink ^1.0.0
  • react ^16.8.6
  • react-dom ^16.8.6
  • regularjs ^0.6.2
  • rehype-slug ^2.0.3
  • resolve-from ^5.0.0
  • string-width ^4.1.0
  • text-table ^0.2.0
  • tippy.js ^4.2.1
  • unfancy-router 0.1.10
  • unist-util-visit ^1.4.1
  • webpack-stats-plugin ^0.3.0
  • ws ^7.1.2
  • node >=8.9.0
plugins/pages/runtime-vue/package.json
  • node >=8.9.0
plugins/vue-ssr/package.json
  • null-loader ^3.0.0
  • webpack-node-externals ^1.7.2
  • node >=8.9.0
templates/pages/package.json
  • cac ^6.5.3
  • jstransformer-handlebars ^1.1.0
  • sao ^1.7.0
  • node >=8.9.0
website/package.json
  • @zeit-ui/themes ^0.1.0
  • @zeit-ui/vue 1.3.1
  • vue >2.0.0

  • Check this box to trigger a request for Renovate to run again on this repository

ctx.homepage

Feature request

What problem are you trying to solve?

ctx.api.homepage.set is too long to remember

Describe the feature

use

// get
ctx.homepage
// set
ctx.homepage = 'pages/foo'

add search paths for pages

Feature request

What problem are you trying to solve?

some pages may be outside the src/pages folder

Describe the feature

add searchPaths option in nut.config.js

No config file found

Bug report

Version

@nut-project/[email protected]

Steps to reproduce

yarn nut create

What is expected?

No error

What is actually happening?

Error reported: No config file found

create should in the whitelist or let subclass do this manually

enhancements

Feature request

  • markdown theme 未找到时 warning

  • optimization 配置

    比如

      optimization: {
        layouts: [ 'now', 'none' ], // 默认打包全部内置layouts,如果指定,则只保留这里的layouts,也可以为 Boolean,true:引入所有layouts,false:不引入任何内置layouts
        icons: false, // 是否打包内置的icons
      }
  • 配置 renovate 只在周末提 pr,对应的配置文件,可以参考 renovate 官网 如何配置

很有意思!

看了这个项目感觉很有意思~我看应该还有一些可以完善的地方,有兴趣加我一个一起开发吗。微信同github名😊

nut 到底是个什么东西?

看示例,得知它是一个前端框架带有 UI。

你们还说它是一个微前端框架,为啥又有 markdown?集成进来做什么?文档里面又什么也没写。

到底是微前端还是前端?还是定义成一个大而全的包罗万象的东西?

麻烦大佬解惑。

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.