UNO Backend

Índice

Como clonar o repositório
Criando um arquivo .env
Instalando dependências
Iniciando o banco de dados com Docker Compose 🐳
Passo a passo
Contribuidores ✨

Como clonar o repositório

Para começar, você precisará ter o Git instalado na sua máquina. Você pode baixá-lo aqui.

Em seguida, siga os passos abaixo para clonar o repositório:

Abra o seu terminal.
Navegue até o diretório em que deseja clonar o repositório usando o comando cd.
Digite o seguinte comando para clonar o repositório:

git clone https://github.com/Uno-Online/uno-backend.git

Isso irá criar uma cópia do repositório no diretório atual do seu terminal.

Se você quiser clonar o repositório para um diretório com um nome diferente, adicione o nome do diretório após o comando git clone. Por exemplo:

git clone https://github.com/Uno-Online/uno-backend.git nome-do-diretorio

Isso irá criar um novo diretório chamado nome-do-diretorio e clonar o repositório dentro dele.

Agora que você clonou o repositório, você pode trabalhar nele na sua máquina local.

Para atualizar o repositório com as mudanças mais recentes do repositório remoto, use o comando git pull. Para enviar suas alterações para o repositório remoto, use o comando git push.

Antes de começar a trabalhar no código, é uma boa prática criar uma nova branch para o seu trabalho usando o comando git checkout -b nome-da-sua-branch. Isso garantirá que você não está trabalhando na branch principal do repositório e ajudará a organizar o seu trabalho.

Para mais informações sobre o uso do Git, consulte a documentação oficial aqui.

Criando um arquivo .env

Crie uma cópia do arquivo .env.example com o nome .env. Este arquivo contém variáveis de ambiente que serão usadas pela aplicação.

Você pode criar uma cópia do arquivo no terminal, usando o seguinte comando:

cp .env.example .env

Criando um arquivo .env

Crie uma cópia do arquivo .env.example com o nome .env. Este arquivo contém variáveis de ambiente que serão usadas pela aplicação.

Você pode criar uma cópia do arquivo no terminal, usando o seguinte comando:

cp .env.example .env

Instalando dependências

Pré-requisitos

Antes de instalar as dependências, você precisa ter o Node.js instalado em sua máquina. Você pode baixar a versão mais recente do Node.js em https://nodejs.org.

Instalação de dependências com npm

Para instalar as dependências de um projeto usando o npm, abra um terminal na pasta raiz do projeto e execute o seguinte comando:

npm install

Este comando irá instalar todas as dependências listadas no arquivo package.json na pasta node_modules.

Instalação de dependências com yarn

Para instalar as dependências de um projeto usando o yarn, abra um terminal na pasta raiz do projeto e execute o seguinte comando:

yarn

Este comando irá instalar todas as dependências listadas no arquivo package.json na pasta node_modules.

Iniciando o banco de dados com Docker Compose 🐳

Para iniciar o MySQL com o Docker Compose, é necessário ter o Docker instalado na máquina. Se você não tem o Docker instalado, siga as instruções de instalação em https://docs.docker.com/engine/install/.