Missão [ Coragem do Mais Forte ] Iniciada!

O Sistema te dá os Parabéns!
Você foi escolhido(a) para ser um(a) Player

Arise é uma Aplicação FullStack construída para fornecer uma experiência gameficada das suas Tarefas/Missões cotidianas, afim de deixar o processo mais divertido e permitir que você alcance os seus objetivos com mais facilidade.

Nas linhas abaixo, você terá acesso a versão da API para já começar a se familiarizar com o Sistema .

Com os preparativos prontos, agora: Erga-se!

Funcionalidades • Instalação • Rodando localmente • Funcionalidades Futuras • Tecnologias • Licença

• Gameficação de Tarefas
• Nivelamente de Tarefas/Missões
• Sistema de Níveis
• Personalização de Perfil com Patentes
• Segurança e Login com Magic Link
• Controle de Acesso com Perfil(Roles)
• Documentação com Swagger

Para novas Funcionalidades verifique a Seção Funcionalidades Futuras

Antes de clonar o projeto, certifique que tenha as seguinte ferramentas instaladas em sua máquina:

Ferramentas e Links

• Node.js
• Npm or Yarn
• NestJS
• MySQL

Recomendações

• Recomendo utilizar o Editor de Texto VSCode para incrementar esse projeto;

Passo 1 - Clone o projeto

git clone https://github.com/Yuri-stack/Arise_Back

Navegue até o diretório principal do projeto

cd Arise_Back

Abra o projeto no VsCode

code .

Passo 2 - Instale as dependências

npm install

ou

yarn

Tenha certeza que sua internet esteja estável, pois esse processo pode levar um tempo

Passo 3 - Configurando as Variáveis de Ambiente

• Renomeie o arquivo env.local para .env;
• Preencha as informações do arquivo corretamente;

Passo 4 - Criando o Banco de Dados

Execute as migrates do Prisma

npx prisma migrate dev

Passo 5 - Popule o Banco de Dados

npm run seed

ou

yarn seed

Passo 6 - Execute a API

npm run dev

ou

yarn dev

Após os passos anteriores, abra em seu navegador o projeto acessando a endereço: http://localhost:3000/swagger

Veja abaixo as próximas Funcionalidades que serão adicionadas ao projeto:

Aguardamos novas ideias

• NestJS - Framework para a construir Aplicações Server-Side eficientes e escaláveis com Node.js;
• TypeScript - Linguagem de Programação fortemente tipada desenvolvida com base no Javascript;
• MySQL - Bando de Dados Relacional;
• Prisma - ORM voltado para o Ambiente Node;
• Jest - Ferramenta de Desenvolvimento de Testes;

O projeto Arise atualmente está sobre a Licença MIT e está aberto para receber implementações de novas funcionalidades de outros devs.

Para constribir, faça um fork do projeto e siga os passos da Seção: Instalação.

Feito com 👺 por Yuri Oliveira🚀.