Skip to content

BIEMAX/financial-manager-app

Repository files navigation

Deploy to Staging

Introduction

This project is a frontend software for financial-manager-api, that consists in:

  • Manage your personal and professional costs
  • Control bills close to overdue ou already overdue
  • View your money (spend, save and remaining) in charts

If you want to test it, you can access our demo accessing the link financial-manager-staging.web.app.

Some features that this application have:

  • Automatic deploys via Heroku
  • Code quality and tests
  • CI/CD for staging and production environments

Available languages

Currently, we only have support to portuguese, but we're of necessity of implement other languages.

Roadmap

imagem

Requirements

  1. Financial-manager-api running on your machine
  2. MongoDB connection (set in configuration file in financial-manager-api)
  3. Web or mobile device

How to run in localhost

  1. Create following files in folder src/environments:
  • environment.dev.ts
  • environment.ts

Note: Don't commit changes in these files, or this will break our pipelines.

  1. Configure the files created before with the following content:
export const environment = {
  production: false,
  applicationName: 'Financial Manager',
  //Your backend url (without slash at the end)
  apiUrl: 'http://localhost:8080',
  //Version of your endpoints (without slash at the end)
  apiVersion: 'v1',
  //Field 'secret' from 'Authorization' collection in MongoDB
  apiSecret: '<YOUR_API_SECRET>',
  //Field 'clientId' from 'Authorization' collection in MongoDB
  apiClientId: '<YOUR_CLIENT_ID>',
  //True to log all errors/exceptions in browser console.
  logInfo: true,
};

/**
 * The colors can be: primary (purple), accent (pink) or warn (orange).
 */
export const ui = {
  color: "primary",
};

/**
 * Default user to login (for tests only)
 */
export const user = {
  login: '<DEFAULT_USER>',
  password: '<DEFAULT_PASSWORD>'
}

Note: The 'apiSecret' parameter is used to new users registration and the 'apiClientId' parameter is used to other endpoints.

  1. After create configuration files, we need to install dependencies:
npm install
  1. To run the project in localhost, run in terminal:
npm run dev
  1. Access the web app in your browser with the following link:
http://localhost:4200

About

PWA to manager/control your personal costs and bills

Topics

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors