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

https://github.com/cryptovictor/organizame

O OrganizaMe trata-se de um site desenvolvido com o objetivo de facilitar o agendamento e a gestão de reservas de salas de forma simples, prática e eficiente.
https://github.com/cryptovictor/organizame

css3 ejs express html5 javascript markdown mvc-architecture nodejs

Last synced: about 2 months ago
JSON representation

O OrganizaMe trata-se de um site desenvolvido com o objetivo de facilitar o agendamento e a gestão de reservas de salas de forma simples, prática e eficiente.

Awesome Lists containing this project

README

          


Logo


# Projeto Individual Integrado - Módulo 2025-1B



Índice



  1. Descrição



  2. Primeiros Passos



  3. Contribuição


  4. Licença

# Descrição

O OrganizaMe trata-se de um site desenvolvido com o objetivo de facilitar o agendamento e a gestão de reservas de salas de forma simples, prática e eficiente. A plataforma permite ao usuário adicionar, modificar, editar e visualizar todas as informações relacionadas às reservas, com uma interface intuitiva e acessível, pensada para otimizar a experiência do usuário. Os dados são integrados diretamente a um banco de dados, garantindo atualização em tempo real e maior confiabilidade nas informações exibidas. Isso contribui para uma melhor organização e planejamento tanto por parte dos administradores do sistema quanto dos usuários que desejam reservar uma sala para seus compromissos. Com esse sistema, torna-se muito mais fácil evitar conflitos de horários, acompanhar a disponibilidade de espaços e manter um controle eficaz sobre o uso das salas, promovendo maior produtividade e organização.

# Tecnologias Utilizadas

![EJS](https://img.shields.io/badge/ejs-%23B4CA65.svg?style=for-the-badge&logo=ejs&logoColor=black)
![NodeJS](https://img.shields.io/badge/node.js-6DA55F?style=for-the-badge&logo=node.js&logoColor=white)
![Figma](https://img.shields.io/badge/figma-%23F24E1E.svg?style=for-the-badge&logo=figma&logoColor=white)
![Visual Studio Code](https://img.shields.io/badge/Visual%20Studio%20Code-0078d7.svg?style=for-the-badge&logo=visual-studio-code&logoColor=white)
![HTML5](https://img.shields.io/badge/html5-%23E34F26.svg?style=for-the-badge&logo=html5&logoColor=white)
![CSS3](https://img.shields.io/badge/css3-%231572B6.svg?style=for-the-badge&logo=css3&logoColor=white)
![JavaScript](https://img.shields.io/badge/javascript-%23323330.svg?style=for-the-badge&logo=javascript&logoColor=%23F7DF1E)

# Primeiros Passos

## Estrutura de Pastas

````bash
OrganizaMe-master/

├── config/ # Arquivos de configuração (ex: conexão com banco)
├── controllers/ # Lógica de controle das requisições
├── models/ # Definição de modelos de dados (estrutura do banco)
├── routes/ # Definição das rotas do sistema
├── services/ # Serviços auxiliares do sistema
├── assets/ # Arquivos públicos como imagens e fontes
├── scripts/ # Arquivos públicos de código
├── tests/ # Arquivos de testes unitários
├── views/ # Definição da visualização do sistema
│ └── components/ # Componentes usados nas páginas HTML (EJS)
│ ├── css/ # Estilização do site
│ ├── layout/ # Estrutura principal HTML (EJS) utilizada no sistema
│ ├── partials/ # Estruturas pré salvas usadas nas páginas HTML (EJS)
│ └── pages/ # Código HTML (EJS) das páginas
├── .gitignore # Arquivo para ignorar arquivos no Git
├── .env.example # Arquivo de exemplo para variáveis de ambiente
├── jest.config.js # Arquivo de configuração do Jest
├── package-lock.json # Gerenciador de dependências do Node.js
├── package.json # Gerenciador de dependências do Node.js
├── readme.md # Documentação do projeto (Markdown)
├── server.js # Arquivo principal que inicializa o servidor
├── app.js # Arquivo que inicializa o sistema
└── rest.http # Teste de endpoints (opcional)
````

## Pré Requisitos

Antes de começar, você precisará ter instalado em sua máquina as seguintes ferramentas:

- [Node.js](https://nodejs.org/) (versão recomendada: LTS)
- [npm](https://www.npmjs.com/)

Além disso, é recomendável usar um editor de código, como o [Visual Studio Code](https://code.visualstudio.com/).

## Instalação

1. Clone o repositório:

```bash
git clone https://github.com/CryptoVictor/OrganizaMe.git
```

2. Acesse a pasta do projeto:

```bash
cd OrganizaMe-master
```

3. Instale as dependências:

```bash
npm install
```

4. Inicie o servidor de desenvolvimento:

```bash
npm start
```

## Utilização

1. Configure o .env:

```bash
DB_USER='seu_usuario'
DB_HOST='localhost
DB_DATABASE='nome_do_banco'
DB_PASSWORD='sua senha'
DB_PORT=0000
```

2. Execute o servidor:

```bash
node server.js
```

3. Acesso as API's:

```bash
http://localhost:3000/api
```

4. Endpoints Disponíveis:

```bash
Usuários

GET /usuarios → Frontend do usuário
POST /api/usuarios → Cria um usuário
GET /api/usuarios → Lista todos os usuários
PUT /api/usuarios/:id → Atualiza um usuário
DELETE /api/usuarios/:id → Exclui um usuário
```

```bash
Salas

GET /salas → Frontend da sala
POST /api/salas → Cria uma nova sala
GET /api/salas → Lista todas as salas
PUT /api/salas/:id → Edita uma sala
DELETE /api/salas/:id → Exclui uma sala
```

```bash
Reservas

GET /reservas → Frontend da reserva
POST /api/reservas → Cria uma reserva
GET /api/reservas → Lista todas as reservas
PUT /api/reservas/:id → Atualiza uma reserva
DELETE /api/reservas/:id → Remove uma reserva
```

# Contribuição

Código feito por Victor Garcia Dos Santos

# Licença

MODELO GIT INTELI by Inteli, Victor Garcia Dos Santos is licensed under Attribution 4.0 International.