PHP Personal Finance App API: Provides an API to control personal expenses

Recommend this page to a friend!

Download

Info

Documentation

Files

Install with Composer

Download

Reputation

Support forum

Blog

Links

Ratings				Unique User Downloads		Download Rankings
Not yet rated by the users				Total: 140		All time: 9,217 This week: 560

Version		License		PHP version		Categories
`personal-finance-con` 1.0.0		GNU General Publi...		7		Finances, Data types, Design Patterns, P...

Description

Author

Paulo Henrique

This package provides an API to control personal expenses.

It can handle HTTP requests for performing several types of operations for managing an application that keeps track of expenses of its users. Currently it can:

- Register and authenticate users
- Retrieve and update use account information
- Manage details about user places, earnings, expenses, credit cards and categories.

Innovation Award

March 2020
Number 2

Finances are an important area of life that people should be able to manage, so they can control their expenses, do not spend more money than the earn, and hopefully save money to invest in something important in their future.

This package provides and API that can be used to create applications to help people control their expenses. Since it is a Web based API, it can be used to implement applications that can run from a Web browser, a mobile application or even a desktop application.

Manuel Lemos

Paulo Henrique

Name:	Paulo Henrique `<contact>`
Classes:	5 packages by Paulo Henrique
Country:	Brazil

Innovation award

Nominee: 4x

Documentation

Personal Financial Control App

A simple API to control our expenses

Requirements

You must have installed Git, Docker, Docker-compose and Make before proceeding.

These ports must be available: - 8888 (api)

Installing

After cloning the repository you must run:

make up

The whole process can take a while, it depends on your computer.

After finish, just access the url, to register a user and start using:

`` http://localhost:8888/register ``

Note.: This installation must be done only once.

Routes

Open Routes

POST - http://localhost:8888/authenticate-demo  -> generate a demo user, does not need data.
POST - http://localhost:8888/register -> register a user.
POST - http://localhost:8888/authenticate -> need a valid user.

Private Routes

GET - http://localhost:8888/api/v1/users/me  -> show profile from user
PUT - http://localhost:8888/api/v1/users
PUT - http://localhost:8888/api/v1/users/my-status-to/{status}

POST - http://localhost:8888/api/v1/places
GET - http://localhost:8888/api/v1/places/{uuid}
GET - http://localhost:8888/api/v1/places
PUT - http://localhost:8888/api/v1/places/{uuid}
PUT - http://localhost:8888/api/v1/places/{uuid}/default
PUT - http://localhost:8888/api/v1/places/{uuid}/status/{status}
DELETE - http://localhost:8888/api/v1/places/{uuid}

POST - http://localhost:8888/api/v1/earns
GET - http://localhost:8888/api/v1/earns/{uuid}
PUT - http://localhost:8888/api/v1/earns/{uuid}/confirm
PUT - http://localhost:8888/api/v1/earns/{uuid}
GET - http://localhost:8888/api/v1/earns
DELETE - http://localhost:8888/api/v1/earns/{uuid}

POST - http://localhost:8888/api/v1/categories
GET - http://localhost:8888/api/v1/categories/{uuid}
PUT - http://localhost:8888/api/v1/categories/{uuid}
GET - http://localhost:8888/api/v1/categories
PUT - http://localhost:8888/api/v1/categories/{uuid}/default
PUT - http://localhost:8888/api/v1/categories/{uuid}/status/{status}
DELETE - http://localhost:8888/api/v1/categories/{uuid}

POST - http://localhost:8888/api/v1/credit-cards
GET - http://localhost:8888/api/v1/credit-cards/{uuid}
PUT - http://localhost:8888/api/v1/credit-cards/{uuid}
GET - http://localhost:8888/api/v1/credit-cards
PUT - http://localhost:8888/api/v1/credit-cards/{uuid}/default
PUT - http://localhost:8888/api/v1/credit-cards/{uuid}/status/{status}
DELETE - http://localhost:8888/api/v1/credit-cards/{uuid}

POST - http://localhost:8888/api/v1/expenses
GET - http://localhost:8888/api/v1/expenses/{uuid}
PUT - http://localhost:8888/api/v1/expenses/{uuid}
GET - http://localhost:8888/api/v1/expenses
PUT - http://localhost:8888/api/v1/expenses/paid/{uuid}
DELETE - http://localhost:8888/api/v1/expenses/{uuid}

