How to Create a Xircuits Project Template
In the tutorial, you've learnt on how to run a Xircuits project template. This guide will help you how to create your own. The recommended way is to use the repository project template.
Starting a New Xircuits Project from the Project Template
We have provided a Xircuits project template repository here. To use it:
- Navigate to the library template in your web browser. Select
Use this template.
- You will be prompted to create a new repository from
xircuits-project-template. Give it a name and whether you'd want to make it a public or private repository. Once done, select
Create repository from template.
- A new Xircuits project template should be created for you to clone.
And that's it! As a checklist, these are the things you would need to do:
- Add your Xircuits components to
- Add your workflows to
- Add your required python packages in
- Add your build commands in
- Update your readme for users.
Adding External Xircuits Component Libraries to the Project as Submodules
If you're using Xircuits component libraries that are also used in your other projects, we encourage you to modularize by keeping it as submodule repositories. You can refer to the previous guide on how to create a component library.
Once created, you can add it as a submodule by running:
git submodule add https://github.com/your_org/your_lib xai_lib_name
This will create a
.gitmodules file. Don't forget to commit it.
Finally in your
setup.sh, you can include these commands which will pull the component library:
git submodule init
git submodule update
Submitting the Project Template to Xircuits
If your project is something extendable and you'd like to share to the world, you are more welcome to submit it to our official Xircuits Project Template list.