Hey mate, thank you for landing here!
Try It Out:
The easiest way to start with ForrestJS is to see it in action on CodeSandbox:
- NodeJS with Fastify demos:
- ReactJS demos:
What You Get
- Modular and interoperable architecture perfectly suited for micro-services and micro-frontends
- App's Lifecycle Extensions help coordinate the booting procedures
- Modules composition traceability and reporting
- Configuration API
- Context API
- Ready-to-use services available on NPM
🤓 This is one of the many opinionated setup available on the web. It's mine, my own, my precious... No kidding, this is simply how I believe any modern web app should be organized to maximize productivity and improve the Developer's Experience.
👉 Although this is by all means my own understanding of the modularity challenge, I did my best to use exclusively existing and well known open source projects, and limited my own coding to the bare minimum.
This package is quite stable. Yet, I'm still actively working on it and you can expect new features and slight changes in the APIs.
I follow the semantic versioning practice, so you can expect breaking changs whenever you see a bump in the major version. In all the other cases I take extreeme care in respecting retro-compatibility.
Nevertheless I'm already using it in production, and I know quite a few companies who trust ForrestJS (and me, thanks mates 🙏) for their business-related projects.
🤝 I commit to do my best in preserving backward compatibility and keep it up-to-date with new versions of the few dependencies that we use.
WANNA HELP ME?
All the documentation is part of the main repository.
You can go back in time and navigate the repo and the documentation for each release:
You should know...
I wrote this documentation for the mid-experienced engineer. It's an evolving project and you may need to resolve to the source code to fill the gaps of what I have documented so far.
I tested this documentation quite well, but bugs will always to be found!
Please report them as new issues.
Let' cut it short; here is the list of the things that you should be already acquainted with:
- NodeJS, NPM, Yarn
- Fastify (or similar middleware based tool)
I don't expect you to be an expert on all those tools, but it would be so good if you have a basic understanding of how to use them.
Copyright 2020 Marco Pegoraro
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.