Casher API

Casher is an app to manage all your bills.

This project is being developed in conjunction with the @VictorioDev for study purposes and it is separated into completely different parts.

• Casher API (RESTful API): lucianocarvalho/casher-api
• Casher App (web application): lucianocarvalho/casher-app
• Flutter (iOS/Android): VictorioDev/CasherApp
• Kotlin (Android): VictorioDev/Casher-Kotlin

⚠️ This repository contains only the REST API, not the complete application. Check the other repositories.

Table of contents:

• About
• Documentation
• Improvements
• Bugs and features
• Author

About

Requirements:

• Docker working in your machine.
• docker-compose already installed.

Containers:

• api.casher.dev running php:7.4-fpm-alpine
• db.casher.dev running postgres:latest

Database schema:

Installation:

1. Clone the repository:

git clone https://github.com/lucianocarvalho/casher-api

2. Setup the application using Docker:

cd casher-api && docker-compose up -d

3. Copy .env.example to .env

cp src/.env.example src/.env

4. Install the dependencies using composer:

docker exec -ti api.casher.dev composer install

5. Run the migrations:

docker exec -ti api.casher.dev php artisan migrate

6. If you want, run the seeds:

docker exec -ti api.casher.dev php artisan db:seed

7. Open http://localhost in your browser.

Documentation

All the documentation will be generated by Swagger soon.

Improvements:

You can check all the future improvements at GitHub issues.

Bugs and features:

This project tracks issues and feature requests using the GitHub issue tracker.

Feel free to create a new issue or send a pull request.

Author

Luciano Carvalho (lucianocarvalho.dev) - @lucianocarvalho