rafaeelaudibert / PIUBS

This was a repository with the intention of creating a platform to handle the Controversies Solution problem, in a cooperation project between UFRGS (Universidade Federal do Rio Grande do Sul) and the Brazilian Health Ministery, later made public

🏥 PIUBS 🏥

This repository is meant to create the platform to handle the Controversy Solution problem, in a cooperation project between UFRGS (Rio Grande do Sul's Federal University) and the Brazilian Health Ministery

💾 Prerequisites

To have this running your local machine, you only must have a Ruby version >= 2.3.1. Everything else is covered by Docker, which are used to keep your envinroment safe.

• Ruby >= 2.3.1
• Rails >= 5.2.1
• PGAdmin III (optional, awesome to see inside container database)

Learn more about Installing rbenv, which is pretty useful to manage your ruby versions.
Learn more about Installing Rails, which is pretty useful to have in your machine to improve debugging.

⚡ Getting Started

• Install application requirements listed above
• clone project

$ git clone https://github.com/rafaeelaudibert/PIUBS.git

• Install gems

$ cd PIUBS
$ bundle install

🐳 Deployment

Docker and Docker-compose are used to run this app.

REMEMBER TO SET CONFIG/.ENV ENVIRONMENT VARIABLES TO REFLECT WHAT YOU WANT TO DO, ESPECIALLY ABOUT DEVELOPMENT/TEST/PRODUCTION ENVIRONMENT

To build the images of PIUBS app you should run the following (only needed in the first time you are doing it):

$ docker-compose build

The next times, you just need to run the following. If you want to daemonize it, just append the -d flag

$ docker-compose up

In the first time you are running it, you need to configure the database. Be sure your containers are up, and run:

$ docker-compose exec app rake db:setup

It's done! You are ready to find your app running at localhost:8081 with a database port open in localhost:5433

If you want to enter in a container you can run docker-compose ps and see what is the name of your container according to piubs_<name_of_container>_1. After you only need to run the following, to enter in a bash inside the container, so you are able to run whatever you want:

$ docker-compose exec <name_of_container> /bin/bash

🔠 Running the tests

[WIP] Work in Progress. No tests yet, but RSpec will be used.

🚋 Built With

• RailsComposer - Application generation tool
• Bootstrap - Web Framework
• Ruby on Rails - Ruby Framework for web
• postgreSQL - SQL Database
• Redis - NoSQL Database
• ❤️ @ INF - UFRGS / Porto Alegre - Brazil

💪 Contributing

Please follow the issue guides to open any issue. Feel free to open any pull request, or contact the team here in Github. We use Gitmoji 🎉 in our commits, so please follow the guidelines of it.

🔢 Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

👷 Authors

All authors have commits related to the project backend, but we highlight the more specific features for each below:

• Felipe Comerlato - Filter tables feature, Database modeling and software documentation - felipefcomerlato
• Mario Figueiró - Database modeling and management, and front-end - mgfzemor
• Rafa Audibert - JavaScript related code, security/permissions configuration and Docker implementation - rafaeelaudibert

🌐 Website

The live version of this project WAS available at https://piubs.inf.ufrgs.br (currently not hosted anywhere)

📄 License

This project is licensed under the GNU AGPL 3.0 License - see the LICENSE.md file for details

⚠️ Disclaimer

This project is not being maintained anymore, and the current version doesn't completely implements the final product which this should have been, nor implements the security measures should have been taken to fullfill the requirements. Use it at you own risk.