IFRS / pagif

Sistema de pagamentos integrado ao PagTesouro.
https://pagtesouro.ifrs.edu.br
GNU General Public License v3.0
2 stars 0 forks source link

PagIF

Sistema de Pagamentos integrado ao PagTesouro.

Utilização

O sistema é dividido em dois "serviços", um para o backend e outro para o frontend.

Backend

O backend é desenvolvido em NodeJS com Express e banco de dados MongoDB através do Mongoose. Confira abaixo os comandos disponíveis.

# instalação de dependências
$ npm install

# roda o linter para verificar inconsistências no código
$ npm run lint

# corrige automaticamente as insconsistências encontras, quando possível
$ npm run lint:fix

# roda o código e inicia o servidor de desenvolvimento (com monitoramento de mudanças)
$ npm run dev

# roda o código e inicia o servidor de produção
$ npm run start

Frontend

O frontend é desenvolvido com Nuxt 3. Confira abaixo os comandos disponíveis.

# instalação de dependências
$ npm install

# roda o linter para verificar inconsistências no código
$ npm run lint

# corrige automaticamente as insconsistências encontras, quando possível
$ npm run lint:fix

# remove arquivos de compilação e caches
$ npm run clean

# compila (com hot reload) e inicia o servidor de desenvolvimento
$ npm run dev

# compila para produção
$ npm run build

# inicia um servidor para conferir a aplicação após o build de produção
$ npm run preview

Para mais informações confira a documentação do Nuxt.

Criação de Super Administrador

Para criar um usuário super administrador, principalmente pela primeira vez, é necessário rodar um script no backend conforme abaixo:

$ npm run superadmin email@example.com

Atenção: O comando acima deve ser rodado no console do backend.

Contribuição

Toda contribuição é bem-vinda. Por favor, entre em contato em caso de dúvidas.

As contribuições no código devem ser feitas através de um PR.

Licença

Esse código é distribuído sob a licença GNU GPL 3.0.

A documentação, as imagens e demais mídias são distribuídas sob a licença Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International.