README.md

DevChallenge RESTful API

Melhore suas habilidades através de desafios de front-end, back-end e mobile!

_{Procurando pelo repositório do aplicativo web? Acesse aqui!}

Tabela de conteúdos

• Sobre
• Feito com
• Para começar
  • Instalação padrão
    • Pré-requisitos
    • Instalando dependências
    • Inicializando uma instância local
  • Instalação com Docker
    • Pré-requisitos
    • Inicializando os contêineres
• Referência de API
• Como contribuir
• Autores
• Licença
• Nossa comunidade

Sobre

O DevChallenge é um projeto que visa contribuir com a evolução de desenvolvedores, disponibilizando desafios para que possam praticar, melhorar suas skills e criarem seus portfólios.

Feito com

• Node.js - JavaScript runtime
• Express - O framework web utilizado
• MongoDB - Base de dados não relacional
• Yarn - Gerenciador de pacotes e dependências

Para começar

Essas instruções vão te levar a uma cópia do projeto rodando em sua máquina local para propósitos de testes e desenvolvimento.

git clone https://github.com/Lorenalgm/DevChallengeAPI.git

cd DevChallengeAPI

Instalação padrão

Pré-requisitos

• Node.js versão 12 ou superior
• Um gerenciador de dependências - Yarn ou NPM
• Uma instância local ou um cluster do MongoDB

Instalando dependências

npm install

ou

yarn

Inicializando uma instância local

npm run dev

ou

yarn dev

Instalação com Docker

Caso prefira inicializar um ambiente de desenvolvimento com Docker, temos um arquivo docker-compose.yml preparado com as configurações necessárias.

Pré-requisitos

• Docker
• Docker Compose

Inicializando os contêineres

docker-compose up -d --build

Referência de API

Gostaria de ver quais serviços são disponibilizados por nossa API? Veja a REFERENCE.md para detalhes.

Como contribuir

Gostaria de contribuir com o projeto? Acesse CONTRIBUTING.md para o manual completo de contribuição.

Autores

• Lorena Montes - Trabalho inicial - Lorenalgm

Veja também a lista de contribuidores que ajudaram no projeto!

Licença

Este projeto é licenciado sob a Licença MIT - veja LICENSE.md para detalhes.

Nossa comunidade

Nosso objetivo é ajudar cada vez mais na evolução de desenvolvedores! Por isso, temos uma comunidade exclusiva do DevChallenge no Discord. Interessado? Participe!