protontype/README_pt-BR.md

A simple REST framework make in TypeScript

**Português** / [English](README_en.md)
# ProtonType 

<div align="center">
  <a href="https://protontype.github.io/">
    <img src="https://avatars1.githubusercontent.com/u/34164645?s=200&v=4">
  </a>
  <br>
  <br>
	<a href="https://travis-ci.org/protontype/protontype">
		<img src="https://travis-ci.org/protontype/protontype.svg?branch=develop">
	</a>
	<a href="https://www.npmjs.com/package/protontype">
		<img src="https://badge.fury.io/js/protontype.svg">
	</a>
  <br>
  <br>
</div>

Um simples web framework feito em TypeScript.

Construa suas APIs NodeJs com Classes, Metodos, Annotations, ORM ...

## Documentação
- [Documentação completa](https://protontype.github.io/)

## Instalação
```bash
npm install protontype --save
```
 
## Models
Usa [TypeORM](http://typeorm.io/#/) por padrão para manipulação de banco de dados. Mas pode ser usado qualquer framework.

```typescript
@Entity()
export class TasksModel {
    @PrimaryGeneratedColumn()
    id: number;
    @Column({ nullable: true })
    title: string;
    @Column()
    done: boolean;
    @Column()
    userId: number;
}
```
## Middlewares
Suporta implementação de middlewares

```typescript
export class TasksMiddleware extends BaseMiddleware {
    @Middleware()
    printTaskTitle(params: MiddlewareFunctionParams) {
        cosole.log(params.req.body.title);
        params.next();
    }
}
```

## Router
Rotas básicas de CRUD já implementadas nos ```CrudRouter```

```typescript
 @RouterClass({
    baseUrl: "/tasks",
    model: TasksModel,
    middlewares: [new TasksMiddleware()]
})
export class TasksRouter extends CrudRouter {
    /*
    GET / - Lista todos registros
    POST / - Cria um registro
    GET /:id - Consulta um registro
    PUT /:id - Atualiza um registro
    DELETE /:id - Remove um registro
    */

    //Novas rotas customizadas ....
}
```

Ou pode implementar rotas customizadas
```typescript
 @RouterClass({
    baseUrl: "/tasks",
    model: TasksModel,
    middlewares: [new TasksMiddleware()]
})
export class TasksRouter extends BaseRouter {
    @Route({
        endpoint: '/test/msg',
        method: Method.GET,
        middlewares: [new OtherMiddleware()]
    })
    routeTest(params: RouterFunctionParams) {
        console.log("Hello!");
    }
}
```

## Acessando o banco de dados
```typescript
let tasksRepository = TypeORMDB.getBD().getRepository(TasksModel);
let tasks = await tasksRepository.find();
``` 

## Iniciando a aplicação

```typescript
new ProtonApplication()
    .addRouterAs(TasksRouter)
    .addMiddlewareAs(SomeoneGlobalMiddleware)
    .start();
```

## Exemplos
- [Exemplo básico](https://github.com/protontype/protontype-sample)

- [Exemplo com o módulo do Sequelize](https://github.com/protontype/protontype-sequelize-sample)

## Versão de desenvolvimento
```bash
npm install protontype@dev --save
```