MaYo2943/Falko-API

:chart_with_upwards_trend: Falko API: Plataform for agile projects management :bar_chart:

Falko

See beyond
Visit our Wiki »

Access Falko · FrontEnd Repository · Report an Issue

Introduction

Falko is an web application, developed using Ruby on Rails API and Vue.js. It is a Freen Software Project, developed initially to GPP/MDS subjects of UnB - University of Brasília - Engineering Campus (FGA). Falko aims to promote a platform that makes easier for managers to manage agile projects through displaying metrics and relevant info regarding the project, also contributing to more eficient decision making.

Development setup

Development environment uses the containers architecture through Docker. To install, simply follow the guide How to Use Docker. If you're not familiar with docker, you can just simplify some default commands with make.

Make usage

Enters the Rails Console

$ make console

Creates the development and test database

$ make create-db

Drops down the docker environment

$ make down

Migrates the Rails database

$ make migrate

Lists all your running services

$ make ps

Removes all your docker networks

$ make rm-network

Removes all your docker mapped volumes

$ make rm-volume

Creates the Falko environment and run it

$ make run

Creates the Falko environment and run it as daemon

$ make quiet-run

Creates only the API environment, without database service

$ make run-api

Creates only the Postgres database environment, without API service

$ make run-db

Seeds the Rails database environment

$ make seed

Executes all of Rails' tests

$ make test

Docker Usage

• Download and install Docker CE at the official site.

• Download and install Docker Compose at the official site.

Clone the repository and enter it

git clone https://github.com/falko-org/Falko-API && cd Falko-API/

Make sure you're at devel branch

git checkout devel

Lift your environment

docker-compose up

Useful commands

How to download a docker image

docker pull imageYouWant

Listing local images

docker images

Deleting images

docker rmi -f imageId

Listing running containers

docker ps

Removing containers

docker rm [-f] containerNameOrId

Executing commands from outside the container

docker exec <container-name> <desired-command>

Example:

docker exec falko-api rails generate model User name:string

Documentation

Additional documentation is avaiable at Official Wiki.

How to Contribute

To contribute with us, the colaborator must fork and send a pull request with his/her contribution to devel branch. The code will be analized by one of the project's owners and, if approved, included to the application's core.

License

MIT

Copyright (c) 2018 Falko Organization