STAR_WARS_API

Linha adicional de texto informativo sobre o que o projeto faz. Sua introdução deve ter cerca de 2 ou 3 linhas. Não exagere, as pessoas não vão ler.

Ajustes e melhorias

O projeto ainda está em desenvolvimento e as próximas atualizações serão voltadas nas seguintes tarefas:

• Estrutura do projeto
• Integração com banco de dados
• Crud com Graphql
• Crud via rest
• Crud com gRPC

☕ Techs usadas

• Docker
• Postegres
• Prisma
• Typescript
• Graphql

💻 Pré-requisitos

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

• Você instalou a versão mais recente de nodejs / yarn ou npm
• Você ter docker ou postgres

🚀 Usando starwars-api

Para rodar a api, siga estas etapas:

suba o banco de dados com esse comando

sudo docker run --name some-postgres -e POSTGRES_PASSWORD=docker -e POSTGRES_USER=docker -e POSTGRES_DB=starwars -p 5432:5432 -d postgres

certifique de ter a variável de ambiente criada

#.env
DATABASE_URL=postgresql://docker:docker@localhost:5432/starwars

instale as dependencias do projeto

yarn

ou

npm install

lembre de rodar as migrações do banco de dados

npx prisma migrate dev

estamos quase lá, rode o comando

yarn dev

📫 Contribuindo para starwars-api

Para contribuir com starwars-api, siga estas etapas:

1. Bifurque este repositório.
2. Crie um branch: git checkout -b <nome_branch>.
3. Faça suas alterações e confirme-as: git commit -m '<mensagem_commit>'
4. Envie para o branch original: git push origin https://github.com/Andreffelipe/starwars-api.git/main
5. Crie a solicitação de pull.

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

🤝 Colaboradores

Agradecemos às seguintes pessoas que contribuíram para este projeto:

André Filipe

😄 Seja um dos contribuidores

Quer fazer parte desse projeto? Clique AQUI e leia como contribuir.

📝 Licença

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

⬆ Voltar ao topo