Skip to content

Latest commit

 

History

History
190 lines (130 loc) · 5.49 KB

README.md

File metadata and controls

190 lines (130 loc) · 5.49 KB
Raw

Workshop

💻 Sistema de gestão de arquivos por tipo de usuário e criação de assinatura.

🚧 Workshop 🚀 em modo produção... 🚧

Badge Badge Badge Badge Twitter

💻 Sobre o projeto

💻 Workshop - é um sistema pensado e criado para a empresa Volmaq para cadastrar manuais e catálogos a fim da facilitar o acesso dos mesmos por seus colaboradores.

Features

  • Departamento;
    • Cadastrar;
    • Listar;
    • Editar
  • Usuário;
    • Cadastrar;
    • Listar;
    • Editar
  • Produtos;
    • Cadastrar;
    • Listar;
    • Editar
  • Modelos;
    • Cadastrar;
    • Listar;
    • Editar
  • Cadastro de arquivo ;
  • Vincular arquivo com produto e modelo;
  • Listar arquivo de acordo com o tipo e perfil de usuário: mecânico, consultor ou administrador;
  • Gerar assinatura para email;
  • Visualizador de PDF sem opção de download.

🚀 Como executar o projeto

Este projeto é divido em três partes:

  1. Backend (pasta server)
  2. Frontend (pasta frontend)

💡 O Frontend necessita que o Backend esteja sendo executado para funcionar. É possível testar em modo de produção apenas com o backend executando, basta navegar para:

http://localhost:3000/login

Pré-requisitos

Antes de começar, você vai precisar ter instalado em sua máquina as seguintes ferramentas: Git, Node.js. Além disto é bom ter um editor para trabalhar com o código como VSCode

🎲 Rodando o Backend (servidor)

# Clone este repositório
$ git clone https://github.com/gabrielsants/workshop.git

# Acesse a pasta do projeto no terminal/cmd
$ cd workshop

# Vá para a pasta server
$ cd server

# Instale as dependências
$ npm install

# Execute a aplicação em modo de desenvolvimento
$ npm run dev:server

# O servidor inciará na porta:3000

🧭 Rodando a aplicação web (Frontend)

# Clone este repositório
$ git clone https://github.com/gabrielsants/workshop.git

# Acesse a pasta do projeto no seu terminal/cmd
$ cd whorkshop

# Vá para a pasta da aplicação Front End
$ cd frontend

# Instale as dependências
$ npm install

# Execute a aplicação em modo de desenvolvimento e live reload
$ ng serve -o

# A aplicação será aberta na porta:4200 - acesse http://localhost:4200

♟ Database

Este projeto utiliza MYSQL mas também pode ser executado com MARIADB. Os scripts e o modelo estão na pasta database.

🛠 Tecnologias

As seguintes ferramentas foram usadas na construção do projeto:

Web system (Angular 11 + TypeScript)

Veja o arquivo package.json

Server (NestJS + TypeScript)

Veja o arquivo package.json

💪 Como contribuir para o projeto

  1. Faça um fork do projeto.
  2. Crie uma nova branch com as suas alterações: git checkout -b my-feature
  3. Salve as alterações e crie uma mensagem de commit contando o que você fez: git commit -m "feature: My new feature"
  4. Envie as suas alterações: git push origin my-feature

Contributors

📝 Licença

This project is under license MIT.

Made with ❤️ by Contributors

Contact me on LinkedIn! 👋🏽

gabrielsaints