README-pt.md

Base API em NestJS

English · Português

Sobre   |    Tecnologias   |    Ferramentas   |    Instalação   |    Licença

🔖 Sobre

Base Nest API é uma api base de controle de acesso que espera servir a muitos projetos escritos em Typescript.

💻 Tecnologias

• Typescript
• NestJS
• PostgreSQL
• Sqlite
• Docker

✨ Características e Bibliotecas

• Async Storage - Request context service async storage. (context)
• AWS S3 - Storage service for static files. (aws)
• Axios - HTTP client. (http)
• Firebase - Authentication service. (firebase)
• Knex - Query builder. (knex)
• NestJS Cache - Cache service. (cache)
• NestJS Config - Configuration service. (config)
• NestJS Schedule - Schedule service (cron).
• NestJS EventEmitter - Event service. (event)
• NestJS I18n - Internationalization service. (i18n)
• NodeMailer - Email service. (mail)
• Objection - ORM. (orm)
• Twilio - SMS service. (sms)
• Zod - Data validation. (validation)

🔧 Ferramentas

• WebStorm
• DataGrip
• Insomnia
• OpenAPI

📦 Instalação

✔️ Pré-requisitos

The following software must be installed:

• Node.js
• Pnpm or Yarn
• Git
• PostgreSQL or Sqlite

⬇️ Clonando o repositório

  $ git clone https://github.com/gabrielmaialva33/base-nest-api.git
  # Enter directory
  $ cd base-nest-api

▶️ Executando o aplicativo

• 📦 API

  $ cd base-nest-api
  # Dependencies install.
  $ pnpm install
  # Config environment system
  $ cp .env.example .env
  # Run migrations
  $ pnpm db:migrate # por padrão, o banco de dados é sqlite
  # API start
  $ pnpm start:dev

📝 License

Este projeto está sob a licença MIT. MIT ❤️

🚀 Contribuição

Maia

Feito com ❤️ por Maia 👋🏽 Entre em contato!

⭐

Gostou? Deixe uma estrelinha para ajudar o projeto ⭐

© 2017-present Maia