Skip to content
This repository has been archived by the owner on May 22, 2023. It is now read-only.

StudynON/studynon.api

Repository files navigation

Owlrange Back-end

Sobre nosso Projeto

License: GPL v3

Este projeto tem como objetivo ajudar você nos seus estudos. 📚

Todos nós já passamos pelo problema de ter muito material de estudo e não conseguir definir um passo a passo e/ou acompanhar o quanto do material ja foi estudado. 😢

Com esse aplicativo, esse problema acaba. 😍

Stacks Utilizadas

  • TypeScript
  • Node.js
  • Docker
  • PostgreSQL
  • Prisma

Dependências globais

Você precisa ter três dependencias instaladas:

  • Node.js LTS v16 (ou superior, utilizaremos o nvm para gerenciar os pacotes node)
  • Yarn (caso não tenha instalado, poderá utilizar: npm install --global yarn)
  • Docker Engine v17.12.0 com Docker Compose v1.24.1 (ou qualquer versão superior)

Utiliza nvm? (Node Version Manager) Então pode executar nvm install v16.17.0 na pasta do projeto para instalar e utilizar a versão mais apropriada do Node.js.

Execute no terminal nvm use v16.17.0 para utilizar o node v16 com todas dependencias inclusas dentro do pacote node
Testar versões únicas caso você prefira (apenas verificar as versões) yarn -v retornara yarn v1.22 1.22.19 node -v retornara v16.17.0 npm -v retornara 8.15.0

Para usuarios do windows utilize a extensão editor config Inicie a abertura rápida do VS Code CTRL+P E execute este codigo ext install EditorConfig.EditorConfig

Como instalar o yarn global

Após baixar o repositório, não se esqueça de instalar as dependências locais do projeto:

npm install yarn --global

Rodar o projeto

Para rodar o projeto localmente, basta rodar o comando abaixo:

yarn dev
  • Para reiniciar o servidor (docker compose), basta utilizar as teclas rs e enter no terminal que estiver rodando

Dúvidas

Para dúvidas sobre o projeto Back-End, ou para o projeto em geral, por gentileza verifique primeiramente se sua dúvida consegue ser sanada no canal de status-projetos do servidor da Orange Juice no Discord.