Simple App for learning purposes. Provides small CMR to managing the flats costs and extra features like ROI etc.
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.docker
app
bootstrap
config
database
public
resources/lang/en
routes
scripts
storage
tests
.editorconfig
.env.example
.gitattributes
.gitignore
.phpstorm.meta.php
Laravel.xml
_ide_helper.php
artisan
composer.json
composer.lock
docker-compose.yml
package-lock.json
package.json
phpunit.xml
readme.MD
server.php
webpack.mix.js

readme.MD

Flats Investment API Backend

Simple API application for managing cash flow in various investments.

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites

It is recommended to use Docker to start local fully configured environment, but there is also builtin Laravel's server.

Before starting doing anything, run this script to create local (sqllite) database for testing purposes and seed it with some fake data. It also installs composer dependencies.

./scripts/testing-config.sh

Be sure the script is executable.

Installing

A step by step series of examples that tell you how to get a development env running

Once the database credentials are configured and seeded, run Laravel's server or build Docker image.

php artisan serve   

OR

docker-compose up

Then try to login by endpoint: /api/login using any API Client like Postman with credentials:

email: admin@gmail.com, password: admin

Don't forget to set the headers:

Content-Type: application/json
X-Requested-With: XMLHttpRequest

Running the tests

Applications contains two kinds of test in the followings sub-dirs: feature and unit (names explains everything).

To run, perform a command:

/vendor/bin/phpunit 

Deployment

It is enough to deploy application using "Deployer.org" predefined Laravel's recipe. Of course you have to customize it according server requirements.

Built With

Authors

License

This project is licensed under the MIT License - see the LICENSE.md file for details