Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rodrigoqueiroz12/in-orbit-node
Aplicação Node com Fastify
https://github.com/rodrigoqueiroz12/in-orbit-node
biome-js dayjs docker drizzle-orm fastify node paralleldrive-cuid2 postgres zod
Last synced: 24 days ago
JSON representation
Aplicação Node com Fastify
- Host: GitHub
- URL: https://github.com/rodrigoqueiroz12/in-orbit-node
- Owner: rodrigoqueiroz12
- Created: 2024-09-12T21:33:21.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2024-09-12T22:27:25.000Z (4 months ago)
- Last Synced: 2024-10-31T04:41:53.394Z (2 months ago)
- Topics: biome-js, dayjs, docker, drizzle-orm, fastify, node, paralleldrive-cuid2, postgres, zod
- Language: TypeScript
- Homepage:
- Size: 33.2 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# in.orbit
**Descrição breve do projeto**: Uma aplicação Node API construída durante o evento **NWL Pocket: JavaScript** da [Rocketseat](https://www.youtube.com/@rocketseat) que visa facilitar o gerenciamento de metas pessoais. Desenvolvido com as melhores práticas em mente para servir como backend para a aplicação React [**in.orbit**](https://github.com/rodrigoqueiroz12/in-orbit-react).
## Índice
1. [Sobre](#sobre)
2. [Funcionalidades](#funcionalidades)
3. [Tecnologias Utilizadas](#tecnologias-utilizadas)
4. [Instalação](#instalação)
5. [Uso](#uso)
8. [Contato](#contato)
## Sobre
Este projeto é uma aplicação Node API feita para gerenciar metas pessoais de maneira mais fácil.
## Funcionalidades
- **Funcionalidade 1**: Criação de metas.
- **Funcionalidade 2**: Marcação de metras concluídas no dia.
## Tecnologias Utilizadas
- [**Node**](https://nodejs.org/pt): Ambiente de execução JavaScript no servidor, ideal para aplicações escaláveis.
- [**Fastify**](https://fastify.dev/): Framework web rápido e eficiente para construir APIs em Node.js.
- [**Drizzle ORM**](https://orm.drizzle.team/): ORM leve e focado em TypeScript para facilitar a interação com bancos de dados.
- [**Docker**](https://www.docker.com/): Plataforma para criar, distribuir e executar aplicações em containers.
- [**Postgres**](https://www.postgresql.org/): Banco de dados relacional robusto e de código aberto.
- [**@paralleldrive/cuid2**](https://github.com/paralleldrive/cuid2): Biblioteca para gerar IDs únicos e seguros em sistemas distribuídos.
- [**Zod**](https://zod.dev/): Biblioteca TypeScript-first para validação e definição de esquemas de dados.
- [**Dayjs**](https://day.js.org/): Biblioteca JavaScript minimalista para manipulação e formatação de datas e horas.
- [**Biome JS**](https://biomejs.dev/pt-br/): Ferramenta para formatação e linting de código JavaScript e TypeScript.
## Instalação
Para rodar este projeto localmente, siga os passos abaixo:
1. **Clone o repositório**:
```bash
git clone https://github.com/rodrigoqueiroz12/in-orbit-node.git
```
2. **Acesse o diretório do projeto**:
```bash
cd in-orbit-node
```
3. **Instale as dependências**:
```bash
npm install
```
4. **Copie o arquivo `.env.example` e crie o `.env`**
5. **Inicie o serviço pg pelo Docker**:
```bash
docker compose up -d
```
Se o Docker não estiver instalado, atualize a variável `DATABASE_URL` no arquivo `.env` para utilizar o serviço PostgreSQL de sua preferência.
5. **Inicie a aplicação**:
```bash
npm run dev
```
Isso irá iniciar o servidor de desenvolvimento e abrir a aplicação no navegador.
**IMPORTANTE**: Quer ver o projeto funcionando com uma interface simples? clone o projeto [in-orbit-react](https://www.github.com/rodrigoqueiroz12/in-orbit-react) e siga o passo a passo para rodá-lo!
## Uso
Após iniciar o servidor, você pode realizar requisições em `http://localhost:3333/`.
## Contato
Se você tiver dúvidas ou sugestões, sinta-se à vontade para entrar em contato:
- **Nome**: Rodrigo
- **Email**: [email protected]
- [**LinkedIn**](https://www.linkedin.com/in/rodrigo-queiroz-a113a9212)
- [**GitHub**](https://github.com/rodrigoqueiroz12)