This repository is a yarn workspace made of 1 package reactus, which is already published to NPM as reactus. It supports both cjs and esm based projects by providing an cjs and esm folder made using a build script, then configuring the type (set to module), export map, import map, require map, and type maps in reactus/package.json.
The following folders and files are found in the root of the project.
docs- The official documentation of the project.examples- Various working examples project templatesreactus- The source code for the relative work involved.
Please ignore the following folders:
archivesreactus/.nyc_outputreactus/coverage
In this project we use yarn to execute scripts. Please do not use npm.
We use package.json to call scripts from packages like so.
yarn build- generates the esm and cjs versions of the reactus frameworkyarn test- runs the tests found inreactus/tests
Before running any scripts in terminal, make sure the session is using NodeJS 22. nvm use 22.
Great usage examples can be found in the following folders in the examples folder.
examples/with-express/scriptsexamples/with-fastify/scriptsexamples/with-http/scriptsexamples/with-tailwind/scriptsexamples/with-unocss/scripts
When creating documentation please use the root docs folder. Do not add documentation in the reactus folder.