chore: dox
This commit is contained in:
parent
07fc7388a7
commit
983da24efa
|
@ -1,7 +1,7 @@
|
|||
<div align="center">
|
||||
<h1>flecks</h1>
|
||||
<p>
|
||||
Flecks is an exceptionally extensible fullstack application production system. Its true purpose
|
||||
flecks is an exceptionally extensible fullstack application production system. Its true purpose
|
||||
is to make application development a more joyful endeavor. Intelligent defaults combined with
|
||||
a highly dynamic structure encourage consistency while allowing you to easily express your own
|
||||
opinions.
|
||||
|
@ -85,9 +85,9 @@ Just to give you an idea of the power of hooks, some will be listed here:
|
|||
|
||||
### The `build` directory
|
||||
|
||||
Flecks applications contain a `build` directory with a `flecks.yml` that defines the flecks use to compose the project, as well as build-time configuration.
|
||||
flecks applications contain a `build` directory with a `flecks.yml` that defines the flecks use to compose the project, as well as build-time configuration.
|
||||
|
||||
Flecks strives to provide powerful defaults that minimize the need to override configuration.
|
||||
flecks strives to provide powerful defaults that minimize the need to override configuration.
|
||||
|
||||
The simplest example of a flecks server application:
|
||||
|
||||
|
|
|
@ -21,8 +21,8 @@ The most basic usage:
|
|||
const Gathered = flecks.gather('@my/fleck.whatever');
|
||||
```
|
||||
|
||||
Suppose `@my/fleck.whatever` above resulted in gathering two classes, `Foo` and `Bar`. In this case,
|
||||
`Gathered` would be structured as:
|
||||
Suppose the flecks implementing the hook `@my/fleck.whatever` above returned two classes, `Foo` and
|
||||
`Bar`. In this case, `Gathered` would be structured as:
|
||||
|
||||
```javascript
|
||||
import {ById, ByType} from '@flecks/core';
|
||||
|
@ -119,7 +119,7 @@ reduce this maintenance burden for you.
|
|||
|
||||
Webpack provides an API called
|
||||
[require.context](https://webpack.js.org/guides/dependency-management/#requirecontext) which
|
||||
imports many files with a pattern. A call like this:
|
||||
imports many files with a pattern.
|
||||
|
||||
Supposing our fleck is structured like so:
|
||||
|
||||
|
|
|
@ -9,12 +9,10 @@ slug: /
|
|||
|
||||
💸 Save time and money and don't duplicate effort. Instead, **lean on infrastructure that already exists** to solve your problems.
|
||||
|
||||
💥 Ready for more? Use **advanced features** like [inter-node socket communication](./sockets#intercom).
|
||||
|
||||
🧐 Flecks is an **exceptionally-extensible fullstack application production system**. Its true purpose
|
||||
🧐 flecks is an **exceptionally-extensible fullstack application production system**. Its true purpose
|
||||
is to make application development a more joyful endeavor. Intelligent defaults combined with
|
||||
a highly dynamic structure motivate consistency while allowing you to easily express your own
|
||||
opinions.
|
||||
architectural opinions.
|
||||
|
||||
## Features {#features}
|
||||
|
||||
|
@ -23,7 +21,6 @@ flecks is built with supreme attention to the developer and end-user experience.
|
|||
- 🧩 **Small but pluggable**
|
||||
- The simplest application is two flecks, `core` and `server`: you don't pay for what you don't buy
|
||||
- Endlessly configurable through built-in [hooks](./flecks/@flecks/dox/hooks) and then your own
|
||||
- Less exposed wires (though you could always help by [submitting a pull request](https://github.com/cha0s/flecks/compare)).
|
||||
- 🛠️ **Ready to build maintainable and performant production applications**
|
||||
- [Documentation website](./documentation) generation for your project with no fuss
|
||||
- [Write tests](./testing), run on server/in browser/...
|
||||
|
|
Loading…
Reference in New Issue
Block a user