Game API

Minha primeira API seguindo a arquitetura REST (:

🚧 Melhorias

Projeto em desenvolvimento, as próximas atualizações serão:

• Adicionar comentários ao código para melhor compreensão.
• Criar o front-end da aplicação para consumo da API.
• Criar um banco de dados real onde a API buscará os dados.
• Implementar o banco de dados real com o Sequelize.
• Criar sistema de autenticação da API
• RESTful com HATEOAS.
• Implementar melhorias de CSS no front-end

💻 Pré-requisitos

Antes de começar, verifique se você atendeu aos seguintes requisitos:

• Você instalou a versão mais recente do node
• Você instalou a versão mais recente do Postman (opcional, caso não utilize o front-end)

🚀 Instalando a Game API

Para instalar a Game API, siga estas etapas:

Fazer o clone do projeto e rodar o comando na pasta ./API :

npm install

Alterar o arquivo ./API/.envExample com os dados do seu banco :

# JWT key:
JWT_SECRET=secretpwd123

# Sequelize(database) configs 
DATABASE=database_name
USER=user
PASSWORD=password
HOST=localhost
DB_DIALECT=mysql

Para criar as tabelas, basta descomentar o seguinte trecho nos arquivos ./API/database/(Users.js & Games.js) :

/* Arquivo Users.js */
User.sync({force: false});  

/* Arquivo Games.js */
Game.sync({force: false}); 

☕ Usando a Game API

Iniciar o servidor:

node index.js

📚 Documentação

Para visualizar a documentação da API, consulte o arquivo DOCUMENTAÇÃO.

📫 Contribuindo para a Game API

Para contribuir, siga estas etapas:

1. Bifurque este repositório.
2. Crie uma branch com o nome da sua feature: git checkout -b featurenova.
3. Faça suas alterações e confirme-as: git commit -m 'mensagem'
4. Envie para o branch original: git push origin featurenova
5. Crie a solicitação de pull.

Como alternativa, consulte a documentação do GitHub em como criar uma solicitação pull.

🤝 Colaboradores

_{Victor Souza}

📝 Licença

Esse projeto está sob licença. Veja o arquivo LICENÇA para mais detalhes.

⬆ Voltar ao topo