diff --git a/website/docs/documentation.mdx b/website/docs/documentation.mdx index 371972a..56ee027 100644 --- a/website/docs/documentation.mdx +++ b/website/docs/documentation.mdx @@ -17,17 +17,10 @@ your project. In fact, this very website you're viewing now has been built with ## Install `@flecks/dox` -To get started, install `@flecks/dox` in your project: +To get started, add `@flecks/dox` to your project: - - -Then, add it to your `build/flecks.yml`: - -```yml -'@flecks/core': {} -// highlight-next-line -'@flecks/dox': {} -'@flecks/server': {} +```bash +npx flecks add @flecks/dox ``` ## Spin up a starter website @@ -81,7 +74,7 @@ It's only a starter template, of course. You'll want to pop over to [the Docusaurus guides page](https://docusaurus.io/docs/category/guides) to build out your new website. Have fun! -## Production-ready +:::tip[Ready to roll out!] When you're ready to build for production, just run @@ -90,3 +83,5 @@ npx flecks docusaurus build ``` After successfully building, your website files will be located at `dist/dox`. + +::: diff --git a/website/docs/introduction.mdx b/website/docs/introduction.mdx index 5f35c61..213ffc1 100644 --- a/website/docs/introduction.mdx +++ b/website/docs/introduction.mdx @@ -9,7 +9,7 @@ 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 [running flecks on your toaster](#todo) +๐Ÿ’ฅ 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 is to make application development a more joyful endeavor. Intelligent defaults combined with @@ -22,23 +22,22 @@ 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 and then your own -- ๐Ÿ› ๏ธ **Ready to build real applications** - - babel + Webpack 5 - - [React](#todo)/[redux](#todo) - - [Database](/docs/database) - - [electron](#todo) - - [docker](#todo) + - 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/... + - [React](#todo) / [redux](#todo) + - [Realtime sockets](./sockets) with lots of goodies like binary packing and packet dispatching + - [Databases](./database) using [Sequelize](https://sequelize.org/) to connect and [Docker](https://www.docker.com/) to easily persist + - [Electron](#todo) + - [Docker](#todo) - [REPL](#todo) - - [websockets](#todo) with lots of goodies like binary packing and packet dispatching out of the box - - [docusaurus](#todo): This documentation website you're looking at, [available to your own apps for your own documentation](/docs/documentation) + - babel + Webpack 5 - ๐Ÿ‘ท **Developers, developers, developers** - - ๐Ÿช„ Easy to create a fleck; no need to publish packages or use voodoo - - Write server or client (or both) tests, run on server/in browser/[your own custom platform](#todo) + - Easy to create a fleck; no need to publish packages or use voodoo - HMR (even on the server) - - [redux slices](https://redux-toolkit.js.org/api/createslice/) provided through hook! - - Easily spin up a database or redis server ([or...](/docs/flecks/@flecks/dox/hooks#flecksdockercontainers)) using [Docker](#todo) during development, and generate a `Dockerfile` and `docker-compose.yml` automatically for production - - Small hookable core means less exposed wires. You could always help by [submitting a pull request](https://github.com/cha0s/flecks/compare) though. + - Configured to get instantly up and running with a consistent path toward production Our shared goalโ€”to help you quickly develop your application. We share our best practices to help you build your application right and well. diff --git a/website/docs/testing.mdx b/website/docs/testing.mdx new file mode 100644 index 0000000..08b21c5 --- /dev/null +++ b/website/docs/testing.mdx @@ -0,0 +1,7 @@ +--- +title: Testing +description: flecks makes testing easy across platforms. +--- + +# Testing + diff --git a/website/sidebars.js b/website/sidebars.js index e0b3434..09968ba 100644 --- a/website/sidebars.js +++ b/website/sidebars.js @@ -25,6 +25,7 @@ export default { items: [ 'cli', 'environment', + 'testing', 'database', 'sockets', 'react',