Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/notyel/example-hono-backend
Este repositorio contiene un ejemplo de backend utilizando Hono, un framework web ligero y rápido, ideal para crear APIs eficientes. Incluye configuraciones básicas, manejo de rutas, conexión a base de datos y ejemplos de middleware en TypeScript.
https://github.com/notyel/example-hono-backend
api-development database-connection hono-framework honojs middleware-implementation restful-api-example typescript-backend
Last synced: about 2 months ago
JSON representation
Este repositorio contiene un ejemplo de backend utilizando Hono, un framework web ligero y rápido, ideal para crear APIs eficientes. Incluye configuraciones básicas, manejo de rutas, conexión a base de datos y ejemplos de middleware en TypeScript.
- Host: GitHub
- URL: https://github.com/notyel/example-hono-backend
- Owner: notyel
- Created: 2024-09-07T23:29:45.000Z (5 months ago)
- Default Branch: master
- Last Pushed: 2024-09-20T15:20:20.000Z (5 months ago)
- Last Synced: 2024-10-25T10:36:23.348Z (3 months ago)
- Topics: api-development, database-connection, hono-framework, honojs, middleware-implementation, restful-api-example, typescript-backend
- Language: TypeScript
- Homepage: https://example-hono-backend.leyton-espitia.workers.dev/api/products
- Size: 25.4 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Example Hono Backend
Este repositorio es un ejemplo de un backend utilizando Hono, un framework web ligero y rápido, ideal para construir APIs eficientes. El proyecto está desarrollado en **TypeScript** e incluye la configuración básica, manejo de rutas, conexión a una base de datos **PostgreSQL**, y ejemplos de **middleware**.
## Requisitos
- Node.js v20 o superior
- PostgreSQL
## Instalación
1. Clona este repositorio:
```bash
git clone https://github.com/notyel/example-hono-backend.git
cd example-hono-backend
```
2. Instala las dependencias del proyecto:
```bash
npm install
```
## Configuración
1. Abre el archivo `wrangler.toml` y busca la siguiente línea:
```toml
DATABASE_URL = ""
```
2. Reemplaza el valor de `DATABASE_URL` con la cadena de conexión a tu base de datos PostgreSQL. Por ejemplo:
```toml
DATABASE_URL = "postgres://usuario:contraseña@localhost:5432/nombre_base_de_datos"
```
## Uso
### Desarrollo
Para ejecutar el proyecto en modo de desarrollo, usa el siguiente comando:
```bash
npm run dev
```
Este comando inicia el servidor en el puerto especificado en el archivo `wrangler.toml` (por defecto, 50000).
### Despliegue
Para desplegar el proyecto en un entorno de producción, utiliza el siguiente comando:
```bash
npm run deploy
```
## Endpoints
El proyecto incluye varios endpoints para interactuar con la base de datos PostgreSQL:
- **GET `/products`**: Obtiene la lista de productos.
- **GET `/products/:id`**: Obtiene un producto por su ID.
- **GET `/users`**: Obtiene la lista de usuarios.
- **GET `/`**: Ruta raíz que retorna un mensaje de bienvenida.
## Contribución
Si encuentras algún problema o deseas mejorar el proyecto, siéntete libre de abrir un issue o enviar un pull request.
## Licencia
Este proyecto está bajo la licencia MIT.