- Open your app's Deployment tab (create an account and a new app first, if you haven't already) and click "Connect GitHub".
- Log in to GitHub and authorize the FridayBuilds GitHub app.
- Install the FridayBuilds GitHub app on your personal account or organization.
- Choose whether it can access all of your repositories, or only the ones you want to deploy.
You can connect more accounts or organizations later with "Add Account/Organization" in the account selector. If a repository doesn't show up in the list, check the app's repository access in your GitHub settings, then click the sync button next to the repository label.
- Select the account/organization and the repository you want to deploy, then click "Fetch Repository".
- Choose the branch you want to deploy (and the build directory, if you are working with a monorepo).
- Optionally, add any environment variables your app needs.
Make sure your app has everything it needs to start — like a database (add one in the Services tab) or ENV variables (set them in the Settings tab).
Click "Deploy now" to start your first deployment.
From then on, every push to the selected branch on GitHub will trigger a new deployment automatically. No extra git remote needed.
The first time you deploy your app, FridayBuilds will issue an SSL Certificate for your app's default domain. When that process is complete, you can move on to run any final setup for your app.
If the deployment fails you can inspect the deployment log on the Activity page. After you fix any issues you can push again or redeploy manually from the Deployment tab.
fridaybuilds_cli is a simple gem that provides authentication with your FridayBuilds account, directly from your terminal.
- Install fridaybuilds_cli gem
gem install fridaybuilds_cli- Log in using your FridayBuilds credentials
friday loginThe command above will try to open a browser window to the FridayBuilds CLI login page. If the page does not open automatically, your terminal will provide the url where you can log in.
After successfully logging in, the program will save the generated credentials to your .netrc file. You can manage these credentials on your account settings page.
You can add credentials manually to your .netrc file. The .netrc file is located, or should be created at ~/.netrc on Ubuntu, Mac or Windows WSL.
- Create a new Access Key
In the Account & Security tab on your Account & Billing page, click "New Access Key", then "Create Access Key". Reveal and copy the access key's "Content" field and use it in place of YOUR_ACCESS_KEY_CONTENT, in the template below. Replace YOUR_MAIL_ADDRESS with the mail you use to log in to FridayBuilds.
- Open .netrc file
nano ~/.netrc- Add your credentials
# ~/.netrc
machine git.fridaybuilds.com
login YOUR_EMAIL_HERE
password YOUR_ACCESS_KEY_CONTENT
- Save changes (ctrl+X to close file, then Y to save)
- In your terminal, navigate to your project's directory.
- Make sure your project has an initialized git repository, with at least one commit.
- Add a git remote pointing to your fridaybuilds repository
git remote add fridaybuilds https://git.fridaybuilds.com/YOUR_APP_SLUG.git
Make sure your app has everything it needs to start — like a database (add one in the Services tab) or ENV variables (set them in the Settings tab).
Then you can just push your code. The build process will be triggered only when pushing a main or master branch
git push friday mainThe first time you deploy your app, FridayBuilds will issue an SSL Certificate for your app's default domain. When that process is complete, you can move on to run any final setup for your app.
Congrats! Your app should be deploying now. Your app's status is visible on the upper part of any app-related page.
If the deployment fails you can inspect the deployment log on the Activity page. After you fix any issues you can push again or rebuild manually from the Settings page.