README.md

LifeToRemind

LifeToRemind is a website for career-oriented Personal Strategic Planning.

Deploys

LifeToRemind stable

LifeToRemind master

Tools and Environment

• Ubuntu 16.04.5 LTS 64-bit
• RVM 1.29.8
• Ruby 2.5.5p157
• Rails 5.2.3
• PostgreSQL 9.5.17

Installation and Execution

In one terminal, clone the repository.

git clone https://github.com/eduqg/LifeToRemind

Open the project folder.

cd LifeToRemind

Install Ruby Version Manager (RVM) for application configuration.

Run the commands to set the correct version for the project.

rvm install 2.5.5
gem install rails -v 5.2.3
bundle install

Install Postgres to the application database.

Make the necessary migrations.

rake db:create
rake db:migrate

Run the project.

rails s

Open the browser at localhost:3000

To run the application tests:

rspec

Execution with DOCKER (Open issue)

Install Docker

• Docker CE

• Docker Compose

Define variables

Define on: ./env_file.env

DB_USER=postgres
## The same name defined on docker-compose.yml
DB_HOST=db_ltr
## If you change default port 5432 you need to change in database.yml as well as execute a "docker-compose --build".
DB_PORT=5432
RAILS_MAX_THREADS=5
RAILS_ENV=development

Usefull Commands

## build docker-compose.yml
docker-compose build

## run deatached
docker-compose up -d

## list containers
docker ps -a

## join in the bash container
docker exec -it <container> bash

## stop container
docker stop <container>

## remove container
docker rm -f <container>

## stop all containers from docker-compose
docker-compose down

## inspect container
docker inspect <container>

## show container logs
docker logs <container>

## follow container logs
docker logs -f <container>

Execution Tests with Docker

Change enviroments

Change de value of key RAILS_ENV to test in ./env_file.env

RAILS_ENV=test

Run compose

docker-compose up -d

List containers and get "web" containerid

docker ps -a

Run tests

docker exec -it <container> bash -c "bundle exec rspec"

Become a Life to Remind Developer

To contribute to the project check the open issues. If what you want to improve or the problem you found is not already listed, create a new issue with a description of the problem. To contribute to the project send a Pull Request to the repository, it will be evaluated later.

Step 1 - Make a copy of the repository by clicking on the Fork tab.

Step 2 - Download the Life to Remind project created in your account.

git clone https://github.com/SEU_USUARIO/LifeToRemind.git

Step 3 - Make changes to the code and upload it to your repository.

git add new_file.txt

git commit -m "Adding new file"

git push origin master

Step 4 - Enter your repository with the changes made and click to make the Pull Request.

Step 5 - Wait for your Pull Request to be approved and congratulations on becoming a contributor to the Life to Remind Project!

Application Images

Donations

No sponsors yet! Get in touch to be the first!

If you want to support @eduqg, please consider buying a coffee. Thank you for your donation!