Skip to content

NetunoAcademy é um projeto com a finalidade de construir uma aplicação escalável e de fácil manutenção utilizando o framework Nestjs e conceitos como DDD e SOLID.

Notifications You must be signed in to change notification settings

Jackson-SM/NetunoAcademy_API

Repository files navigation

Nest Logo

Descrição

O "NetunoAcademy" é um emocionante projeto desenvolvido em Node.js, que visa criar uma plataforma educacional interativa para compartilhar e acessar cursos em diferentes áreas do conhecimento. Essa plataforma permitirá que instrutores qualificados ofereçam cursos de alta qualidade e que alunos interessados se inscrevam e façam parte desses cursos, criando assim uma comunidade de aprendizado dinâmica e envolvente.

Como utilizar a aplicação.

  • Primeiro, crie uma conta no site da cloudinary
  • Instale o Docker em sua máquina.

Clone o projeto.

git clone git@github.com:Jackson-SM/NetunoAcademy-API.git

Entre no diretório do projeto.

cd ./NetunoAcademy-API

Instale as dependências.

yarn install

Inicie o Dockerfile para configurar o contêiner.

// Antes, garanta que o Docker esteja inicializado.
docker-compose up -d

Variáveis de Ambiente

Para esse projeto, estaremos utilizando variaveis de ambiente para manter nossos dados sensíveis. O Banco de dados poderá ser configurado com o docker, mas caso deseje utilizar um Cluster de banco de dados também é possível.

Configurar as variaveis:

  • Caso já tenha todos os dados em mãos, poderá configurar as variaveis de ambiente utilizando o Shell Script criado para fazer isso automaticamente, apenas siga os passos abaixo.

Na raiz do projeto, execute o Environment.sh com o bash.

bash environment.sh

Para fazer isso manualmente, duplique o arquivo .env.example e renomeie para .env apenas. Em seguida edite o arquivo duplicado e renomeado substituindo os valores das variaveis.

Iniciar a aplicação

# Desenvolvimentoo
$ yarn run start

# watch mode
$ yarn run start:dev

# production mode
$ yarn run start:prod

Testar a aplicação

# unit tests
$ yarn run test

# e2e tests
$ yarn run test:e2e

# test coverage
$ yarn run test:cov

Conclusão

O "NetunoAcademy" é uma plataforma educacional desenvolvida em Node.js e NestJS, que proporciona uma experiência de aprendizado excepcional. Com recursos como o Swagger para documentação de APIs, a plataforma oferece uma interface interativa para explorar e compartilhar cursos em diversas áreas do conhecimento. Com cadastro de instrutores e alunos, painéis de gerenciamento, fóruns de discussão, avaliações, certificados e busca avançada, a plataforma promove uma comunidade de aprendizado colaborativa e segura, tornando-se uma solução valiosa para compartilhar conhecimento e enriquecer a educação.

Autores

About

NetunoAcademy é um projeto com a finalidade de construir uma aplicação escalável e de fácil manutenção utilizando o framework Nestjs e conceitos como DDD e SOLID.

Topics

Resources

Stars

Watchers

Forks