Skip to content

rafaelqueiroz88/rafaelsblog

Repository files navigation

Contributors Forks Stargazers Issues GNU License LinkedIn


Logo


{R}afael on {R}ails

O que há de conteúdo por aqui?

Gostei! Como colaborar sem ter nenhuma experiência em desenvolvimento de software?
Explorar »

Conteúdo
  1. Acerca do projeto
  2. Primeiros passos
  3. Progresso
  4. Contribuição
  5. Licença
  6. Tudo Pronto
  7. Contato

Acerca do Projeto

Este projeto é apenas um laboratório para testes de novas tecnologias, bibliotecas, técnicas de desenvolvimento web, features entre outros. As informações aqui presente podem ser discutidas com intúito de melhorar ainda mais a riqueza de conteúdo presente neste Blog.

Tecnologias adotadas no desenvolvimento

Encontre nessa sessão todas as tecnologias que foram adotadas no desenvolvimento desta aplicação seguidas de suas respectivas fontes:

Primeiros passos

Para seguir com a instalação e inicialização da aplicação, será necessário fazer o download diretamente do Github ou o clone da aplicação. Além disso, é recomendado fortemente a leitura de toda a documentação antes de iniciar qualquer um dos passos listados a seguir.


Caso a opção escolhida seja o clone, execute o seguinte comando em seu terminal favorito:

git clone https://github.com/rafaelqueiroz88/rafaelsblog

Acesse o diretório da aplicação e então faça a instalação das bibliotecas necessárias


Dependencias do FrontEnd

yarn install

Dependencias do BackEnd

bundle install

Requisitos

Antes de iniciar a aplicação, será necessário verificar se todas as dependencias estão disponíveis na máquina

  • Postgresql (instalado, porém desativado caso queira usar o Docker)
  • Ruby 3.0.2 (ou superior)
  • Rails 6 (ou superior)
  • Docker (opcional)

O uso do Docker não é obrigatório, porém é recomendado. Entretanto, caso não queira utilizar a ferramenta, ignore o próximo passo e vá direto para a sessão de uso da aplicação com o Puma.


Utilizando o Docker (recomendado)

Para levantar a aplicação utilizando o Docker, apenas será necessário executar o montar e levantar a aplicação. Os comandos são:

docker-compose build
docker-compose up

Se necessário, pressione ctrl+c para parar a aplicação


Utilizando o puma

Para inicializar a aplicação diretamente em seu console com o servidor local, será necessário fazer algumas alterações:

  • Atualizar o arquivo config/database.yml
  • Inicializar o banco de dados do Postgresql
  • Inicializar o Redis
  • Configurar e inicializar o Sidekiq

Configuração do Shrine

O Shrine já estará preparado para armazenar imagens em ambiente local. Para os usuários do Docker ou do Heroku (que utilizam algo parecido com Docker em sua estrutura) será necessário fazer o Upload das imagens em algum serviço de Bucket como por exemplo a S3 da AWS, pois a cada vez que o container for desligado todos os arquivos serão perdidos, e com isso as imagens serão perdidas no processo. Para evitar que isso ocorra basta configurar o arquivo db/seeds.rb com as credenciais da AWS/S# ou talvez utilizar Inflection.


Após introduzir as configurações no arquivo seeds.rb, execute o seguinte comando:

rake db:seed

Obs. O comando seed não possui um output. Se nada aparecer após a execução do comando quer dizer que a execução foi um sucesso! Caso queira uma amostra visual do sucesso desta operação, utilize o console do Rails


Feito isso, será necessário reiniciar o servidor, pois a alteração se reflete no initializer do Shrine. Com esta alteração, o Shrine automaticamente deverá estar preparado para executar os uploads em qualquer plataforma (local ou nuvem).

Obs. Não será necessário aplicar esta configuração caso não estiver utilizando o Docker, porém considere aplicar essa configuração caso o projeto entrar em ambiente de produção por questão de boas práticas.


Progresso

Veja open issues para ver a lista de features sugeridas. Ou acompanhe as Branchs do projeto.

Contribuições

Contribuições fazem com que nossas aplicações sejam sempre melhores. Neste caso não é diferente. Caso queira compartilhar seu conhecimento basta seguir os passos. Sua ajuda será muito apreciada!

  1. Crie um Fork do projeto
  2. Crie a sua própria branch (git checkout -b feature/AmazingFeature)
  3. Escreva uma commit de suas alterações (git commit -m 'Add new feature')
  4. Envie as atualizações para a Branch (git push origin feature/AmazingFeature)
  5. Abra uma Pull Request para enviar suas sugestões de alteração

Licença

Distribuído sobre a licença GNU License. Veja mais em nossa base de conhecimentos.

Tudo pronto

Após a realização do passo-a-passo a aplicação estará disponível para acesso. Abra o seu navegador favorito e acesse:

localhost:3000/

Contato

Rafael Queiroz


Contributors Forks Stargazers Issues GNU License LinkedIn

Releases

No releases published

Packages

No packages published