assifems

📃 - Apresentação do Projeto

Este projeto consiste na elaboração de uma Progressive Web App para a digitalização da carteirinha da Associação dos Servidores do Instituto Federal do Mato Grosso do Sul(ASSIFEMS).

🏆 - Conquistas

🥇 - 1º Lugar Fecinova 2021

🎨 - Protótipo

O protótipo da aplicação foi feito utilizando Figma e pode ser acessado utilizando o link abaixo:

• Protótipo - Figma

👁️ - Demonstração

📈 - Pontuação da PWA

🔌 - Tecnologias

• NodeJS
• HTML
• JavaScript
• SCSS
• Express
• Docker
• EJS
• AdminJS
• Sequelize

❓ - Requisitos

Abaixo você confere os requisitos para rodar o projeto localmente:

• Editor de Código
• NodeJS
• Git
• WSL
• Docker

🖥️ - Rodando Localmente

Para rodar a aplicação na sua máquina, você deve seguir os passos abaixo:

Clone o projeto e acesse o diretório

  git clone https://github.com/igorviniciussantana/assifems.git
  cd assifems

Configure seus dados do banco

Utilizando o arquivo .env.example, insira os dados do seu banco

 # SECRET KEY
SECRET=

# Postgres Database
DB_USER=
DB_PASSWORD=
DB_NAME=
DB_HOST=
DB_PORT=
DB_DIALECT=

Configure o container

Utilize os comandos abaixo para criar o container e o banco de dados

docker compose -f docker-compose.yml -f compose/dev.yml build
docker compose -f docker-compose.yml -f compose/dev.yml run web yarn
docker compose -f docker-compose.yml -f compose/dev.yml run web yarn sequelize db:create
docker compose -f docker-compose.yml -f compose/dev.yml run web yarn sequelize db:migrate

Semeie o banco

Utilize o comando abaixo para adicionar dados prontos no seu banco

docker-compose run web yarn sequelize db:seed:all  

Finalmente poderemos rodar a aplicação com o comando abaixo

docker compose -f docker-compose.yml -f compose/dev.yml up

👥 - Autores