Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/jesusantguerrero/atmosphere

The Digital Home Management Software
https://github.com/jesusantguerrero/atmosphere

budget chores finance inertiajs jetstream-laravel jetstream-with-inertia laravel meal-planner personal-finance php tailwindcss vue3

Last synced: 3 months ago
JSON representation

The Digital Home Management Software

Host: GitHub
URL: https://github.com/jesusantguerrero/atmosphere
Owner: jesusantguerrero
License: bsd-3-clause
Created: 2021-03-06T04:01:21.000Z (over 3 years ago)
Default Branch: master
Last Pushed: 2024-08-16T16:57:13.000Z (3 months ago)
Last Synced: 2024-08-16T18:02:47.834Z (3 months ago)
Topics: budget, chores, finance, inertiajs, jetstream-laravel, jetstream-with-inertia, laravel, meal-planner, personal-finance, php, tailwindcss, vue3
Language: Vue
Homepage:
Size: 19.5 MB
Stars: 26
Watchers: 5
Forks: 1
Open Issues: 3
Metadata Files:
- Readme: README-es-ES.md
- Changelog: CHANGELOG.md
- License: LICENSE

Awesome Lists containing this project

README

# Loger 🏡

The Digital Home Management System (El Sistema de Manejo de Hogar Digital)

> Status: Alpha

> Codename: Atmosphere
## Acerca de Loger

Administrar una familia es casi como ser presidente de una empresa.
Hay un monton de cosas que hay que tener en cuenta y llevar pendiente.
Cosas como: **Presupuesto**, **gastos**, **subscripciones** para mantener buenos habitos financieros.
Ademas de manejar las metas/ahorros como **fondo de emergencia** o planificar tus proximas vacaciones;

Una gran parte del presupuesto de un individuo/familia va a la comida, pero tambien la comida es esencial,
para llevar una vida saludable. Tener un **Planificador de Comida**, que ademas auto-genere una lista de compras con las cosas que necesitas puede ser de gran ayuda y si podriamos seguir... bueno, creo que ya entiendes por donde voy.

Todas las cosas mencionadas arriba son parte de nuestra rutina familiar/personal.
Lo hacemos todo el tiempo en nuestra mente o en papel o (si eres como yo) usando diferentes aplicaciones. Loger busca centralizar todo ese sistema en una sola aplicacion.

## ✨Caracteristicas:

Loger is está organizado en 4 "aspectos/secciones" por el momento

* ### 💵 Finance:
- [x] Presupuesto Mensual
- [x] Categorias / Grupos
- [x] Alertas de gastos
- [x] Cuentas
- [x] Transacciones
- [x] Metricas/Net Worth
- [ ] Transacciones periodicas

* ### 🍗 Comidas
- [x] Recetas
- [x] Ingredientes
- [x] Planificador de comidas
- [x] Generador de comida al azar
- [ ] Menus*

* ### 👨‍👩‍👧 Relacion/Pareja**
No quiero automatizar/digitalizar el factor humano de una relacion. Esta seccion solo seria para organizar notas, actividades, planes enfocados en la relacion mas que en la familia cosas como`:

- Metas, Proyectos, viajes y actividades.

* ### 🏡Home/Family Projects**
En mi corta experiencia como padre/co-cabeza de familia he notado que hay cosas que necesitan accione pero no inmediata,
quiza solo necesitamos un reminder para ponerlo en presupuesto el mes siguiente o en tres meses.

- Nuevos muebles
- Reparaciones de la casa/Mejoras
- Eventos y actividades familiares

> (*) Caracteristica planificada pero no terminada
(**) Seccion esta considerada, pero no planificada aun estoy haciendo mis investigaciones.

## Showcase

Dashboard Expanded
![Dashboard](/public/images/full-sized-dashboard.png)

Dashboard
![Dashboard](/public/images/dashboard-small-menu.png)

Meal Planner
![Meal Planner](/public/images/meal-planner.png)

Finance Overview
![Finance Overview](/public/images/finance-overview.png)

Budget
![Budget](/public/images/budget.png)

## Motivation
- This was an Idea initially considered as a part of a 12x12 SaaS challenge.
- I married and needed something like this to keep my things organized and planned.
- Financial software had fixed categories, bank sync didn't work in my country or just. worked more like expense tracker than budget (Except YNAB).
- I didn't want to have multiple apps to manage things of the same context and need a relation (Budgeting app, calendars, meal planner, custom notion template).

## Technical Stuff
Loger is a Monolith app using laravel 9, jetstream, inertia, vue3, Tailwindcss and some hand crafted packages [Atmosphere UI](https://github.com/jesusantguerrero/atmosphere-ui), [Journal](https://github.com/insane-code/journal), and others.

| Prerequisite | Version |
| ------------------------------------------------------| ---------- |
| [Node.js](http://nodejs.org) | `~ ^14.18.0`|
| npm (comes with Node) or yarn (used) | `~ ^5` |
| [PHP] | `~ ^8.1.2` |
| [Composer](https://getcomposer.org/) | ' ^2.3.8 |
| [MariaDB](https://mariadb.org/)*** | `10.8.4` |
| [Cloud Platform Project (with Gmail API)**](https://developers.google.com/gmail/api/quickstart/js) | -- | |
| PHP extension ext-mailparse** | -- |

`** Those requirements are optional for Gmail integration/automation`
`*** MariaDB could be replaced with MySql8`

```shell
node -v
php -v
```

## Installation

To install Loger, you'll need to clone or download this repo:

```
git clone https://github.com/jesusantguerrero/atmosphere.git project_name
```

Next, we can install Atmosphere with these **4 simple steps**:

### 1. Create a New Database

During the installation we need to use a MySQL database. You will need to create a new database and save the credentials for the next step.

### 2. Copy the `.env.example` file

We need to specify our Environment variables for our application. You will see a file named `.env.example`, you will need to duplicate that file and rename it to `.env`.

Then, open up the `.env` file and update your *DB_DATABASE*, *DB_USERNAME*, and *DB_PASSWORD* in the appropriate fields. You will also want to update the *APP_URL* to the URL of your application.

```bash
APP_URL=http://127.0.0.1:8000/

DB_CONNECTION=mysql
DB_HOST=127.0.0.1
DB_PORT=3306
DB_DATABASE=loger
DB_USERNAME=root
DB_PASSWORD=
```

### 3. Add Composer Dependencies
```php
composer install --ignore-platform-reqs
```
### 4. Run Migrations and Seeds

```bash
php artisan migrate
php artisan db:seed
php artisan journal:set-accounts
```

backend development
```bash
php artisan serve
```
Frontend development
The bachend have to be running

```bash
# install npm packages
npm install
# development
npm run dev
```

🎉 And that's it! You will now be able to visit your URL and see your Atmosphere application up and running.

## License
[BSD-3 license](https://github.com/jesusantguerrero/atmosphere/blob/master/LICENSE).

## Author
Jesus Guerrero
- website: [jesusantguerrero.com](https://jesusantguerrero.com)
- twitter: [@jesusntguerrero](https://twitter.com/jesusntguerrero)