An open API service indexing awesome lists of open source software.

https://github.com/mikael-r/company-questions

🎩 Template for response questions
https://github.com/mikael-r/company-questions

cypress docker historybook next react styled-components tests typescript

Last synced: 4 months ago
JSON representation

🎩 Template for response questions

Awesome Lists containing this project

README

          

[![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)

[![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)

Welcome to company-questions 👋

> Template for response questions

### ✨ [Demo](https://compay-questions.vercel.app)

Screenshots

screenshot-1

screenshot-2

screenshot-3

### 🔖 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)

---

🤔 How To Use

### Using node

#### Install Dependencies

```sh
yarn
```

#### Run Aplication

```sh
yarn dev
```

Runs the app in the development mode.

Open [http://localhost:3000](http://localhost:3000) to view it in the browser.

#### Run storybook

```sh
yarn storybook
```

#### Run tests

```sh
yarn cypress-open
```

### Using docker

#### Run Aplication

```sh
sudo make start
```

Runs the app in the development mode.

Open [http://localhost:3000](http://localhost:3000) to view it in the browser.

#### Run storybook

Open [http://localhost:6006](http://localhost:6006) to view storybook in the browser.

```sh
sudo make storybook
```

#### Run tests

```sh
sudo make tests
```

[Back To The Top](#title)

---

🚀 Technologies

- [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)

---

🎊 Features

🎇 Finished

- [x] Create layout
- [x] Add docker
- [x] Add storybook
- [x] Add tests
- [x] Create Readme

🎆 Pendent

[Back To The Top](#title)

---

💡 How To Contribute

- 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


Contributions, issues and features requests are welcome!

📮 Submit PRs to help solve issues or add features

🐛 Find and report issues

🌟 Star the project

[Back To The Top](#title)

---

👤 Author

👤 **Mikael R**

- Website: https://mikael.idti.tech/
- Twitter: [@mikaelr16](https://twitter.com/mikaelr16)
- Github: [@Mikael-R](https://github.com/Mikael-R)
- LinkedIn: [@mikael-r](https://linkedin.com/in/mikael-r)

[Back To The Top](#title)

---

_This README was generated with 💟 by [readme-template-generator](https://github.com/Mikael-R/readme-template-generator)_