gustav-dev17 / partypro-api

Projeto PartyPro para o TCC II

API do projeto PartyPro

🤌 Requisitos para rodar, clonar e testar a aplicação:

1. Git ou GitHub Desktop: um sistema de controle de versões distribuído. Já o GitHub Desktop é um aplicativo que permite que você interaja com o GitHub usando uma GUI em vez da linha de comando ou de um navegador web, baixe e instale-o por este link.

2. Node: ambiente de execução Javascript server-side que permite o uso do JavaScript fora do navegador. Baixe e instale-o por este link.

3. Yarn: um gerenciador de pacotes para aplicar comandos prontos ao código de uma aplicação. Instale-o rodando o seguinte comando no terminal:

npm install --global yarn

4. Postman: um API Client que facilita aos desenvolvedores criar, compartilhar, testar e documentar APIs. Baixe e instale-o por este link.

5. Execução de scripts habilitada (no Windows). No Windows PowerShell aberto como adminitrador rode o comando abaixo e habilite a execução de scripts para todos os casos:

Set-ExecutionPolicy Unrestricted

🧬 Clonando o projeto

1. Utilize o link abaixo para clonar o projeto pelo GitHub Desktop:

https://github.com/Gustav-Dev17/partypro-api

ou pelo Git no terminal:

git clone https://github.com/Gustav-Dev17/partypro-api

💿 Instalando as dependências

1. Na pasta raíz do projeto abra um terminal e rode o comando:

yarn

🚀 Rodando a aplicação

1. Duplique o arquivo .env.example e renomeie a cópia para .env

2. Defina as variáveis de ambiente que serão utilizadas.

3. Gere o esquema do Prisma com:

npx prisma generate

4. Estabeleça a conexão e sincronização com o banco:

npx prisma db push

5. Por fim inicie a aplicação com o comando:

yarn dev

🛠️ Tecnologias utilizadas no projeto

• Typescript – superset do Javascript com tipagem e outras coisinhas a mais
• NodeJS – Ambiente de execução do Javascript externo ao navegador
• ExpressJs – Framework para aplicações web NodeJs
• Prisma ORM – uma ORM que facilita o trabalho com bancos de dados para desenvolvedores de aplicativos e recursos
• MongoDB – Programa de gerenciamento de banco de dados NoSQL de código aberto
• And more...