# Read Me

## Odi

TypeScript framework for creating enterprise-grade (web) applications with simple and minimalistic API, that allows you to focus on business logic. Based on declarative and imperative programming, inspiried by [ASP.NET](https://www.asp.net/) / [Spring](https://spring.io/).

Odi provides feature set for creation of easy supportable and scalable web applications.

Features Overview:

* [x] MVC
* [x] Full-typed DI / IoT
* [x] Authentication
* [x] WebSockets
* [x] TypeORM integration
* [ ] GraphQL
* [ ] GRPC
* [ ] CLI
* [ ] AOP
* [ ] SSR

For future updates check [Roadmap](https://github.com/Odi-ts/Odi/wiki/Roadmap)

{% content-ref url="/pages/-LPLPBFaYPLkfvc-3D28" %}
[Getting Started](/core/basics/getting-started.md)
{% endcontent-ref %}

### Example

```typescript
import { Controller, IController, Post, Get, Autowired } from "odi";
import { TodoService } from "./todo.service";
import { TodoDTO } from "./todo.dto";

@Controller()
export class TodoController extends IController {

   @Autowired()
   todoService: TodoService;

   @Get index() {
       return `Hello, ${this.request.ip}`;
   }

   @Post async save(toDo: TodoDTO) {
       await this.todoService.save(toDo);
   }
   
   @Get async '/:id' (id: string) {
       const todo = await this.todoService.find(id);
       
       if(!todo) 
         throw NotFound;
       
       return todo;
   }
}
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://odi.gitbook.io/core/master.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.