Linking with Github Repository

Learn about linking a Codelessly project with a Github repository for custom deployment and publishing.

Codelessly supports Cloud UI publishing and deployments with a Github Repository. You can link your Github account with Codelessly and allow Codelessly to create a repository on your behalf and push starter code for website publishing.

Benefits

• You can choose your own deployment pipeline and third-party provider for it.

• This enables you to use a custom domain for your website (if your third-party provider allows it)

• Includes pre-built website so you just have to publish and you're done.

• Also includes Flutter code if you wanna build it and then deploy on different platforms including web.

What this repository will include?

The repository we create will contain

1. A fully configured Flutter project: You can then integrate it into your build pipeline (e.g. CodeMagic, Github Actions, Bitrise, etc) to build the Flutter project and publish your app/website.

2. A pre-built bundle of your website: You can use it directly to publish on services that support static website publishing like Netlify, Vercel, or any other third-party service you want to use.

Get Started

Let's get you set up with Github repository for your project.

Connecting with Github

1. Open Codelessly editor and head to Settings>Github Integration. and

2. Click on Connect to Github button. It will open a webpage for you to authenticate your Github account with Codelessly.

3. Once you authenticate, it will ask you to Install our Github app: Codelessly App. Please finish the installation.

4. Once finished, head back to Codelessly editor and you will see that you're authenticated now. It will show your user name and avatar instead of Connect to Github button.

You have successfully connected your Github account with Codelessly. 🎉

Note: Codelessly Github App is required for this to work. Avoid uninstalling it changing its permissions unnecessarily.

Linking Project with Github Repository

After you connect Codelessly with your Github account, you need to link your project to a specific repository on Github so we can push code and updates and set everything up for you.

1. Open a project that you want to connect to a Github repository.

2. Click on arrow button next to publish button and click on Go to Settings.

Opening publish settings for a project.

3. Go to Website tab. You will see Link Project with Github section.

4. Select owner of the repository from the dropdown. You can add organizations by clicking on Add Another Organization button in the selection dropdown and it will prompt you to install our Github app for the organization you want to use for this.

5. Specify a repository name for your project. Codelessly will take care of creating the repository and pushing code for you.

6. Hit Save & Link button to let Codelessly create the repository and link it with your project.

7. Once it succeeds, you can click on button next to repository name input to open your linked repository.

See deployment docs for proceeding further with your Github repository.