Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/brayanyinlin/ts-api-rest-storage
https://github.com/brayanyinlin/ts-api-rest-storage
express nodejs sqlite3 typescript zod
Last synced: 8 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/brayanyinlin/ts-api-rest-storage
- Owner: BrayanYinLin
- Created: 2024-12-02T01:41:20.000Z (2 months ago)
- Default Branch: main
- Last Pushed: 2025-01-17T20:44:12.000Z (20 days ago)
- Last Synced: 2025-01-17T21:29:11.334Z (20 days ago)
- Topics: express, nodejs, sqlite3, typescript, zod
- Language: TypeScript
- Homepage:
- Size: 77.1 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# API con Node.js, Express y TypeScript
## 🚀 Características
- Estructura modular y escalable.
- Configuración con TypeScript.
- Scripts para desarrollo y producción.
- Manejo de errores centralizado.
- Variables de entorno con soporte para `.env`.
## 📦 Instalación
1. Clona este repositorio:
```bash
git clone https://github.com/brayanyinlin/ts-api-rest-storage
```
2. Navega al directorio del proyecto:
```bash
cd ts-api-rest-storage
```
3. Instala las dependencias:
```bash
npm install
```
## 🛠️ Scripts
- **Desarrollo**: Inicia el servidor con recarga automática:
```bash
npm run dev
```
- **Construcción**: Transpila TypeScript a JavaScript:
```bash
npm run build
```
- **Producción**: Inicia la API en modo producción:
```bash
npm start
```
- **Test**: Ejecuta pruebas (si están configuradas):
```bash
npm test
```
## 📁 Estructura del Proyecto
```plaintext
src/
├── controllers/ # Controladores para manejar la lógica de negocio
├── routes/ # Definición de las rutas
├── middlewares/ # Middlewares personalizados
├── models/ # Modelos para interactuar con la base de datos
├── utils/ # Funciones reutilizables
└── index.ts # Punto de entrada de la aplicación
```