Skip to content

Latest commit

 

History

History
72 lines (52 loc) · 3.54 KB

README.md

File metadata and controls

72 lines (52 loc) · 3.54 KB
Raw

👨‍💻 Projeto

Este projeto é uma API (Application Programming Interface) desenvolvida para a NEABI do Instituto Federal de Educação, Ciência e Tecnologia da Bahia (IFBA) - Campus Brumado. Ele tem como objetivo fornecer uma plataforma de armazenamento centralizado e acessível para objetos educacionais relacionados ao conteúdo do núcleo, permitindo que professores possam criar aulas de maneira eficiente e personalizada. Além disso, a API oferece recursos de gerenciamento de objetos educacionais, como pesquisa, adição, edição e exclusão, além de organizá-los de acordo com categorias específicas e tags. Ela também oferece recursos de busca avançada e filtragem para ajudar os professores a encontrar rapidamente os objetos educacionais relevantes.

A API foi desenvolvida utilizando as tecnologias Node.js, Express, Typescript, Docker, PostgreSQL, Prisma e Google OAuth 2.0, garantindo robustez e escalabilidade ao projeto, além de uma autenticação segura e autorização de acesso aos recursos. Isso assegura que somente usuários autorizados tenham acesso à plataforma e seus recursos, garantindo a privacidade e segurança dos dados armazenados. Com essa API, é possível fornecer uma experiência de usuário mais eficiente e personalizada para os professores, ajudando-os a criar aulas mais enriquecedoras e eficazes para os alunos.

🔒 Requisitos

  • Node 18.x
  • Docker
  • Docker Compose

🤔 Como usar?

  1. Clone esse repositório:
$ git clone https://github.com/VictorKayk/neabi-backend.git
  1. Entre no diretório:
$ cd neabi-backend
  1. Instale as dependências:
$ npm install

  1. Troque o nome do arquivo ".env.example" para ".env" e preencha todas as informações necessarias.

  2. Inicie a api em mode desenvolvedor

$ npm run dev
  1. Ou faça o build da api e inicie o servidor:
$ npm run start
  1. Ou monte uma imagem docker da api e rode apartir dela:
$ npm run docker:up

📕 Documentação

Para acessar a documentação de todas as rotas da api, acesse http://localhost:5000/docs com a aplicação rodando.

💻 Frontend

O repositório para o frontend da aplicação se encontra no perfil do Github de Thiago Gentil, desenvolvedor responsável pela construção do mesmo. O repositório pode ser encontrado seguindo o link abaixo: neabi-front

💁 Contribuição

Se você tiver uma sugestão que possa melhorar isso, por favor, crie uma cópia do repositório (fork) e crie uma solicitação de pull. Você também pode simplesmente abrir uma questão com a tag "enhancement" (melhoria). Não se esqueça de dar uma estrela para o projeto! Novamente, muito obrigado!

  1. Faça uma cópia do projeto (fork)
  2. Crie seu ramo de recurso (git checkout -b feature/AmazingFeature)
  3. Faça commit das suas alterações (git commit -m 'Add some AmazingFeature')
  4. Envie para o ramo (git push origin feature/AmazingFeature)
  5. Abra uma solicitação de pull.