feat: add readme documentation with images

.env.example

@@ -6,3 +6,6 @@ POSTGRES_USER=
 DATABASE_HOST=
 DATABASE_PORT=
 DATABASE_NAME=
+
+REDIS_HOST=
+REDIS_URL=

README.md

@@ -1,24 +1,124 @@
-# README
+<h1 align="center" >Rails Bootcamp 🐙</h1>
 
-This README would normally document whatever steps are necessary to get the
-application up and running.
+<br/>
+<p align="center">
+ <img align="center" alt="main-screen" src="public/images/main-screen.png" />
+</p>
 
-Things you may want to cover:
+<br/>
 
-* Ruby version
+<p align="center">
+ <img alt="bootcamp" src="https://img.shields.io/badge/Created%20by%3A-Diel-%236D5CCD" />
+ <img alt="EddyPBR" src="https://img.shields.io/badge/Developed%20by%3A-DouglasConstancio-%232F74C0" />
+ <img alt="Ruby" src="https://img.shields.io/badge/Main%20language-Ruby-%23DD3B3F" /> <br />
+ <img alt="Rails" src="https://img.shields.io/badge/Main%20framework-Rails-%23DD3B3E" /> <br />
+</p>
 
-* System dependencies
+<p align="center">
+ <a href="#-projeto">Projeto</a>&nbsp;&nbsp;&nbsp;|&nbsp;&nbsp;&nbsp;
+ <a href="#-tecnologias">Tecnologias</a>&nbsp;&nbsp;&nbsp;|&nbsp;&nbsp;&nbsp;
+ <a href="#-material-de-apoio">Material de apoio</a>&nbsp;&nbsp;&nbsp;|&nbsp;&nbsp;&nbsp;
+ <a href="#-como-baixar">Como baixar</a>&nbsp;&nbsp;&nbsp;|&nbsp;&nbsp;&nbsp;
+ <a href="#-backlog"> Backlog </a>&nbsp;&nbsp;&nbsp;|&nbsp;&nbsp;&nbsp;
+ <a href="#-aulas">Aulas</a>
 
-* Configuration
+---
 
-* Database creation
+## 💬 Projeto
 
-* Database initialization
+<p align="justify">
+ A ideia do projeto do bootcamp é principalmente promover e compartilhar conhecimento. O projeto foi concebido em uma arquitetura <i>MVC</i>, formado por autenticação/login com <i>Devise</i>, criação de usuários e o usuários consegue adicionar um banco de imagens com a ajuda do <i>ActiveStorage</i> e realizar o processamento de cores da imagem com <i>Sidekiq</i>.
 
-* How to run the test suite
+ <p align="center">
+ <img align="center" src="public/images/image.png">
+ </p>
 
-* Services (job queues, cache servers, search engines, etc.)
+ <p align="center">
+ <img align="center" src="public/images/images-list.png">
+ </p>
 
-* Deployment instructions
+</p>
 
-* ...
+---
+
+## 🛠️ Tecnologias
+
+<p align="justify">
+ Abaixo estão algumas das tecnologias utilizadas durante o desenvolvimento do projeto. Ainda foi visado: Organizar o diretório da nossa aplicação de forma concisa e limpa. Escrever código limpo visando reutilização e eficiência.
+</p>
+
+<br>
+<p align="center">
+ <img src="https://img.shields.io/badge/Ruby_on_Rails-CC0000?style=for-the-badge&logo=ruby-on-rails&logoColor=white"/>
+ <img src="https://img.shields.io/badge/CSS3-239120?style=for-the-badge&logo=css3&logoColor=white"/>
+ <img src="https://img.shields.io/badge/HTML5-E34F26?style=for-the-badge&logo=html5&logoColor=white" />
+ <img src="https://img.shields.io/badge/Node.js-339933?style=for-the-badge&logo=nodedotjs&logoColor=white"/>
+ <img src="https://img.shields.io/badge/jQuery-0769AD?style=for-the-badge&logo=jquery&logoColor=white"/>
+ <img src="https://img.shields.io/badge/JavaScript-323330?style=for-the-badge&logo=javascript&logoColor=F7DF1E" />
+ <img src="https://img.shields.io/badge/Webpack-8DD6F9?style=for-the-badge&logo=Webpack&logoColor=white" />
+ <img src="https://img.shields.io/badge/Bootstrap-563D7C?style=for-the-badge&logo=bootstrap&logoColor=white" />
+ <img src="https://img.shields.io/badge/PostgreSQL-316192?style=for-the-badge&logo=postgresql&logoColor=white" />
+ <img src="https://img.shields.io/badge/redis-%23DD0031.svg?&style=for-the-badge&logo=redis&logoColor=white" />
+ <img src="https://img.shields.io/badge/Docker-2CA5E0?style=for-the-badge&logo=docker&logoColor=white" />
+
+</p>
+
+---
+
+## 🗂 Material de apoio
+
+- [ActiveStorage](https://guiarails.com.br/active_storage_overview.html)
+- [Bootstrap](https://getbootstrap.com/docs/4.0/getting-started/introduction/)
+- [Devise](https://github.com/heartcombo/devise)
+- [Docker](https://docs.docker.com/get-docker/)
+- [Docker-Hub](https://hub.docker.com/_/ruby)
+- [Ruby on Rails](https://guides.rubyonrails.org/)
+- [Sidekiq](https://github.com/mperham/sidekiq)
+
+---
+
+## ⬇️ Como baixar
+
+```bash
+ // Clonar repositório
+ $ git clone https://github.com/douglasconstancio/bootcamp-ruby.git
+
+ // Copie e edite `env.example`
+ $ cp env.example .env
+
+ // Ajuste a permissão dos `docker_entrypoint.sh`
+ $ chmod +x entrypoints/docker_entrypoint.sh
+
+ // Execute o build
+ $ docker-compose build
+
+ // Inicie os serviços docker
+ $ docker-compose up -d # opcional: manter em segundo plano
+
+ // Inicie o banco de dados
+ $ docker-compose exec web rails db:setup
+```
+---
+
+## 💭 Backlog
+
+- 🟢 Melhorias visuais como espaçamento e estado de alguns botões
+- ⛔️ Adicionar imagem no perfil
+- ⛔️ Adicionar mais campos no cadastro do usuário
+- ⛔️ Adicionar testes em geral
+
+---
+
+## 🚀 Aulas
+
+ Este projeto foi criado/ministrado pelo [Diel](https://github.com/gustavodiel). O bootcamp é/está sendo um evento online com muito código, desafios, networking e aprendizado.
+
+Ambiente criado seguindo [este tutorial](https://hackmd.io/@XBgk0kxlRnWrc48GVpMRVA/HJQeklI6t)
+
+* [Aula 1](https://hackmd.io/UWCBZXZ-QvSW_zS_5_Bfog)
+* [Aula 2](https://hackmd.io/RcwgP49yQlOV7sOdAaX2UQ)
+* [Aula 3](https://hackmd.io/fbYkNFBOQk-Yl2MiWkw3gw)
+* [Aula 4](https://hackmd.io/uOs-ccO8QgypgwaP4LbKKA)
+* [Aula 5](https://hackmd.io/4hUGe1TmRVShHhUfu9amAw)
+
+---