Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/joanarturo/budget-buddy-api
Proyecto para exponer una API de gastos diarios realizado con Laravel 10.
https://github.com/joanarturo/budget-buddy-api
api crud laravel php
Last synced: 5 days ago
JSON representation
Proyecto para exponer una API de gastos diarios realizado con Laravel 10.
- Host: GitHub
- URL: https://github.com/joanarturo/budget-buddy-api
- Owner: JoanArturo
- Created: 2023-12-05T00:30:25.000Z (12 months ago)
- Default Branch: main
- Last Pushed: 2023-12-23T01:37:14.000Z (11 months ago)
- Last Synced: 2023-12-26T21:27:21.148Z (11 months ago)
- Topics: api, crud, laravel, php
- Language: PHP
- 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
# BudgetBuddy API
Este proyecto se centra en la creación de una API diseñada para gestionar registros de gastos. La API ofrece un conjunto de endpoints que posibilitan diversas operaciones, entre las que se incluyen la obtención de un listado completo de gastos, la recuperación de información detallada de un gasto específico, la creación de nuevos registros de gastos, la actualización de información existente sobre un gasto y la eliminación de registros de gastos previamente almacenados.
## Pre-requisitos 📋
Para la correcta ejecución de este proyecto, necesitas tener las siguientes tecnologías instaladas en tu ordenador.
* PHP ^8.1
* Composer 2
* MySQL
## Instalación 🔧
1. Clona este proyecto.
```bash
git clone https://github.com/JoanArturo/budget-buddy-api.git
```
2. Instala las dependencias de PHP con composer.
```bash
composer install
```
3. Crea una nueva base de datos con tu gestor de base de datos preferido. Como sugerencia podrías crear una base de datos llamada `budget_buddy`.
4. Crea una copia del archivo env.example, renombralo como .env y configura las variables de entorno correspondientes, preferiblemente las variables para la conexión a la base de datos.
```json
APP_NAME=BudgetBuddy
APP_ENV=local
APP_KEY=
APP_DEBUG=true
APP_URL=http://localhost
LOG_CHANNEL=stack
LOG_DEPRECATIONS_CHANNEL=null
LOG_LEVEL=debug
DB_CONNECTION=mysql
DB_HOST=127.0.0.1
DB_PORT=3306
DB_DATABASE=tu_base_de_datos
DB_USERNAME=tu_username
DB_PASSWORD=tu_password
BROADCAST_DRIVER=log
CACHE_DRIVER=file
FILESYSTEM_DISK=local
QUEUE_CONNECTION=sync
SESSION_DRIVER=file
SESSION_LIFETIME=120
MEMCACHED_HOST=127.0.0.1
REDIS_HOST=127.0.0.1
REDIS_PASSWORD=null
REDIS_PORT=6379
MAIL_MAILER=smtp
MAIL_HOST=mailpit
MAIL_PORT=1025
MAIL_USERNAME=null
MAIL_PASSWORD=null
MAIL_ENCRYPTION=null
MAIL_FROM_ADDRESS="[email protected]"
MAIL_FROM_NAME="${APP_NAME}"
AWS_ACCESS_KEY_ID=
AWS_SECRET_ACCESS_KEY=
AWS_DEFAULT_REGION=us-east-1
AWS_BUCKET=
AWS_USE_PATH_STYLE_ENDPOINT=false
PUSHER_APP_ID=
PUSHER_APP_KEY=
PUSHER_APP_SECRET=
PUSHER_HOST=
PUSHER_PORT=443
PUSHER_SCHEME=https
PUSHER_APP_CLUSTER=mt1
VITE_APP_NAME="${APP_NAME}"
VITE_PUSHER_APP_KEY="${PUSHER_APP_KEY}"
VITE_PUSHER_HOST="${PUSHER_HOST}"
VITE_PUSHER_PORT="${PUSHER_PORT}"
VITE_PUSHER_SCHEME="${PUSHER_SCHEME}"
VITE_PUSHER_APP_CLUSTER="${PUSHER_APP_CLUSTER}"
```
5. Genera una APP_KEY.
```bash
php artisan key:generate
```
6. Ejecuta las migraciones y los seeders.
```bash
php artisan migrate:fresh --seed
```
7. Ejecuta el proyecto laravel.
```bash
php artisan serve
```
## Construido con 🛠️
- [PHP 8.1](https://www.php.net/releases/8.1/es.php)
- [Laravel 10](https://laravel.com/docs/10.x)
- [Composer 2.6.5](https://getcomposer.org/)
- [MySQL 8.2.0](https://dev.mysql.com/downloads/mysql/)
## Endpoints 🔗
A continuación se detallan los endpoints disponibles en la API:
| Método | Ruta | Descripción |
|---------|-----------------------------|----------------------------------------------------------------------------------------------|
| GET | /api/expenses | Devuelve un array de gastos. |
| POST | /api/expenses | Crea un gasto utilizando la información enviada dentro del `body` de la solicitud. |
| GET | /api/expenses/`{expense}` | Devuelve el objeto de gasto con el `id` especificado. |
| PUT | /api/expenses/`{expense}` | Actualiza el gasto con el `id` especificado utilizando los datos del `body` de la solicitud. |
| DELETE | /api/expenses/`{expense}` | Elimina el gasto con el `id` especificado. |
## Autor 🖋️
- [@JoanArturo](https://github.com/JoanArturo)