mtikoian / hawk-api

Hawk (api)(:pig:) is a personal finance control.

Hawk (api)

Hawk is a personal finance control. The name Hawk is the name of pig in the anime "The Seven Deadly Sins" (Nanatsu no Taizai).

Installing / Getting started

This step is to explain what you need to run this application without having to configure the whole dev environment, but if you want to develop for this application, I will explain this step better in the following steps.

Minimum pre requirements

The minimum pre requirements you need to run this application is the Docker and Docker Compose.
After you install the Docker and Docker Compose, you need to run the commands below.

Running application with Docker Compose

# Clone this repository
$ git clone https://github.com/jroliveira/hawk-api.git

# Go into the repository
$ cd hawk-api

# Run the application
$ docker-compose up

Api Reference / Monitoring

• Swagger UI
• SonarQube
• Graphana
• Prometheus
• Kibana
• Elasticsearch
• Jaeger UI

Developing

Built With

• .NET Core
• C#
• ASP.NET Core
• Neo4j
• Docker

Pre requisites

Download and install:

• .NET Core SDK
• Neo4j
• Docker Compose
• Node.js

Setting up Dev

# Clone this repository
$ git clone https://github.com/jroliveira/hawk-api.git

# Go into the repository
$ cd hawk-api

# Download node packages and install Cake
$ npm install

Building

$ dotnet cake

Testing

$ dotnet cake --target=Test

Running

If you want to run with Docker Compose, you need to execute the command below:

# Run the application
$ docker-compose up

or

If you want to run with dotnet, you need to run the command below:

# Run dependencies
$ dotnet cake --target=Dependencies

# Run application
$ dotnet run --project ./src/Hawk.WebApi/

Deploying / Publishing

Manual

Using custom buildpack dotnetcore-buildpack

$ heroku buildpacks:set https://github.com/jincod/dotnetcore-buildpack

or

Automatic

Deploying / Publishing

$ dotnet cake --target=Release

Licensing

The code is available under the AGPL-3.0 license.