https://github.com/luizottavioc/simplified-banking

Simplified payments platform. In simplified-banking it is possible to deposit money, make transfers and withdraw, all under the mediation of external services.
https://github.com/luizottavioc/simplified-banking

api api-rest authorization banking clean-architecture clean-code docker docker-compose feature-testing jwt jwt-auth jwt-authentication laravel php php8 postgres postgresql queue tests unit-testing

Last synced: 21 days ago
JSON representation

Simplified payments platform. In simplified-banking it is possible to deposit money, make transfers and withdraw, all under the mediation of external services.

• Host: GitHub
• URL: https://github.com/luizottavioc/simplified-banking
• Owner: luizottavioc
• License: mit
• Created: 2024-06-20T15:03:22.000Z (8 months ago)
• Default Branch: main
• Last Pushed: 2024-06-27T02:52:21.000Z (8 months ago)
• Last Synced: 2024-11-20T17:37:10.751Z (3 months ago)
• Topics: api, api-rest, authorization, banking, clean-architecture, clean-code, docker, docker-compose, feature-testing, jwt, jwt-auth, jwt-authentication, laravel, php, php8, postgres, postgresql, queue, tests, unit-testing
• Language: PHP
• Homepage:
• Size: 143 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Simplified Banking

Simplified payments platform. In simplified-banking it is possible to deposit money, make transfers and withdraw, all under the mediation of external services (mock).

There are 3 types of users:

- **Admin**: does not have access to the wallet or transfers, can only view the operations carried out by users in the application;

- **Usual**: has access to the wallet and has the power to deposit, transfer and withdraw money;

- **Merchants**: have access to the wallet but can only receive transfers and withdraw.

## Steps to run the project locally

- Setup .env: ```cv .env.example .env```

- Setup docker: ```docker compose up -d```

- Access app container: ```docker compose exec app bash```. At the container:

    - run migrations + seeds: ```php artisan migrate:fresh --seed```

    - generate a jwt secret: ```php artisan jwt:secret```

    - run tests: ```php artisan test```

    - start notify queue: ```php artisan queue:work --queue=notify```

- Test code quality: ```docker run -it --rm -v $(pwd):/project -w /project jakzal/phpqa phpmd app text cleancode,codesize,controversial,design,naming,unusedcode```