https://github.com/didaquis/didibudget-frontend

Home Economics Management Application
https://github.com/didaquis/didibudget-frontend

money-manager

Last synced: 7 months ago
JSON representation

Home Economics Management Application

• Host: GitHub
• URL: https://github.com/didaquis/didibudget-frontend
• Owner: didaquis
• License: mit
• Created: 2019-12-20T20:06:16.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2024-12-11T18:11:52.000Z (10 months ago)
• Last Synced: 2025-03-11T03:47:27.045Z (7 months ago)
• Topics: money-manager
• Language: JavaScript
• Homepage: https://didibudget.netlify.app
• Size: 8.18 MB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# 💰 didibudget-frontend

See this application in action here: https://didibudget.netlify.app  

[![Netlify Status](https://api.netlify.com/api/v1/badges/15c34301-7788-44d1-a36c-015b5ca94baa/deploy-status)](https://app.netlify.com/sites/didibudget/deploys)

This is an app to manage your money.

The project is splitted on two repositories: one for the backend and one for the frontend application.

This repository is for the frontend and is intended to work with [the backend](https://github.com/didaquis/didibudget-backend)

![preview_01](./docs-and-assets/preview_01.png)  

![preview_02](./docs-and-assets/preview_02.png)  

![preview_03](./docs-and-assets/preview_03.png)  

### 📝 Frontend Requirements

* Backend must be running

* Node.js 18.20 or higher

### 📚 How to run the application?

* Use the command: `npm install`.

* Configure the application:

  * Duplicate the configuration file `_env` and rename it as `.env`

  * Edit the file `.env`

* Then use: `npm run start`. 

### 🚀 How to deploy?

* Use the command: `npm install --production`.

* Make sure you have the correct environment vars configuration on the `.env` file.

* Then use `npm run build` to create a production bundle. This bundle will be created in the `./build` folder.

* The content of `./build` folder is ready to be deployed to production.

**Do you need help with `.env` file?** 

Don't worry, here you have a guide:

| Key | Description |

|-----|-------------|

| REACT_APP_PROTOCOL | Protocol to communicate with backend. Set http or https |

| REACT_APP_HOST | Host of backend. An IP or domain |

| REACT_APP_PORT | Port of backend |

| REACT_APP_GRAPHQL | Endpoint of GraphQL API |

### 💻 Tricks for development

* Run app in dev mode: `npm run start`

* Run the linter: `npm run lint`

* Run the test: `npm run test`