Tutorial: TODO List App

Learn Castor by building a TODO list application. This hands-on tutorial walks you through requirements, diagrams, code generation, and round-trip synchronization.

Introduction & Setup

In this tutorial, you'll learn how to use Castor by working with a TODO list project. You'll start with existing requirements, generate diagrams and code, add new features, and see how Castor keeps everything synchronized.

Prerequisites:

  • Storage: 1.3GB free space
  • Memory: 4GB minimum (8GB recommended)
  • Operating System: macOS 10.15+ or Windows 10/11
  • Castor Account: Create an account if you don't have one
  • Git: Installed on your machine

Before you begin:

Clone the Demo Project

We've prepared a TODO list demo project that has some requirements already defined. You can clone it using one of these methods:

Option 1: Clone from Terminal

git clone https://github.com/JustinSciortino/castor-todo-demo.git

Then open the folder in Castor via File → Open Folder.

Option 2: Clone from within Castor

  1. Copy the repository URL: https://github.com/JustinSciortino/castor-todo-demo.git
  2. Open Castor IDE
  3. Press Ctrl+Shift+P / Cmd+Shift+P to open the Command Palette
  4. Type Git: Clone and select it
  5. Paste the repository URL and press Enter
  6. Choose a folder to clone into and click Select as Repository Destination
  7. When prompted, click Open to open the cloned project

About the Demo Project:

This is a NestJS TODO list application. It comes with a requirements.md file containing 3 requirements: Create Task, View All Tasks, and Mark Task as Complete. You'll use Castor to generate the design, diagrams, and code from these requirements.

1 of 11