README.md

Base API in NestJS

English · Portuguese

About   |    Technologies   |    Tools   |    Installation   |    License

🔖 About

Base Nest API is an access control list base api that hopes to serve many projects written in Typescript.

💻 Technologies

• Typescript
• NestJS
• PostgreSQL
• Sqlite
• Docker

✨ Features & Libraries

• 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)

🔧 Tools

• WebStorm
• DataGrip
• Insomnia

📦 Installation

✔️ Prerequisites

The following software must be installed:

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

⬇️ Cloning the repository

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

▶️ Running the application

• 📦 API

  $ cd base-nest-api
  # Dependencies install.
  $ pnpm install
  # Config environment system
  $ cp .env.example .env
  # Run migrations
  $ pnpm db:migrate # by default, the database is sqlite
  # API start
  $ pnpm start:dev

📝 License

This project is under the MIT license. MIT ❤️

🚀 Contributors

Maia

Made with ❤️ by Maia 👋🏽 Get in touch!

⭐

Liked? Leave a little star to help the project ⭐

© 2017-present Maia