https://github.com/gabrielmaialva33/base-acl-api
Base ACL is an access control list base api that hopes to serve many projects.
https://github.com/gabrielmaialva33/base-acl-api
acl acl-api acl2025 adonis-framework adonis6 adonisjs adonisjs-framework adonisjs6 api api-rest docker docker-compose lucid lucid-orm
Last synced: 30 days ago
JSON representation
Base ACL is an access control list base api that hopes to serve many projects.
- Host: GitHub
- URL: https://github.com/gabrielmaialva33/base-acl-api
- Owner: gabrielmaialva33
- License: mit
- Created: 2022-06-04T13:25:11.000Z (almost 3 years ago)
- Default Branch: master
- Last Pushed: 2025-04-16T01:08:01.000Z (about 1 month ago)
- Last Synced: 2025-04-23T00:04:00.099Z (30 days ago)
- Topics: acl, acl-api, acl2025, adonis-framework, adonis6, adonisjs, adonisjs-framework, adonisjs6, api, api-rest, docker, docker-compose, lucid, lucid-orm
- Language: TypeScript
- Homepage:
- Size: 1.62 MB
- Stars: 6
- Watchers: 1
- Forks: 0
- Open Issues: 10
-
Metadata Files:
- Readme: README-pt.md
- License: LICENSE
Awesome Lists containing this project
README
Sobre |
Tecnologias |
Ferramentas |
Instalação |
Licença
## :bookmark: Sobre
**Base ACL** é uma API base de lista de controle de acesso que espera atender a muitos projetos.
## :computer: Tecnologias
- **[Typescript](https://www.typescriptlang.org/)**
- **[Node.js](https://nodejs.org/)**
- **[AdonisJS](https://adonisjs.com/)**
- **[PostgreSQL](https://www.postgresql.org/)**
- **[Docker](https://www.docker.com/)**
## :wrench: Ferramentas
- **[WebStorm](https://www.jetbrains.com/webstorm/)**
- **[Insomnia](https://insomnia.rest/)**
- **[DataGrip](https://www.jetbrains.com/datagrip/)**
## :package: Instalação
### :heavy_check_mark: **Pré-requisitos**
Os seguintes softwares devem estar instalados:
- **[Node.js](https://nodejs.org/en/)**
- **[Git](https://git-scm.com/)**
- **[NPM](https://www.npmjs.com/)** or **[Yarn](https://yarnpkg.com/)**
- **[PostgreSQL](https://www.postgresql.org/download/)** or **[Docker](https://www.docker.com/get-started/)**
### :arrow_down: **Clonando o repositório**
```sh
$ git clone https://github.com/gabrielmaialva33/base-acl-api.git
```
### :arrow_forward: **Rodando o backend**
- :package: API
```sh
$ 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
```
## :twisted_rightwards_arrows: Rotas
Arquivo de rotas [Donwload](https://raw.githubusercontent.com/gabrielmaialva33/base-acl-api/master/.github/assets/insomnia/Insomnia.json.zip)
## :memo: Licença
O projeto está sobre a licença [MIT](./LICENSE) ❤️
Gostou? Deixe uma estrela para ajudar o projeto ⭐