Files (205)

File	Role	Description
`.serverless` (3 files)
`bin` (2 files)
`config` (4 files, 2 directories)
`phpdocker` (2 directories)
`public` (1 file)
`src` (1 file, 10 directories)
`templates` (1 file)
`tests` (2 files, 4 directories)
`.env.dist`	Data	Auxiliary data
`.env.test`	Data	Auxiliary data
`.stack-symfony.yaml`	Data	Auxiliary data
`.stack.yaml`	Data	Auxiliary data
`composer.json`	Data	Auxiliary data
`composer.lock`	Data	Auxiliary data
`docker-compose.yml`	Data	Auxiliary data
`index.php`	Aux.	Auxiliary script
`Makefile`	Data	Auxiliary data
`package-lock.json`	Data	Auxiliary data
`phpunit.sh`	Data	Auxiliary data
`phpunit.xml.dist`	Data	Auxiliary data
`README.md`	Doc.	Documentation
`serverless.yml`	Data	Auxiliary data
`template.yml`	Data	Auxiliary data

File	Role	Description
`cloudformation-tem...e-create-stack.json`	Data	Auxiliary data
`cloudformation-tem...e-update-stack.json`	Data	Auxiliary data
`serverless-state.json`	Data	Auxiliary data

File	Role	Description
`console`	Class	Class source
`phpunit`	Data	Auxiliary data

File	Role	Description
`packages` (11 files, 2 directories)
`routes` (1 file, 1 directory)
`bootstrap.php`	Class	Class source
`bundles.php`	Class	Class source
`routes.yaml`	Data	Auxiliary data
`services.yaml`	Data	Auxiliary data

File	Role	Description
`prod` (2 files)
`test` (4 files)
`cache.yaml`	Data	Auxiliary data
`doctrine.yaml`	Data	Auxiliary data
`doctrine_migrations.yaml`	Data	Auxiliary data
`framework.yaml`	Data	Auxiliary data
`knpu_oauth2_client.yaml`	Data	Auxiliary data
`nelmio_cors.yaml`	Data	Auxiliary data
`ramsey_uuid_doctrine.yaml`	Data	Auxiliary data
`routing.yaml`	Data	Auxiliary data
`security.yaml`	Data	Auxiliary data
`sensio_framework_extra.yaml`	Data	Auxiliary data
`validator.yaml`	Data	Auxiliary data

File	Role	Description
`doctrine.yaml`	Data	Auxiliary data
`routing.yaml`	Data	Auxiliary data

File	Role	Description
`dama_doctrine_test_bundle.yaml`	Data	Auxiliary data
`framework.yaml`	Data	Auxiliary data
`twig.yaml`	Data	Auxiliary data
`validator.yaml`	Data	Auxiliary data

File	Role	Description
`dev` (1 file)
`annotations.yaml`	Data	Auxiliary data

File	Role	Description
`framework.yaml`	Data	Auxiliary data

File	Role	Description
`nginx` (2 files)
`php-fpm` (2 files)

File	Role	Description
`Dockerfile`	Data	Auxiliary data
`nginx.conf`	Data	Auxiliary data

File	Role	Description
`Dockerfile`	Data	Auxiliary data
`php-ini-overrides.ini`	Data	Auxiliary data

File	Role	Description
`index.php`	Example	Example script

File	Role	Description
`Controller` (9 files)
`DataFixtures` (2 files)
`Entity` (8 files, 2 directories)
`EventListener` (1 file)
`EventSubscriber` (1 file)
`Migrations` (25 files)
`Repository` (8 files, 1 directory)
`Security` (3 files)
`Services` (5 directories)
`Utils` (4 directories)
`Kernel.php`	Class	Class source

File	Role	Description
`APIController.php`	Class	Class source
`CategoryController.php`	Class	Class source
`CreditCardController.php`	Class	Class source
`EarnController.php`	Class	Class source
`ExpenseController.php`	Class	Class source
`GoogleController.php`	Class	Class source
`PlaceController.php`	Class	Class source
`RegisterController.php`	Class	Class source
`UserController.php`	Class	Class source

File	Role	Description
`AppFixtures.php`	Class	Class source
`UserFixture.php`	Class	Class source

