msgaspar / zefirula-api

API para criação e gerenciamento de ligas personalizadas do jogo CartolaFC.

Zé Firula API

Uma API para criar e gerenciar ligas personalizadas do jogo CartolaFC, com atualização automática das pontuações a partir da API oficial do Cartola.

Stack utilizada

• TypeScript
• Express
• TypeORM
• PostgreSQL
• JSON Web Token
• Redis
• Prettier/ESLint
• Deploy na AWS EC2

Executando o projeto localmente

É necessário ter instalado

• Node.js
• Yarn ou npm
• Git
• Docker e Docker Compose

Siga os passos abaixo

# Clone o repositorio
$ git clone https://github.com/msgaspar/zefirula-api.git

# Entre no diretório do projeto:
$ cd zefirula-api

# Instale as dependências
$ yarn

# Crie na raiz do projeto uma cópia do arquivo ormconfig.example.json com o nome ormconfig.json:
$ cp ormconfig.example.json ormconfig.json

# Inicie os bancos de dados PostgreSQL e Redis usando o Docker Compose:
$ docker-compose up -d postgres redis

# Rode as migrações do banco de dados com o comando:
$ yarn typeorm migration:run

# Crie as credenciais de admin no banco de dados:
$ yarn seed:admin

# Inicie a aplicação
$ yarn dev