Getting started

1. Create a copy of this template repository. Make sure you create it in the organization commit-app-playground as a Public repository.
   _{It must be both public and in the correct org in order to access deployment credentials from Github actions
   You will most likely need both a frontend and backend project, so you can pick a name that will make it easy to identify like <your project name>_frontend}

2. Edit the zero-project.yml and fill your project name into the name field. It must be alphanumeric and dashes only. Commit the change.
   _{Once the Github Action successfully runs you will no longer see this readme in your repository, but instead your own example project.}

3. Once you commit the change, Github Actions will be triggered and rewrite the repository.
   Only after this job runs can you check out this repository locally to begin work.

4. After the initial setup job runs, and after you merge new code to the main branch, the deployment ci job will run and deploy your code.

If your static site is a:

Single page app
_{(Typically a single index.html, eg. angular / react)}

Your application will be accessible via <name>.spa.onboarding.dev

Traditional static site
_{(Served as html files instead of a single index.html, eg. Next.js static site)}

The built static site will be available at <name>.static.onboarding.dev

---

Credits

_{- stefanbuck for the inspiration of using Github actions to template out a repo}