thalesmacena / agendai

Aplicação de Agendamento de Bandejão

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Agendai

🗂 Tabela de Conteúdo

📑 Sobre

Aplicativo de agendamento de bandejão da ufrj

💻 Technologies

Yarn

ESLint

Node.js

💱 Back-end

Express

Docker

Sequelize

PostgreSQL

🌐 Front-end Web

Typescript

React

Next.js

Styled Components

✨ Instalação

# Para copiar o repositório
git clone https://github.com/thalesmacena/agendai.git

💱 Back-end

O back-end foi feito utilizando Express.js, ele também utiliza o padrão de arquitetura MVC com o Sequelize, integrando Postgres como banco de dados. Além disso o projeto utiliza o padrão de estilo do Airbnb que junto com o plugin do prettier garantem um código limpo e claro.

🔥 Rodando a aplicação

Pré Requisitos

Para rodar o aplicato você vai precisar ter instalado:

  • Uma versão atualizada do Node.JS
  • O Gerenciador de pacotes Yarn ou NPM
  • Uma imagem do Postgres (é recomendável que utilize Docker para ter uma imagem desses banco de dados).
  • Uma cópia deste repositório localmente

Rodando a aplicação

  1. Acesse a pasta api e renomeie o arquivo .env.example para .env, altere as variaveis de ambiente com as credencias do passo a passo.
  2. Utilize o seguinte comando para baixar as dependencias:
yarn
  1. Utilize o seguinte comando para realizar as migrations do banco de dados:
yarn sequelize db:migrate
  1. Utilize o seguinte comando para inserir as unidades no banco:
yarn sequelize db:seed:all
  1. Utilize o seguinte comando para fazer o mock de uma api externa ao bandejão:
yarn dev

🌐 Front-End Web

O Front-end é feito em React utilizando o Framework Next.js, ele é estilizado utilizando styled-components.

🔥 Rodando a aplicação

Pré Requisitos

Para rodar o aplicato você vai precisar ter instalado:

  • Uma versão atualizada do Node.JS
  • O Gerenciador de pacotes Yarn ou NPM
  • Uma cópia deste repositório localmente

Rodando a aplicação

  1. Acesse a pasta web, que é referente ao front-end web
  2. Utilize o seguinte comando para baixar as dependencias:
yarn
  1. Utilize o seguinte comando para fazer a mock da api externa:
yarn server
  1. Você pode rodar o programa com o seguinte comando:
yarn dev

A aplicação rodará em localhost:3000

About

Aplicação de Agendamento de Bandejão

License:MIT License


Languages

Language:TypeScript 69.6%Language:JavaScript 30.1%Language:Shell 0.4%