Let’s create your first CodeSpeak app on GitHub.

<aside> ⚠️

This is an invite-only alpha. If you are reading this, you’ve probably received an invite from us, gave us your GitHub user id, and we’ve added it to the Private Alpha guest list. If you haven’t been invited yet, you may need to wait for a future release.

</aside>

If you have been added to our guest list, follow these steps.

1. Create a new repo from our template

We prepared a minimal template repo (see below) that you should always start with while using this Private Alpha. Creating an empty repo and installing the CodeSpeak App won’t work.

Note: This is a template, so it’s not to be forked. Use the link below to create a copy.

CodeSpeak can work with both public and private repos, so feel free to pick whichever one you like. The template creates a very simple repo with the following structure:

├── .github/workflows/upload-secret.yml
├── .gitignore
├── README.md
├── codespeak.json
└── spec
    └── main.cs.md

For your convenience, the setup guide is located in the README.md file in the template, so it will appear in your new repo immediately upon creation. Follow the instructions in the readme to do the following set up the build and edit your first spec:

The links in the repo are useful shortcuts to GitHub configuration

After the initial setup, follow the guide in the README.md to

• edit the spec
  • the default template contains a spec for an example ToDo app in <!-- ... --> comments; we recommend that you start by un-commenting it and following the instructions
• get the build results (see screenshots below)
• run the code

Here’s the template:

➡️➡️➡️ Create a new repo (private or public) from our template

2. Your first spec

The spec lives in spec/main.cs.md file (shortcut link is in the README.md):