Comment on page

Next steps

Congratulations on creating your first exbuilder project! Here are some suggestions for what to do next.

Create a repo for your project

Create a repository for your project on a repository manager like GitHub or GitLab. Once created, you can set your project's origin to your new repository's url with git, which will allow you to push your local project files to your new repo! To do this in the terminal, from your project directory, run
git remote set-url origin http://github.com/you/your-repo-name
Then, whenever you make changes to your project on your local computer, you can push them to this repository with
git add .
git commit -m "inital commit"
git push origin main
If you are new to git and repository managers like GitHub, we recommend this nice tutorial by Karl Broman. If you make mistakes, don't worry, we all do. We recommend Oh, Shit! Git!?! to get you through it. Or, Dangit, Git !?! for the "same content without the swears".

Edit the readme file

The next thing you might want to do is edit the README markdown file in your main project directory.
The README.md file is in your main project directory
If you aren't sure what to include, we suggest including at least: (1) your project's title, (2) authors, (3) a brief description, and (4) instructions for starting your project's containers. Here is a sample readme file to show you how this might look.

Work on your project!

Directory Structure

Next you might want to check out the Directory Structure for an overview of what is included in your exbuilder project.

Project components

After that, you can work through each of the Project Components.

Deploy your web experiments

If your project includes web experiments and you want to deploy them to your own server, you can use exbuilder deployer to deploy your experiments inside their docker container. You can read more about how to setup a server with exbuilder deployer in the Deployment section.