File	Role	Description
`Interfaces` (12 files)
`Traits` (4 files)
`ApiToken.php`	Class	Class source
`Category.php`	Class	Class source
`CreditCard.php`	Class	Class source
`Earn.php`	Class	Class source
`Expense.php`	Class	Class source
`ModelBase.php`	Class	Class source
`Place.php`	Class	Class source
`User.php`	Class	Class source

File	Role	Description
`ApiTokenInterface.php`	Class	Class source
`CategoryInterface.php`	Class	Class source
`CreditCardInterface.php`	Class	Class source
`EarnInterface.php`	Class	Class source
`ExpenseInterface.php`	Class	Class source
`ModelInterface.php`	Class	Class source
`PlaceInterface.php`	Class	Class source
`ReadUserOutsideInterface.php`	Class	Class source
`SearchDataInterface.php`	Class	Class source
`SearchInterface.php`	Class	Class source
`SimpleTimeInterface.php`	Class	Class source
`UsuarioInterface.php`	Class	Class source

File	Role	Description
`ControlStatusAndIsDefault.php`	Class	Class source
`ParamControl.php`	Class	Class source
`ReadUserData.php`	Class	Class source
`SimpleTime.php`	Class	Class source

The PHP Classes site has supported package installation using the Composer tool since 2013, as you may verify by reading this instructions page.

Install with Composer

	personal-finance-con-2020-03-09.zip 226KB
	personal-finance-con-2020-03-09.tar.gz 144KB
	Install with Composer

Version Control

Unique User Downloads

Download Rankings

100%

Total:	140
This week:	0

All time:	9,217
This week:	560

Applications that use this package

No pages of applications that use this class were specified.

If you know an application of this package, send a message to the author to add a link here.

About us

Advertise on this site

For more information send a message to info at phpclasses dot org.

File	Role	Description
`Entity` (7 files, 1 directory)
`External` (2 directories)
`Log` (1 file, 1 directory)
`Login` (2 files)
`Validation` (2 files)

File	Role	Description
`Datetime` (1 file, 1 directory)
`Enums` (1 file)
`Generators` (4 files)
`HandleErrors` (1 file)

File	Role	Description
`Datetime` (1 file)
`Enums` (1 file)
`Generators` (2 files)
`HandleErrors` (1 file)

File	Role	Description
`Version20191109133802.php`	Class	Class source
`Version20191209133...uid_by_postgres.php`	Class	Class source
`Version20191222142...pi_tokens_table.php`	Class	Class source
`Version20191222212...ted_at_to_users.php`	Class	Class source
`Version20191222213...eleted_at_users.php`	Class	Class source
`Version20191225130...column_to_users.php`	Class	Class source
`Version20191227202...places_to_table.php`	Class	Class source
`Version20191228200..._to_place_table.php`	Class	Class source
`Version20191229195...pi_tokens_table.php`	Class	Class source
`Version20191230010..._delete_cascade.php`	Class	Class source
`Version20191230011...ces_users_table.php`	Class	Class source
`Version20191230215...edit_card_table.php`	Class	Class source
`Version20200104213..._expenses_table.php`	Class	Class source
`Version20200104221..._category_table.php`	Class	Class source
`Version20200104225...nd_places_table.php`	Class	Class source
`Version20200105002..._to_users_table.php`	Class	Class source
`Version20200111115...api_token_table.php`	Class	Class source
`Version20200111203...stallment_group.php`	Class	Class source
`Version20200112012..._expenses_table.php`	Class	Class source
`Version20200114014...to_places_table.php`	Class	Class source
`Version20200125101...ategories_table.php`	Class	Class source
`Version20200129004..._to_remove_user.php`	Class	Class source
`Version20200209223..._expenses_table.php`	Class	Class source
`Version20200224223..._expenses_table.php`	Class	Class source
`Version20200225112...om_places_table.php`	Class	Class source

File	Role	Description
`Interfaces` (8 files)
`ApiTokenRepository.php`	Class	Class source
`BaseRepository.php`	Class	Class source
`CategoryRepository.php`	Class	Class source
`CreditCardRepository.php`	Class	Class source
`EarnRepository.php`	Class	Class source
`ExpenseRepository.php`	Class	Class source
`PlaceRepository.php`	Class	Class source
`UserRepository.php`	Class	Class source

