@syntay/fastay 0.1.1 → 0.1.3

package/README.md

@@ -1,5 +1,3 @@
-Perfeito! Aqui está a versão completa do README traduzida para português, mantendo o estilo e explicações detalhadas:
-
 # 🚀 Fastay.js
 
 Fastay é um framework moderno para backend construído sobre o **Express.js**, projetado para criar APIs de forma rápida, previsível e amigável para desenvolvedores.
@@ -29,24 +27,32 @@ O maior ponto forte é **rapidez e simplicidade**, ideal para projetos de backen
 
 ```bash
 npx fastay create-app minha-app
+```
 
 Exemplo do CLI:
-
+```bash
 🚀 Fastay — Create a modern backend project
 ✔ Usar TypeScript? › Sim
 ✔ Escolha um ORM: › Nenhum
-
+````
 2. Entrar no projeto
-
+```bash
 cd minha-app
-npm run dev       # Iniciar servidor em desenvolvimento
-npm run dev:watch # Modo watch com reload automático
+```
+3. Iniciar servidor em desenvolvimento
+```bash
+npm run dev 
+```
+4. Modo watch com reload automático
+```bash
+npm run dev:watch 
+```
 
 
 ---
 
 Estrutura do Projeto
-
+```bash
 minha-app/
 │
 ├── dist/                     # Código compilado para produção
@@ -78,29 +84,30 @@ minha-app/
 ├── package.json
 ├── tsconfig.json
 └── eslint.config.mjs
+```
 
 Explicação das pastas principais:
 
-src/api — Cada pasta representa um grupo de rotas. Todo route.ts dentro é registrado automaticamente.
+`src/api` — Cada pasta representa um grupo de rotas. Todo route.ts dentro é registrado automaticamente.
 
-src/middlewares — Middlewares personalizados, carregados automaticamente ou usados via createMiddleware.
+`src/middlewares` — Middlewares personalizados, carregados automaticamente ou usados via createMiddleware.
 
-src/services — Mantém a lógica de negócio separada das rotas (Opcional porém recomendado).
+`src/services` — Mantém a lógica de negócio separada das rotas (Opcional porém recomendado).
 
-src/utils — Helpers genéricos.
+`src/utils` — Helpers genéricos.
 
-src/index.ts — Bootstrap principal da aplicação com createApp.
+`src/index.ts` — Bootstrap principal da aplicação com createApp.
 
-dist/ — Código compilado para produção.
+`dist/` — Código compilado para produção.
 
-fastay.config.json — Configuração do build, compilador e rotas.
+`fastay.config.json` — Configuração do build, compilador e rotas.
 
 
 
 ---
 
-⚡ src/index.ts
-
+⚡ `src/index.ts`
+```bash
 import { createApp } from '@syntay/fastay';
 
 const port = 5555;
@@ -112,16 +119,17 @@ void (async () => {
     port: port
   });
 })();
-
+```
 
 ---
 
-Opções do createApp
+Opções do `createApp`
 
 createApp recebe um único objeto para configurar totalmente a aplicação Fastay.
 
-
-  apiDir?: string;               // Diretório contendo as rotas da API (default: 'src/api')
+```bash
+  apiDir?: string;               // Diretório contendo as rotas da API
+(default: 'src/api')
   baseRoute?: string;            // Caminho base para todas as rotas (default: '/api')
   port?: number;                 // Porta do servidor (default: 5000)
 
@@ -136,49 +144,61 @@ createApp recebe um único objeto para configurar totalmente a aplicação Fasta
       trustProxy?: boolean;                             // Considerar headers de proxy reverso
       locals?: Record<string, any>;                     // Variáveis globais para res.locals
 }
+```
 
 Exemplos:
 
 Aplicar middlewares globais
 
+```bash
 expressOptions: {
   middlewares: [cors(), helmet()],
 }
+```
 
 Configurar body parsers
 
+```bash
 expressOptions: {
   jsonOptions: { limit: '10mb' },
-  urlencodedOptions: { extended: true },
+  urlencodedOptions: { extended: true    },
 }
+```
 
 Servir arquivos estáticos
 
+```bash
 expressOptions: {
   static: { path: 'public', options: { maxAge: 3600000 } }
 }
+```
 
 Configurar views e locals
 
+```bash
 expressOptions: {
   views: { engine: 'pug', dir: 'views' },
   locals: { siteName: 'Fastay' }
 }
+```
 
 Handler de erro customizado
 
+```bash
 expressOptions: {
   errorHandler: (err, req, res, next) => {
     console.error(err);
     res.status(500).json({ message: 'Algo deu errado!' });
   }
 }
+```
 
 
 ---
 
-fastay.config.json
+`fastay.config.json`
 
+```bash
 {
   "entry": "src/index.ts",
   "outDir": "dist",
@@ -188,14 +208,15 @@ fastay.config.json
     "target": "es2020"
   }
 }
+```
 
-entry — Arquivo principal da aplicação.
+`entry` — Arquivo principal da aplicação.
 
-outDir — Diretório de saída do código compilado.
+`outDir` — Diretório de saída do código compilado.
 
-routesDir — Diretório opcional para rotas (default src/api).
+`routesDir` — Diretório opcional para rotas (default src/api).
 
-compiler — Opções para compilação TypeScript/ESBuild.
+`compiler` — Opções para compilação TypeScript/ESBuild.
 
 
 
@@ -205,6 +226,7 @@ Rotas da API
 
 Roteamento baseado em arquivos com sintaxe limpa:
 
+```bash
 import { Request } from '@syntay/fastay';
 
 export async function GET() {
@@ -214,6 +236,7 @@ export async function GET() {
 export async function POST(req: Request) {
   return { message: 'Hello World' };
 }
+```
 
 Cada método HTTP é exportado como função.
 
@@ -225,7 +248,7 @@ Suporta middlewares Express.
 
 ✅ Por que é melhor que Express puro:
 
-Sem boilerplate: não precisa chamar app.get(...) ou app.post(...) manualmente.
+Sem boilerplate: não precisa chamar `app.get(...)` ou `app.post(...)` manualmente.
 
 Separação limpa dos arquivos de rota: cada rota fica em um arquivo route.ts dentro de api ou outro diretório.
 
@@ -236,6 +259,7 @@ Fácil manutenção de projetos grandes: sem necessidade de registrar manualment
 
 1️⃣ Express.js
 
+```bash
 import express from 'express';
 
 const app = express();
@@ -257,6 +281,7 @@ app.use('/api/auth', (req, res, next) => {
 });
 
 app.listen(5000, () => console.log('Server running on port 5000'));
+```
 
 Pontos negativos do Express puro:
 
@@ -272,6 +297,7 @@ Escalabilidade de grandes projetos fica complicada.
 
 2️⃣ NestJS
 
+```bash
 import { Controller, Get, Post, Body } from '@nestjs/common';
 
 @Controller('api/hello')
@@ -286,6 +312,7 @@ export class HelloController {
     return { message: 'Hello POST World', body };
   }
 }
+```
 
 Características do NestJS:
 
@@ -303,6 +330,7 @@ Exige aprendizado de decorators, módulos e injeção de dependências.
 
 3️⃣ Fastay.js
 
+```bash
 import { Request } from '@syntay/fastay';
 
 // GET /api/hello
@@ -314,6 +342,7 @@ export async function GET() {
 export async function POST(req: Request) {
   return { message: 'Hello POST World' };
 }
+```
 
 Características do Fastay:
 
@@ -340,15 +369,18 @@ Middlewares
 
 Fastay permite middlewares auto-carregados e via createMiddleware:
 
+```bash
 import { Request, Response, Next } from '@syntay/fastay';
 
 export async function auth(req: Request, _res: Response, next: Next) {
   // Lógica de autenticação
   next();
 }
+```
 
 E crie um arquivo middleware.ts dentro da pasta src/middleware e use a função createMiddleware para configurar o seu middleware:
 
+```bash
 import { createMiddleware } from '@syntay/fastay';
 import { auth } from './auth';
 import { logger } from './logger';
@@ -357,7 +389,7 @@ export const middleware = createMiddleware({
   '/auth': [auth],
   '/admin': [logger],
 });
-
+```
 
 ---
 
@@ -382,4 +414,25 @@ Reduz boilerplate e aumenta a manutenção.
 
 
 Ideal para desenvolvedores que querem estrutura sem complicação.
-```
+
+---
+
+## 🔹 Contribuição
+
+Contribuições são bem-vindas!
+
+1. Faça um fork do projeto.
+2. Crie uma branch (`git checkout -b minha-feature`).
+3. Commit suas mudanças (`git commit -am 'Adiciona nova feature'`).
+4. Push para a branch (`git push origin minha-feature`).
+5. Abra um Pull Request.
+
+---
+
+## 🔹 Licença
+
+MIT © Syntay Team
+
+---
+
+

package/package.json

@@ -1,9 +1,25 @@
 {
   "name": "@syntay/fastay",
-  "version": "0.1.1",
+  "version": "0.1.3",
+  "description": "Framework backend moderno baseado em Express.js, para criar APIs rapidamente",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "type": "module",
+  "keywords": [
+    "express",
+    "backend",
+    "api",
+    "typescript",
+    "fastay",
+    "framework"
+  ],
+  "author": "Syntay team <contact@syntay.site>",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/syntay-team/fastay.git"
+  },
+  "homepage": "https://github.com/syntay-team/fastay#readme",
   "scripts": {
     "build": "tsc -p tsconfig.build.json",
     "prepare": "npm run build"