Intro
Welcome to HeliosJS! This tutorial will guide you through building your first application step by step.
What You'll Build
By the end of this tutorial, you'll have a working REST API for a task management system with:
- ✅ Create, read, update, and delete tasks
- ✅ Input validation
- ✅ Error handling
- ✅ Clean architecture using decorators
What You'll Learn
- How to set up a HeliosJS project
- How to create controllers with decorators
- How to define routes using
@Get,@Post,@Put,@Delete - How to handle request data (
@Body,@Param,@Query) - How to use middleware, plugins, sanitizers, etc..
- How to handle errors with
@Catch
Prerequisites
Before you start, make sure you have:
- Node.js 20 or higher
- npm or yarn installed
- Basic knowledge of TypeScript/JavaScript
- A code editor (VS Code recommended)
Tutorial Structure
This tutorial is divided into several parts:
| Part | Topic | What you'll do |
|---|---|---|
| 1 | Installation & Setup | Create a new project and install HeliosJS |
| 2 | Your First Controller | Create a controller with basic routes |
| 3 | Routing & Parameters | Handle dynamic routes and request data |
| 4 | Validation | Validate incoming data |
| 5 | Error Handling | Handle errors gracefully |
| 6 | Middleware | Add logging, CORS, and other middleware |
Getting Help
If you get stuck:
- Open an issue on GitHub
Ready to Start?
Let's build something amazing! 🚀
Next: Installation & Setup
Estimated time: 15-20 minutes per part Total tutorial time: About 2 hours