File	Role	Description
`ApiTokenRepositoryInterface.php`	Class	Class source
`BaseRepositoryInterface.php`	Class	Class source
`CategoryRepositoryInterface.php`	Class	Class source
`CreditCardRepositoryInterface.php`	Class	Class source
`EarnRepositoryInterface.php`	Class	Class source
`ExpenseRepositoryInterface.php`	Class	Class source
`PlaceRepositoryInterface.php`	Class	Class source
`UserRepositoryInterface.php`	Class	Class source

File	Role	Description
`GoogleAuthenticator.php`	Class	Class source
`TokenAuthenticator.php`	Class	Class source
`UserProvider.php`	Class	Class source

File	Role	Description
`Interfaces` (7 files)
`ApiTokenService.php`	Class	Class source
`CategoryService.php`	Class	Class source
`CreditCardService.php`	Class	Class source
`EarnService.php`	Class	Class source
`ExpenseService.php`	Class	Class source
`PlaceService.php`	Class	Class source
`UserService.php`	Class	Class source

File	Role	Description
`ApiTokenServiceInterface.php`	Class	Class source
`CategoryServiceInterface.php`	Class	Class source
`CreditCardServiceInterface.php`	Class	Class source
`EarnServiceInterface.php`	Class	Class source
`ExpenseServiceInterface.php`	Class	Class source
`PlaceServiceInterface.php`	Class	Class source
`UserServiceInterface.php`	Class	Class source

File	Role	Description
`GoogleAuthenticateService.php`	Class	Class source
`GoogleCheckServiceInterface.php`	Class	Class source

File	Role	Description
`SlackApproval.php`	Class	Class source
`SlackService.php`	Class	Class source
`SlackServiceInterface.php`	Class	Class source
`SlackTemplateInterface.php`	Class	Class source

File	Role	Description
`LoginService.php`	Class	Class source
`LoginServiceInterface.php`	Class	Class source

File	Role	Description
`ValidateModelInterface.php`	Class	Class source
`ValidationService.php`	Class	Class source

File	Role	Description
`Interfaces` (1 file)
`DatetimeCheckService.php`	Class	Class source

File	Role	Description
`Bin2HexGenerate.php`	Class	Class source
`GenerateDataToSaveInterface.php`	Class	Class source
`GenerateUserDemo.php`	Class	Class source
`TokenGeneratorInterface.php`	Class	Class source

File	Role	Description
`Controller` (7 files)
`Entity` (11 files, 1 directory)
`Services` (3 directories)
`Utils` (4 directories)
`Authenticate.php`	Class	Class source
`bootstrap.php`	Class	Class source

File	Role	Description
`CategoryControllerTest.php`	Class	Class source
`CreditCardControllerTest.php`	Class	Class source
`EarnControllerTest.php`	Class	Class source
`ExpenseControllerTest.php`	Class	Class source
`PlaceControllerTest.php`	Class	Class source
`RegisterControllerTest.php`	Class	Class source
`UserControllerTest.php`	Class	Class source

File	Role	Description
`Traits` (1 file)
`ApiTokenTest.php`	Class	Class source
`CategoryTest.php`	Class	Class source
`CreditCardTest.php`	Class	Class source
`EarnTest.php`	Class	Class source
`ExpenseTest.php`	Class	Class source
`PlaceTest.php`	Class	Class source
`RegisterCategory.php`	Class	Class source
`RegisterCreditCard.php`	Class	Class source
`RegisterEarn.php`	Class	Class source
`RegisterExpense.php`	Class	Class source
`UserTest.php`	Class	Class source

File	Role	Description
`Entity` (10 files)
`Login` (2 files)
`Validation` (2 files)

File	Role	Description
`CategoryServiceTest.php`	Class	Class source
`CreditCardServiceTest.php`	Class	Class source
`EarnServiceTest.php`	Class	Class source
`LoadCategoryService.php`	Class	Class source
`LoadCreditCardService.php`	Class	Class source
`LoadEarnService.php`	Class	Class source
`LoadPlaceService.php`	Class	Class source
`LoadUserService.php`	Class	Class source
`PlaceServiceTest.php`	Class	Class source
`UserServiceTest.php`	Class	Class source

File	Role	Description
`LoadLoginService.php`	Class	Class source
`LoginServiceTest.php`	Class	Class source

File	Role	Description
`LoadValidationService.php`	Class	Class source
`ValidationServiceTest.php`	Class	Class source

File	Role	Description
`Bin2HexGenerateTest.php`	Class	Class source
`GenerateUserDemoTest.php`	Class	Class source