Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/rafaelppereira/portohacksantos2024-backend

✅ Projeto criado com o objetivo de trazer a atualização em tempo real das informações da APS
https://github.com/rafaelppereira/portohacksantos2024-backend

react vite

Last synced: about 1 month ago
JSON representation

✅ Projeto criado com o objetivo de trazer a atualização em tempo real das informações da APS

Awesome Lists containing this project

README

        

# Porto Hack Santos 2024

Este projeto foi concebido com a missão de oferecer um sistema onde pega as informações da fonte de dados (API) da APS para lidar com isso em tempo real, inicialmente está com a tratativa de bater de tempos em tempos para manter sempre essa informação de forma atualizada.

## Vídeo explicativo
https://www.youtube.com/watch?v=e_bADCYhXwA

## Tabela de Conteúdos

- [Pré-requisitos](#pré-requisitos)
- [Instalação](#instalação)
- [Licença](#licença)
- [Contato](#contato)

## Pré-requisitos

Antes de começar a trabalhar com este projeto, é importante garantir que você tenha os seguintes pré-requisitos instalados e configurados:

- **Node.js e npm**: O Node.js é um ambiente de tempo de execução JavaScript que permite executar aplicativos JavaScript fora do navegador. O npm é um gerenciador de pacotes para instalação de bibliotecas e dependências.
- **Instalação**: Baixe e instale o Node.js a partir do [site oficial](https://nodejs.org/), que inclui o npm.
- **Verificação da instalação**:
```bash
node --version
npm --version
```

- **Nest CLI**: O Nest CLI é uma ferramenta de linha de comando que facilita a criação, desenvolvimento e teste de aplicativos NestJS.
- **Instalação**:
```bash
npm install -g @nestjs/cli
```
- **Verificação da instalação**:
```bash
nest --version
```

- **Editor de Código**: Um editor de código ou ambiente de desenvolvimento integrado (IDE) para escrever e editar o código fonte do projeto. Alguns exemplos populares incluem Visual Studio Code, Sublime Text, Atom e WebStorm.
- **Instalação**: Baixe e instale seu editor de código preferido a partir do site oficial.

- **Git (opcional)**: O Git é um sistema de controle de versão distribuído usado para rastrear as mudanças no código fonte durante o desenvolvimento de software.
- **Instalação**: Baixe e instale o Git a partir do [site oficial](https://git-scm.com/).
- **Verificação da instalação**:
```bash
git --version
```

Após garantir que todos os pré-requisitos estão instalados e configurados corretamente, você estará pronto para começar a trabalhar com o projeto NestJS.

## Instalação

Siga os passos abaixo para configurar e iniciar o projeto localmente em seu ambiente de desenvolvimento.

1. **Clone o Repositório:**
```bash
git clone https://github.com/rafaelppereira/portohacksantos2024-backend.git
cd portohacksantos2024-backend
```

2. **Intale as dependências**
```bash
npm install ou pnpm i
```

3. **Executar projeto**
```bash
npm start:dev ou pnpm start:dev
```

## Licença

Este projeto está licenciado sob a [Licença MIT](https://opensource.org/licenses/MIT) - veja o arquivo [LICENSE](LICENSE) para mais detalhes.

## Contato

Se você tiver alguma dúvida, sugestão ou feedback, não hesite em entrar em contato conosco. Estamos aqui para ajudar!

- **E-mail:** [[email protected]](mailto:[email protected])