Assim como o Laguinho da UFCG é o ponto mais central da universidade, esta API centralizará os dados utilizados nos repositórios da OpenDevUFCG.
Os dados são abertos e todos podem contribuir com mais dados e endpoints. Veja mais detalhes no CONTRIBUTING.md e se joga no laguinho com a gente!
Veja aqui a documentação dos dos endpoints disponíveis
Para executar o Laguinho API localmente, é necessário ter o yarn
instalado e um Personal Access Token no github.
Siga os passos abaixo para gerar um token no github:
- Acesse este link (solicitará login no github caso ainda não esteja logado)
- Clique em "Generate new token"
- Dê um nome ao token em "Token description" e marque a opção "public_repo"
- Clique em "Generate token"
Após isso, o github exibirá o token, copie o token e crie um arquivo .env
na raiz do projeto baseado no arquivo .env.example
e modifique o valor da variável GITHUB_TOKEN
adicionando o seu token.
Para executar o servidor, basta rodar os seguintes comandos no terminal após a configuração do token:
yarn install
yarn start
Deverá aparecer a mensagem Listening on port 8080
e o servidor estará disponível em http://localhost:8080.
Caso queira executar em uma porta diferente, poderá modificar no arquivo .env
, que você já criou, o valor da variável LAGUINHO_PORT
para a porta desejada.