gsbenevides2 / siga-fatec

Um lib javascript para acessar informações do Siga das Fatecs de São Paulo

Home Page:https://siga-fatec.gui.dev.br/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Siga Fatec

Um SDK que possibilita fazer a raspagem de dados do site do Sistema Integrado de Gestão Acadêmica (SIGA) da Faculdade de Tecnologia de São Paulo (FATEC-SP).

📖 Documentação

A documentação está disponível em: https://siga-fatec.gui.dev.br.

👨‍💻 Tecnologias Utilizadas

  • Typescript: Linguagem de programação baseada em JavaScript.
  • Axios: Cliente HTTP baseado em Promises para fazer requisições.
  • Yarn: Gerenciador de pacotes.
  • NodeJS: Ambiente de execução JavaScript.
  • Jest: Framework de testes.

📁 Estrutura de Pastas

  • /src: Contém o código fonte do projeto.
  • /tests: Contém os testes do projeto.
  • /docs: Contém a documentação do projeto.

📦 Como Baixar

Para baixar o projeto, execute o seguinte comando no seu terminal:

npm install siga-fatec

Ou com o Yarn:

yarn add siga-fatec

🤝 Como Contribuir

Para contribuir com o projeto, siga os passos abaixo:

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

Algumas observações:

  • Sempre escreva um teste para cada nova funcionalidade que você desenvolver.
  • Se você encontrar algum bug, por favor, crie um teste que reproduza o erro. E abra um issue. Ao abrir você receberá mais intruções!

📃 Licença

Este projeto está sobre a licença MIT. Veja ela em: LICENSE.


Feito com ❤️ por gsbenevides2

About

Um lib javascript para acessar informações do Siga das Fatecs de São Paulo

https://siga-fatec.gui.dev.br/

License:MIT License


Languages

Language:HTML 91.8%Language:TypeScript 8.2%Language:JavaScript 0.0%