\r\n\r\nTypeScript 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/). \r\n\r\n**Check [Docs](https://odi.gitbook.io/core/basics/getting-started) for more details.**\r\n\r\nOdi provides feature set for creation of easy supportable and scalable web applications.\r\n\r\nFeatures Overview:\r\n - [x] MVC\r\n - [x] Full-typed DI / IoT\r\n - [x] Authentication\r\n - [x] WebSockets\r\n - [x] TypeORM integration\r\n - [ ] GraphQL\r\n - [ ] AOP\r\n - [ ] SSR\r\n \r\nFor future updates check [Roadmap](https://github.com/Odi-ts/Odi/wiki/Roadmap) \r\nGot an idea, proposal or feature request? Feel free to [Submit](https://odi.nolt.io/) it!\r\n\r\n[](https://codesandbox.io/s/pjov89947x)\r\n \r\n## π Getting Started \r\n1. Install npm package \r\n `npm install odi --save`\r\n\r\n2. Install reflect-metadata \r\n\t `npm install reflect-metadata --save`\r\n\t\r\n3. Import reflect-metadata (for example in `index.ts`): \r\n\t `import \"reflect-metadata\";`\r\n\t\r\n4. Enabled the following settings in `tsconfig.json`\r\n\t```json\r\n\t\"emitDecoratorMetadata\": true, \r\n\t\"experimentalDecorators\": true\r\n\t```\r\n\r\n## πͺ Overview\r\n\r\n### Controller\r\nControllers serve as a simple yet powerful routing mechanism in a minimalistic style.\r\n\r\n```typescript\r\n@Controller('foo') \r\nexport class FooController extends IController { \r\n \r\n @RoutePatch('{id}') \r\n bar(id: string, payload: FooDTO) { \r\n ...some updates.. \r\n return Ok(); \r\n } \r\n\r\n @Get index() {\r\n return 'Foo';\r\n }\r\n} \r\n```\r\n\r\nSo, as you see, there no need to provide any additional param decorators for injection data from the HTTP request. It's just a small controller overview, there are a lot of other possibilities.You can read more in [docs](https://odi.gitbook.io/core/basics/controller).\r\n\r\n\r\n### Dependency Injection\r\nOdi has powerful dependency injection mechanism out of the box. \r\n(Let's imagine that we already have `FooRepository`)\r\n\r\n```typescript\r\n//foo.service.ts\r\n@Service()\r\nexport class FooService {\r\nβ\r\n @Autowired()\r\n repository: FooRepository;\r\nβ\r\n public getFoo(id: string) {\r\n return this.repository.findOne(id);\r\n }β\r\n}\r\n\r\n\r\n//foo.controller.ts\r\n@Controller('foo')\r\nexport class OrderController extends IController {\r\nβ\r\n @Autowired()\r\n fooService: OrderService;\r\n \r\n @Get async '{id}' (id: string) {\r\n const foo = this.fooService.getFoo(id);\r\n \r\n if(!foo)\r\n return NotFound();\r\n\r\n return foo;\r\n }β\r\n} \r\n```\r\n\r\nAs you can see, all dependencies will be automatically provided to all application components.\r\n\r\nCurrently, Odi support 3 ways of injection: \r\n* By constructor\r\n* By property\r\n* By method\r\n\r\nClasses that are not Odi components can participate in DI. You can simply define behaviour with preset properties and constructor args.\r\n\r\n```typescript\r\nclass Pet {\r\n ...\r\n}\r\n\r\nβdefine(Pet)\r\n .set('default', {\r\n constructorArgs: [...], \r\n props: {...},\r\n type: 'singleton'\r\n })\r\n .set('special', {\r\n constructorArgs: [...], \r\n props: {...},\r\n type: 'scoped'\r\n });\r\n```\r\n### DTO\r\nIt's a common scenario when web server should validate data before processing. DTO can optimize and automate this process.\r\n\r\n```typescript\r\n@Data()\r\nexport class TodoDTO {\r\n \r\n @MaxLength(80)\r\n title: string;\r\n \r\n @IsOptional()\r\n @MaxLength(255)\r\n desctiption: string;\r\n}\r\n```\r\n\r\nThen, DTO class should be added as an argument for the controller method\r\n\r\n```typescript\r\n@Controller('todo')\r\nexport class TodoController extends IController {\r\n\r\n @Autowired()\r\n todoService: TodoService; \r\n \r\n @Post async index(payload: TodoDTO) {\r\n ...\r\n }β\r\n}\r\n```\r\nAnd it's all! Odi will automatically inject the validated request body in this argument. If there are some errors during validation, 400 status code will be sent with errors description.\r\n\r\nOdi provides a wide set for DTO description, supporting nested DTOs, arrays, enums and etc.\r\n\r\n### To Sum up\r\nIt was a small overview of some features. If you interested in more, check the [Docs](https://odi.gitbook.io/core/).\r\n\r\n \r\n## Contributing\r\nPull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.\r\n\r\nPlease make sure to update tests as appropriate.\r\n\r\n## License\r\n[MIT](https://choosealicense.com/licenses/mit/)\r\n","readmeFilename":"README.md","description":"πͺπ Opinionated, Declarative, Idiomatic framework for building scalable, supportable, enterprise-grade applications.","keywords":["typesciprt","web","server","DI","enterprise","esnext","backend"],"author":{"name":"Dan Tsekhmastryuk"},"homepage":"https://github.com/Odi-ts/Odi#readme","repository":{"type":"git","url":"git+https://github.com/Odi-ts/Odi.git"},"bugs":{"url":"https://github.com/Odi-ts/Odi/issues"}}
![](\"https://i.imgur.com/4Zf3O35.png\")
![](\"https://img.shields.io/npm/v/odi.svg\")
\n\t![](\"https://img.shields.io/github/license/Odi-ts/Odi.svg\")
\n\t![](\"https://img.shields.io/depfu/Odi-ts/odi.svg\")
\n\t![](\"https://img.shields.io/github/last-commit/Odi-ts/Odi.svg\")
\n\t![](\"https://travis-ci.com/Odi-ts/odi.svg?branch=master\")
\n![](\"https://img.shields.io/gitter/room/nwjs/nw.js.svg\")
\r\n\t\r\n