v8 (v7 Rails v1 Django)
Getting Started
Reference Guide
Development workflow
Forest Admin lets you get started easily, but soon you'll be wondering how to set up a clean workflow to control every step of your development process.
The following workflow requires that you have generated your project and pushed it to Production. If it's not the case, check out our setup guide.
If you created your project before May 10th, 2021 and want to benefit from this feature, please contact Forest Admin support to ask for it to be "ready to migrate".
Here's our recommended development workflow:
Step 1: Install forest-cli
We've developed a CLI tool to help you seamlessly control your layout (UI) as you develop. You should first install it:
1
npm install -g forest-cli
Copied!
Step 2: Set up your development environment
This step is not necessary if you are the creator of the project, as your development environment is already generated.
To get started with forest-cli, simply run the following command in your project's folder:
1
forest init
Copied!
This will create a development environment for you to develop locally in.
Step 3: Create a branch
Got a new feature to develop? Create a branch!
1
forest branch my-new-feature
Copied!
Your new branch is now available with a layout you can play with.
Step 4: Develop your feature
Your feature may require frontend (layout) and backend changes.
Step 5: Deploy
Your feature works as intended on your local branch? You now need to deploy it to your production environment:
- Deploy backend changes (if any) using your usual workflow
- Deploy frontend changes using the following command:
1
forest deploy
Copied!
...then select your development environment and hit Enter.
That's it! Your new feature is now available in production 🎉
Want to add a testing phase before you deploy to production? Check out how to create a staging environment and how to push changes onto it.
Last modified 6mo ago