An open API service indexing awesome lists of open source software.

https://github.com/gabrielmaialva33/base-rbac-api

Base RBAC is a role-based access control base api that hopes to serve many projects.
https://github.com/gabrielmaialva33/base-rbac-api

adonis5 adonisjs api api-rest docker docker-compose dockerfile insomnia lucid lucid-orm mit-license postgres postgresql rbac rbac-authorization rbac-management rbac-roles webstorm

Last synced: 4 months ago
JSON representation

Base RBAC is a role-based access control base api that hopes to serve many projects.

Awesome Lists containing this project

README

          


RBAC


License
GitHub top language
GitHub language count
Repository size
Wakatime

GitHub last commit
Maia



English
·
Portuguese


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


## :bookmark: Sobre

**Base RBAC** é uma API base de controle de acesso baseada em função que espera atender a muitos projetos.


schema


## :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/)**
- **[Edge Microsoft](https://www.microsoft.com/pt-br/edge/)**
- **[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-rbac-api.git
```


### :arrow_forward: **Rodando o backend**

- :package: API

```sh
$ cd base-rbac-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-rbac-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 ⭐