ForrestJS provides a set of utilities and starter kits inspired by GatsbyJS, but with the purpose of creating Universal PWAs that can run on server, browser and Cordova native wrappers within the same codebase.
But it’s easier done than explained.
Open your terminal (we tested this on a Mac so far) and type:
npx forrest run my-project
In less than a minute (it depends on your machine and connectivity) you should have a service running on port 8080:
And it should be equivalent to the demo that is hosted on Heroku: https://forrest-starter-universal.herokuapp.com/
Digging into the newly created project (
cd ./my-project) we can see that the folder structure is an
extension of Create React App.
In fact, this project has been created out of the default starter kit called starter-universal: if you are familiar with CRA, then you can build on ForrestJS!
Here is a brief list of what comes just out of the box:
- Redux Thunk
- Redux Features
- React Router
- React Loadable
- React INTL
- Styled Components
- Server-Side Rendering
- React Styleguidist
- Development and Production scripts
- Dockerfile (run the app as a container)
- Helper scripts to run your app for free on Heroku
- Makefile to run ‘em all
I feel this is a solid starting point for any web project, but at its core, it is still a CRA project. So if you ever used Create React App, you know how to deal with it.
We borrowed the concept of a STARTER KIT from GatsbyJS (more about it later). A starter is nothing more than a Git repository that functions as a foundation for a specific type of project.
When you type
npm forrest run xxx you are going to use the default
which is just a starter hosted on GitHub that I’m personally developing and curating.
More default starters will come as part of the default ForrestJS distribution, but the thing is that you can build your own starter and host it on GitHub. When you want to kick off a new project based on your own starter just run:
npx forrest run project-name -t @username/repository
(At the moment the CLI assumes you host your stuff on GitHub, we have plans to make it more generic so to support GitLab and any kind of URL).
It should be quite obvious so far that I like Create React App (well, at least the extensible version provided by react-scripts-rewired), but it is not the only great project that I took inspiration from!
GatsbyJS is produced by the guys behind Netlify and it is the open source component of their commercial offering.
ForrestJS project’s structure is heavily inspired by GastbyJS as I use a monorepo the way they do (we both use Lerna to handle it), and I definitely borrowed the concept of a starter kit from Gatsby.
Whek, it works wonders for them, it will work wonders for ForrestJS!
NextJS offers an incredibly smooth experience in building server-side rendered websites.
NextJS is produced by the guys behind Now.sh and it is the open source component of their commercial offering. You can build on NextJS and hosting for free on a pure serverless environment with Now.sh (well, “free” in sense of “free beer” if you can share that beer with anyone else).
Unfortunately, NextJS is limited to the web platform only and their Server-Side Rendering cannot be opted out. Plus there are some performance issues due to their hard routing choices bound to the serverless… Long story short I believe NextJS is great for a website, but not for a PWA.
Anyway, they have a wonderful developer onboarding experience that I aim to mimic in ForrestJS.
Looking ahead I aim to curate the documentation as much as my schedule allows, review Pull Requests from all of you contributors, and write some more step-by-step articles here on my blog.
Your feedback is the most important Component for this project!