Documentação Técnica do Projeto QuizUTFPR

Tabela de conteúdos

• Tabela de conteúdos
  • 💻 Sobre o projeto
  • 🚀 Como executar o projeto
    • Pré-requisitos
    • Executando
      • NPM
      • Yarn
  • 🛠 Tecnologias
  • 💪 Como contribuir com o projeto
  • 🦸 Autores

💻 Sobre o projeto

Este projeto foi desenvolvido para divulgação do Sistema de Quiz, desenvolvido como projeto de extensão na UTFPR Campus Campo Mourão sob orientação dos professores Juliano Henrique Foleis e Marcos Silvano.

🚀 Como executar o projeto

Pré-requisitos

Antes de começar, você vai precisar ter instalado em sua máquina as seguintes ferramentas: Git, Node.js. Além disto é bom ter um editor para trabalhar com o código como VSCode.

Executando

NPM

$ git clone https://github.com/jhonatancunha/quiz_documentation
$ cd quiz_documentation
$ npm install
$ npm run start

Yarn

$ git clone https://github.com/jhonatancunha/quiz_documentation
$ cd quiz_documentation
$ yarn
$ yarn start

🛠 Tecnologias

As seguintes ferramentas foram usadas na construção do projeto:

• Docusaurus

Veja o arquivo package.json para mais detalhes.

💪 Como contribuir com o projeto

1. Faça um fork do projeto.
2. Crie uma nova branch com as suas alterações: git checkout -b my-feature
3. Salve as alterações e crie uma mensagem de commit contando o que você fez: git commit -m "feature: My new feature"
4. Envie as suas alterações: git push origin my-feature

🦸 Contribuidores

Jessé Pires

Jhonatan Cunha

Iago Carmona