Xpenses Api 📊

Este es la api de un sistema de registro y control de gastos personales. Este proyecto se realizó como trabajo final del Bootcamp Full Stack Developer de

Tecnologias Utilizadas

Tabla de Contenidos

• 🧾Diseño BBDD
• ⚙️Instalacion en local
• 🎯Endpoints
• 🛠️Posibles Mejoras
• 💻Contacto
• 🪪Creditos

Diseño BBDD

Instalacion en local

1. Clonar el repositorio con el comando$ git clone [URL del repositorio]
2. Instalar dependencias con el comando$ composer install
3. Conectamos nuestro repositorio con nuestra base de datos, en el archivo ".env.example" tenemos un ejemplo, copiamos el archivo y quitamos el ".example" y el archivo deberia quedar ".env", sustituimos valores con las credenciales de nuestra base de datos.

DB_CONNECTION=mysql
DB_HOST="database host"
DB_PORT="database port"
DB_DATABASE="database name"
DB_USERNAME="username"
DB_PASSWORD="database password"

4. Ejecutamos las migraciones con el comando$ php artisan migrate
5. Ejecutamos el comando$ php artisan db:seed para los seeders
6. Levantamos el servidor con $ php artisan serve

Endpoints

Endpoints

• REGISTER POST http://localhost:8000/api/register body: { "name":"vanessa", "email":"[email protected]", "password": "123456", }

• LOGIN POST http://localhost:8000/api/login body: { "email":"[email protected]", "password": "123456", }

• GET PROFILE GET http://localhost:8000/api/profile

• ADD EXPENSE POST http://localhost:8000/api/new-expense body: { "amount":110, "category_id":2, "description":"renta", "date":"2023-12-03", "pay_method_id":1 }

• ADD INCOME POST http://localhost:8000/api/new-income body: { "amount":1100, "category_id":10, "description":"salary", "date":"2023-12-03" }

• EDIT NICKNAME PUT http://localhost:8000/api/edit-nickname body: { "nickname":"vane99", }

• CHANGE AVATAR PUT http://localhost:8000/api/edit-avatar body: { "avatar_url":"https://img.icons8.com/external-outline-icons-mangsaabguru-/100/1A1A1A/external-african-avatar-outline-outline-icons-mangsaabguru--2.png" }

• GET ALL EXPENSES BY DATE GET http://localhost:8000/api/expenses?month={}&year={}

• GET ALL INCOMES BY DATE GET http://localhost:8000/api/incomes?month={}&year={}

• GET BALANCE BY DATE (MONTHLY) GET http://localhost:8000/api/balance-date?month={}&year={}

• DELETE EXPENSE DELETE http://localhost:8000/api/delete-expense/1

• DELETE INCOME DELETE http://localhost:8000/api/delete-income/1

Super admin endpoints

• GET ALL USERS GET http://localhost:8000/api/all-users

• GET ALL CATEGORIES GET http://localhost:8000/api/all-categories

• ACTIVATE USER PUT http://localhost:8000/api/user-activate/{id}

• INACTIVATE USER PUT http://localhost:8000/api/user-inactivate/{id}

• CHANGE USER ROLE PUT http://localhost:8000/api/user-role/{id} body: { "role":"admin", }

Contacto

Creditos

Este proyecto ha sido realizado por mi, Vanessa Brito, como trabajo final del Bootcamp Full Stack Developer de