O Carnaval já acabou no ano de 2023 mas que tal ver os nomes e informações das escolas de samba do Rio de Janeiro (Grupo Especial e Série Ouro) e também das escolas de samba de São Paulo(Grupo Especial e Grupo de Acesso 1)? Aqui está uma API que junta as informações de todas essas escolas incluindo: Nome, fundação, cidade e grupo de cada uma.
/escolas
: é possível renderizar todas as escolas de samba de São Paulo e Rio de Janeiro que estão no banco de dados./escolas/search?q={termo-da-pesquisa}
: já parou para pensar quantas escolas tem Unidos no nome? E que tal acadêmicos? Pesquisando dessa forma você poderá ver todas as escolas que tem este termo e quantos resultados são retornados!/escolas/sp
: aqui você vê todas as escolas de samba de São Paulo!/escolas/sp/:id
: nessa rota é possível você renderizar uma escola de SP através do id/escolas/sp/search?q={termo-da-pesquisa}
: aqui você pesquisa só as escolas de São Paulo/escolas/rj
: aqui você vê todas as escolas de samba do Rio de Janeiro!/escolas/rj/:id
: nessa rota é possível você renderizar uma escola de RJ através do id/escolas/rj/search?q={termo-da-pesquisa}
: aqui você pesquisa só as escolas do Rio de Janeiro
🔽 Instalando as dependências
- Clone o projeto
git clone git@github.com:joanamds/escolas-de-samba.git
- Entre no diretório do projeto
cd escolas-de-samba
- Instale as dependências
npm install
- Primeiro instale os containers:
docker-compose up -d
- Em seguida abra o terminal interativo do container:
docker exec -it escolas_de_samba bash
- Instale as dependências dentro do container:
npm install
🚀 Para rodar a API
- Entre no terminal interativo do container:
docker exec -it escolas_de_samba bash
- Rode o seguinte comando dentro do container:
npm run debug
- Renomeie o arquivo '.env.example' para '.env'
- Certifique-se que o MySQL está rodando com as configurações necessárias do arquivo '.env'
- Execute a aplicação com
npm start
Ou:
npm run debug
Back-end:
Desenvolvido usando: Docker, docker-compose, SQL, Node.js, Mocha