docs: update readme file who run with docker

README.md

@@ -1,45 +1,179 @@
-<h1 align="center">Welcome to company questions 👋</h1>
+[![License](https://img.shields.io/github/license/Mikael-R/company-questions?style=flat-square)](LICENSE.md) [![Last Commit](https://img.shields.io/github/last-commit/Mikael-R/company-questions?style=flat-square)](https://github.com/Mikael-R/company-questions/commits/) ![Language Most Used](https://img.shields.io/github/languages/top/Mikael-R/company-questions?style=flat-square) [![Implementations](https://img.shields.io/badge/%F0%9F%92%A1-implementations-8C8E93.svg?style=flat-square)](https://github.com/Mikael-R/company-questions/issues) ![Repository Size](https://img.shields.io/github/repo-size/Mikael-R/company-questions?style=flat-square)
 
-> Project for job test
+[![Forks](https://img.shields.io/github/forks/Mikael-R/company-questions?style=social)](https://github.com/Mikael-R/company-questions/network/members) [![Stars](https://img.shields.io/github/stars/Mikael-R/company-questions?style=social)](https://github.com/Mikael-R/company-questions/stargazers) [![Watches](https://img.shields.io/github/watchers/Mikael-R/company-questions?style=social)](https://github.com/Mikael-R/company-questions/watchers)
+
+<h1 id="title" align="center">Welcome to company-questions 👋</h1>
+
+> Template for response questions
 
 ### ✨ [Demo](https://compay-questions.vercel.app)
 
-## Install
+<details>
+<summary>Screenshots</summary>
+
+<img src="https://user-images.githubusercontent.com/60241602/168453719-83029f10-538a-4c42-98dd-97e367b4087f.png" width="240" alt="screenshot-1">
+
+<img src="https://user-images.githubusercontent.com/60241602/168453729-7539c06d-d8f4-4917-bf4b-1880406688f9.png" width="240" alt="screenshot-2">
+
+<img src="https://user-images.githubusercontent.com/60241602/168453777-640c0c90-023e-441e-b6cb-c49520451fdf.png" width="240" alt="screenshot-3">
+
+</details>
+
+### 🔖 Table Of Contents
+
+- 🤔 [How To Use](#how-to-use)
+- 🚀 [Technologies](#technologies)
+- 🎊 [Features](#features)
+  - 🎇 [Finished](#features-finished)
+  - 🎆 [Pendent](#features-pendent)
+- 💡 [How To Contribute](#how-to-contribute)
+- 🤗 [Contributors](#contributors)
+- 👤 [Author](#author)
+- 🔏 [License](#license)
+
+---
+
+<h2 id="how-to-use">🤔 How To Use</h2>
+
+### Using node
+
+#### Install Dependencies
+
+```bash
+npm install
+```
+
+or,
 
-```sh
-yarn install
+```bash
+yarn
 ```
 
-## Usage
+#### Run Aplication
 
-```sh
-yarn dev
+```bash
+npm start
 ```
 
-or
+or,
 
-```sh
-docker-compose up -d
+```bash
+yarn start
 ```
 
-### View components
+Runs the app in the development mode.<br />
+Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
 
-```sh
+#### Run storybook
+
+```bash
+npm run storybook
+```
+
+or,
+
+```bash
 yarn storybook
 ```
 
-## Technologies
+#### Run tests
 
-- Next
-- React
-- Typescript
-- Docker
-- Axios
-- Git
-- Styled Components
-- Storybook
+```bash
+npm run cypress-open
+```
+
+or,
+
+```bash
+yarn cypress-open
+```
+
+### Using docker
+
+#### Create Containers
+
+```bash
+sh ./scripts/docker-compose-setup.sh
+```
+
+#### Run Aplication
+
+```bash
+sh ./scripts/start-server.sh
+```
 
-## Author
+Runs the app in the development mode.<br />
+Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
+
+#### Run storybook
+
+```bash
+sh ./scripts/run-storybook.sh
+```
+
+#### Run tests
+
+```bash
+sh ./scripts/run-tests.sh
+```
+
+[Back To The Top](#title)
+
+---
+
+<h2 id="technologies">🚀 Technologies</h2>
+
+- [Next](https://nextjs.org/)
+- [React](https://reactjs.org/docs/getting-started.html)
+- [Axios](https://axios-http.com/ptbr/docs/intro)
+- [Styled Components](https://styled-components.com/)
+- [Typescript](https://www.typescriptlang.org/docs/)
+- [Docker](https://docs.docker.com/)
+- [Storybook](https://storybook.js.org/)
+- [Cypress](https://www.cypress.io/)
+
+[Back To The Top](#title)
+
+---
+
+<h2 id="features">🎊 Features</h2>
+
+<h4 id="features-finished">🎇 Finished</h4>
+
+- [x] Create layout
+- [x] Add storybook
+- [x] Add tests
+
+<h4 id="features-pendent">🎆 Pendent</h4>
+
+[Back To The Top](#title)
+
+---
+
+<h2 id="how-to-contribute">💡 How To Contribute</h2>
+
+- Make a fork of this repository
+- Clone to you machine and entry on respective paste
+- Create a branch with your resource: `git checkout -b my-feature`
+- Commit your changes: `git commit -m 'feat: My new feature'`
+- Push your branch: `git push origin my-feature`
+- A green button will appear at the beginning of this repository
+- Click to open and fill in the pull request information
+
+<p align="center">
+<i>Contributions, issues and features requests are welcome!</i><br />
+<i>📮 Submit PRs to help solve issues or add features</i><br />
+<i>🐛 Find and report issues</i><br />
+<i>🌟 Star the project</i><br />
+</p>
+
+Check out the [contributing](./CONTRIBUTING.md) page to see the best places to file issues, start discussions and begin contributing.
+
+[Back To The Top](#title)
+
+---
+
+<h2 id="author">👤 Author</h2>
 
 👤 **Mikael R**
 
@@ -48,10 +182,8 @@ yarn storybook
 - Github: [@Mikael-R](https://github.com/Mikael-R)
 - LinkedIn: [@mikael-r](https://linkedin.com/in/mikael-r)
 
-## Show your support
-
-Give a ⭐️ if this project helped you!
+[Back To The Top](#title)
 
 ---
 
-_This README was generated with ❤️ by [readme-md-generator](https://github.com/kefranabg/readme-md-generator)_
+_This README was generated with 💟 by [readme-template-generator](https://github.com/Mikael-R/readme-template-generator)_