📕 Projeto Bis2bis-Universities

Uma API REST para uma plataforma de registro de Universidades. Nessa API, podemos visualizar, cadastrar, editar e deletar universidades.A API foi desenvolvida utilizado as tecnologias TYPESCRIPT, NODE.JS, NEST.JS EXPRESS.JS, MONGODB como banco de dados SWAGGER para a documentação. Além disso, o projeto foi estruturado utilizando PROGRAMAÇÃO ORIENTADA A OBJETOS(POO) e princípios S.O.L.I.D.

🛠 Tecnologias

📃 Documentação no Swagger

Para visualizar a documentação é necessário clonar o projeto na sua maquina e rodar o seguinte comando: npm run start:dev depois de confirmar que o projeto está rodando é só clicar no link abaixo ↙
Swagger

✔️ Features

🎓 Universidades

Visualizar todas as universidades cadastradas
Visualizar universidades por país e página
Visualizar uma universidade específica
Criar uma nova universidade
Editar uma universidade já criada
Deletar universidade

🎲 Rodando o Back End (servidor)

Pré-Requisitos

Para rodar o projeto você vai precisar do Node.JS
Uma instancia de um banco de dados MongoDB
Um editor para trabalhar com o código como VSCode

Como instalar e Rodar

Para baixar o projeto

1. git clone https://github.com/efss7/bis2bis-universities.git
2. cd bis2bis-universities

Para instalar e rodar o projeto

3. npm install
4. npm run start:dev
    ou
3. yarn install
4. yarn run start:dev

Para popular/despopular o banco de dados com as universidades

5. npm run populate
6. npm run unpopulated
    ou
5. yarn run populate
6. yarn run unpopulated

Renomeie o arquivo .env.example para .env e preencha as variáveis com seus dados do banco de dados MongoDB. É muito importante para a execução do servidor.

👨‍💻 Desenvolvedor

_{Eric Silva}

Voltar para o topo ⬆️