README-pt.md

English · Portuguese

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

🔖 Sobre

Base ACL é uma API base de lista de controle de acesso que espera atender a muitos projetos.

💻 Tecnologias

• Typescript
• Node.js
• AdonisJS
• PostgreSQL
• Docker

🔧 Ferramentas

• WebStorm
• Insomnia
• DataGrip

📦 Instalação

✔️ Pré-requisitos

Os seguintes softwares devem estar instalados:

• Node.js
• Git
• NPM or Yarn
• PostgreSQL or Docker

⬇️ Clonando o repositório

  $ git clone https://github.com/gabrielmaialva33/base-acl-api.git

▶️ Rodando o backend

• 📦 API

  $ cd base-acl-api
  # Instalação de dependências.
  $ yarn # ou npm install
  # Configuração ambiente de sistema
  $ cp .env.example .env
  # Criação de banco de dados.
  $ node ace migration:run # ou docker-compose up --build
  # Iniciar API
  $ node ace serve --watch # ou yarn start ou npm dev

🔀 Rotas

Arquivo de rotas Donwload

📝 Licença

O projeto está sobre a licença MIT ❤️

Gostou? Deixe uma estrela para ajudar o projeto ⭐