README.md

English · Portuguese

About   |    Technologies   |    Tools   |    Installation   |    License

🔖 About

Base ACL is an access control list base api that hopes to serve many projects.

💻 Technologies

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

🔧 Tools

• WebStorm
• Insomnia
• DataGrip

📦 Installation

✔️ Prerequisites

The following software must be installed:

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

⬇️ Cloning the repository

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

▶️ Running the application

• 📦 API

  $ cd base-acl-api
  # Dependencies install.
  $ yarn # or npm install
  # Config environment system
  $ cp .env.example .env
  # Data base creation.
  $ node ace migration:run # or docker-compose up --build
  # API start
  $ node ace serve --watch # or yarn dev or npm dev

🔀 Routes

Get routes for insomnia Donwload

📝 License

This project is under the MIT license. MIT ❤️

Liked? Leave a little star to help the project ⭐