Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/luizpicolo/assifems

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).
https://github.com/luizpicolo/assifems

nodejs typescript

Last synced: 24 days ago
JSON representation

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).

Host: GitHub
URL: https://github.com/luizpicolo/assifems
Owner: luizpicolo
Created: 2022-08-08T02:48:47.000Z (over 2 years ago)
Default Branch: main
Last Pushed: 2023-03-13T10:07:45.000Z (over 1 year ago)
Last Synced: 2024-10-10T06:53:13.794Z (about 1 month ago)
Topics: nodejs, typescript
Language: JavaScript
Homepage:
Size: 8.37 MB
Stars: 1
Watchers: 3
Forks: 1
Open Issues: 10
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

![banner_markdown](https://user-images.githubusercontent.com/86114583/206916809-f5389454-e0af-4cb1-b902-e9a11990d1e7.png)

Carteirinha Digital - 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](https://www.figma.com/community/file/1180882217288338090)

## 👁️ - Demonstração

## 📈 - Pontuação da PWA
![pwa_scores](https://user-images.githubusercontent.com/86114583/206917545-3c5d4a7f-7a8b-4296-bb0e-4fe5f99c2b5e.png)

## 🔌 - 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
```bash
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
```bash
# 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

```bash
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

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

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

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

## 👥 - Autores

_{Igor Vinicius}

⠀⠀

_{André Luís}

⠀

_{Juan Carlos}

⠀