Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/smoothemerson/in.orbit_server

Project given by Rocketseat in NLW POCKET event.
https://github.com/smoothemerson/in.orbit_server

drizzle fastify nodejs sql typescript zod

Last synced: 2 months ago
JSON representation

Project given by Rocketseat in NLW POCKET event.

Awesome Lists containing this project

README

        

# in.orbit SERVER

Backend da aplicação in.orbit, uma plataforma para gerenciamento de metas.

## 🛠 Tecnologias

As principais ferramentas usadas no desenvolvimento do projeto são:

- **[TypeScript](https://www.typescriptlang.org/)**: Linguagem para desenvolvimento com tipagem estática.
- **[Fastify](https://fastify.dev/)**: Framework web rápido e leve para Node.js.
- **[Zod](https://zod.dev/)**: Biblioteca para validação de esquemas.
- **[DayJS](https://day.js.org/)**: Biblioteca para manipulação de datas.

> Para detalhes sobre as dependências gerais da aplicação, consulte o arquivo [package.json](./package.json).

## ⚙ Setup

### 📝 Requisitos

Certifique-se de ter as seguintes ferramentas instaladas:

- [Git](https://git-scm.com)
- [NodeJS](https://nodejs.org/en/)
- [NPM](https://www.npmjs.com/), [PNPM](https://pnpm.io/pt/) ou [Yarn](https://yarnpkg.com/)

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

Para testar as rotas da aplicação, você pode usar o cliente HTTP [Postman](https://www.postman.com/).

### Clonando e Executando

Siga estes passos para clonar e executar a aplicação localmente:

```bash
# Clone este repositório
$ git clone [email protected]:smoothemerson/in.orbit_server.git

# Acesse a pasta do projeto no terminal
$ cd in.orbit_server

# Instale as dependências
$ npm install

# Crie o arquivo '.env' e preencha as variáveis conforme o arquivo '.env.example'

# Utiliza-se DOCKER como banco de dados
$ docker compose up -d

# Execute as migrations para criar as tabelas necessárias no banco
$ npx drizzle-kit generate
$ npx drizzle-kit migrate

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

# A aplicação iniciará na porta configurada no arquivo '.env'
```


Feito com 💜 por Emerson Rocha 👋🏽 Entre em contato!