tewshi/f-and-k-savings

How to run this project

Clone the repository

git clone https://github.com/tewshi/f-and-k-savings.git

cd f-and-k-savings

Install PHP dependencies

composer install

Create a mysql database named fk_savings

Copy the .example.env file to .env

cp .example.env .env

Update the database user and password (if set on your database instance) DB_USERNAME and DB_PASSWORD

Currently, all emails go to mailtrap

Migrate the database tables

php artisan migrate

Run seeder to generate 10 users with a wallet for the first user

php artisan db:seed

The postman collection:

Create account POST /api/register data: {name: string, email: string, password: string}

Login / authenticate POST /api/sanctum/token data: {email: string, password: string}

Get current user details GET /api/user headers: Authorization Bearer token

Get current user wallet GET /api/wallet headers: Authorization Bearer token

Get current user wallet payments GET /api/wallet/payments headers: Authorization Bearer token

Fund user wallet POST /api/wallet headers: Authorization Bearer token data: {amount: number|string, reference: number|string}

Fund another user's wallet using email (unique) POST /api/wallet headers: Authorization Bearer token data: {email: string, amount: number|string, reference: number|string}

About Laravel

Laravel is a web application framework with expressive, elegant syntax. We believe development must be an enjoyable and creative experience to be truly fulfilling. Laravel takes the pain out of development by easing common tasks used in many web projects, such as:

• Simple, fast routing engine.
• Powerful dependency injection container.
• Multiple back-ends for session and cache storage.
• Expressive, intuitive database ORM.
• Database agnostic schema migrations.
• Robust background job processing.
• Real-time event broadcasting.

Laravel is accessible, powerful, and provides tools required for large, robust applications.

Learning Laravel

Laravel has the most extensive and thorough documentation and video tutorial library of all modern web application frameworks, making it a breeze to get started with the framework.

If you don't feel like reading, Laracasts can help. Laracasts contains over 1500 video tutorials on a range of topics including Laravel, modern PHP, unit testing, and JavaScript. Boost your skills by digging into our comprehensive video library.

Laravel Sponsors

We would like to extend our thanks to the following sponsors for funding Laravel development. If you are interested in becoming a sponsor, please visit the Laravel Patreon page.

Premium Partners

• Vehikl
• Tighten Co.
• Kirschbaum Development Group
• 64 Robots
• Cubet Techno Labs
• Cyber-Duck
• Many
• Webdock, Fast VPS Hosting
• DevSquad
• Curotec
• OP.GG

Contributing

Thank you for considering contributing to the Laravel framework! The contribution guide can be found in the Laravel documentation.

Code of Conduct

In order to ensure that the Laravel community is welcoming to all, please review and abide by the Code of Conduct.

Security Vulnerabilities

If you discover a security vulnerability within Laravel, please send an e-mail to Taylor Otwell via taylor@laravel.com. All security vulnerabilities will be promptly addressed.

License

The Laravel framework is open-sourced software licensed under the MIT license.