palmeiras-api é uma API não-oficial, de código aberto, que fornece dados coletados do site oficial da Sociedade Esportiva Palmeiras sobre seus jogadores e clube (futuramente com mais features).
Siga os passos abaixo de instalação da API e seus comandos para rodar a API localmente em sua máquina.
What things you need to install the software and how to install them
NodeJS versao acima de 8.0.0
GIT
Baixe o projeto usando o comando abaixo para clonar este repositório:
cd pasta-destino-do-clone
git clone https://github.com/mukaportes/palmeiras-api
Entre na pasta nova e use o comando git abaixo para ir para a branch mais completa durante o desenvolvimento da API:
cd pasta-destino-do-clone/palmeiras-api
git checkout dev
Por fim, use o comando abaixo para instalar as dependencias da aplicação:
npm install
Use o comando abaixo para iniciar a aplicação na porta localhost:8084:
npm start
- GraphQL - Linguagem de API utilizada
- MongoDB - Banco de dados utilizado
- Mongoose - ODM JavaScript utilizado
- Express - Framework JS utilizado
- Mongoose-Sequence - Ferramenta para Auto-Incremento para schemas feitos com Mongoose
- Babel - Transpilador JS utilizado
This project is licensed under the MIT License - see the LICENSE.md file for details