Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/gabrielmaialva33/base-nest-api
📦 Base Nest API is an access control list base api that hopes to serve many projects written in Typescript.
https://github.com/gabrielmaialva33/base-nest-api
api api-rest base-project better-sqlite3 javascript nest nestjs nodejs objection-orm postgresql sqlite template template-project typescript zod
Last synced: about 23 hours ago
JSON representation
📦 Base Nest API is an access control list base api that hopes to serve many projects written in Typescript.
- Host: GitHub
- URL: https://github.com/gabrielmaialva33/base-nest-api
- Owner: gabrielmaialva33
- License: mit
- Created: 2022-11-12T13:06:37.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-04-18T05:24:56.000Z (7 months ago)
- Last Synced: 2024-04-18T06:38:13.398Z (7 months ago)
- Topics: api, api-rest, base-project, better-sqlite3, javascript, nest, nestjs, nodejs, objection-orm, postgresql, sqlite, template, template-project, typescript, zod
- Language: TypeScript
- Homepage: https://api.hidedevelopment.cloud/docs/redoc.html
- Size: 1.11 MB
- Stars: 6
- Watchers: 1
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README-pt.md
- License: LICENSE
Awesome Lists containing this project
README
Base API em NestJS
Sobre |
Tecnologias |
Ferramentas |
Instalação |
Licença
## :bookmark: Sobre
**Base Nest API** é uma api base de controle de acesso que espera servir a muitos projetos escritos em Typescript.
## :computer: Tecnologias
- **[Typescript](https://www.typescriptlang.org/)**
- **[NestJS](https://nestjs.com/)**
- **[PostgreSQL](https://www.postgresql.org/)**
- **[Sqlite](https://www.sqlite.org/index.html)**
- **[Docker](https://www.docker.com/)**
## :sparkles: Características e Bibliotecas
- **[Async Storage](https://nodejs.org/api/async_context.html)** - Request context service async storage. (context)
- **[AWS S3](https://aws.amazon.com/pt/s3/)** - Storage service for static files. (aws)
- **[Axios](https://axios-http.com/)** - HTTP client. (http)
- **[Firebase](https://firebase.google.com/)** - Authentication service. (firebase)
- **[Knex](http://knexjs.org/)** - Query builder. (knex)
- **[NestJS Cache](https://docs.nestjs.com/techniques/caching)** - Cache service. (cache)
- **[NestJS Config](https://docs.nestjs.com/techniques/configuration)** - Configuration service. (config)
- **[NestJS Schedule](https://docs.nestjs.com/techniques/scheduling)** - Schedule service (cron).
- **[NestJS EventEmitter](https://docs.nestjs.com/techniques/events)** - Event service. (event)
- **[NestJS I18n](https://nestjs-i18n.com/)** - Internationalization service. (i18n)
- **[NodeMailer](https://nodemailer.com/about/)** - Email service. (mail)
- **[Objection](https://vincit.github.io/objection.js/)** - ORM. (orm)
- **[Twilio](https://www.twilio.com/)** - SMS service. (sms)
- **[Zod](https://zod.dev/)** - Data validation. (validation)
## :wrench: Ferramentas
- **[WebStorm](https://www.jetbrains.com/webstorm/)**
- **[DataGrip](https://www.jetbrains.com/datagrip/)**
- **[Insomnia](https://insomnia.rest/)**
- **[OpenAPI](https://swagger.io/specification/)**
## :package: Instalação
### :heavy_check_mark: **Pré-requisitos**
The following software must be installed:
- **[Node.js](https://nodejs.org/en/)**
- **[Pnpm](https://pnpm.js.org/)** or **[Yarn](https://yarnpkg.com/)**
- **[Git](https://git-scm.com/)**
- **[PostgreSQL](https://www.postgresql.org/)** or **[Sqlite](https://www.sqlite.org/index.html)**
### :arrow_down: **Clonando o repositório**
```sh
$ git clone https://github.com/gabrielmaialva33/base-nest-api.git
# Enter directory
$ cd base-nest-api
```
### :arrow_forward: **Executando o aplicativo**
- :package: API
```sh
$ 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
```
## :memo: License
Este projeto está sob a licença **MIT**. [MIT](./LICENSE) ❤️
## :rocket: Contribuição
| [](https://github.com/gabrielmaialva33) |
|-----------------------------------------------------------------------------------------------------------|
| [Maia](https://github.com/gabrielmaialva33) |
Feito com ❤️ por Maia 👋🏽 [Entre em contato!](https://t.me/mrootx)
## :star:
Gostou? Deixe uma estrelinha para ajudar o projeto ⭐
© 2017-present Maia