https://github.com/beekeeper-studio/beekeeper-studio
# Instalar dependências de desenvolvimento
yarn
Todas as etapas para criar o backend estão reunidas em um único comando:
# Instalar dependências de desenvolvimento
make docker-install
O comando acima é um atalho para realizar as seguintes tarefas:
# Command 1: Copy .env.example to .env
cp .env.example .env
# Command 2: Build Docker containers
make docker-build
# Command 3: Run database migrations in Docker
make migration-docker
# Command 4: Reset Database and run seeds
make reset-docker
# Command 5: Install project dependencies with Yarn
yarn
# Command 6: Generate Swagger documentation
make generate-docs
Abra o Docker Dashboard para verificar se todos os containers foram criados.
Chegou a hora de conectar o banco de dados. Abra o Beekeeper Studio e crie uma nova conexão.
- Selecione Postgres
- Mantenha Host (localhost) e Port padrão (5432)
- Credenciais
Campo Valor User nubble Password nubble Default Database nubble_db_development - Dê um nove para a conexão. Ex "Nubble" e pressione "Save".
-
Acesse o Minio ma porta http://localhost:8900
- username:
nubble
- password:
nubble-pass
- username:
-
Clique em Create a Bucket, em Bucket Name informe: nubble
-
Após criar o Bucket altere o Access Policy para Public
-
Em Access Keys clique em Create Access Key
-
Copie suas chaves para o arquivo .env
S3_KEY='Access Key
S3_SECRET='Secret Key
-
ative o túnel HTTPS com o ngrok usando o seu Static domain
ngrok http --domain=hugely-usable-swan.ngrok-free.app http://localhost:9000
-
Substitua no arquivo
.env
o valor daS3_CDN_URL
dehttp://localhost:9000
pela sua nova URL. Por exemplo:https://hugely-usable-swan.ngrok-free.app
-
rode o comando
make docker-rebuild
para subir a atualização do S3
Importar Endpoits da API para o Insomnia
Pronto! A Nubble API está pronta para ser utilizada! 🥳
Aplicações | URL | User | Password |
---|---|---|---|
App - NodeJs | http://localhost:3333 | - | - |
Documentação - Swagger | http://localhost:3333/docs | - | - |
Postgres - pgAdmin | http://localhost:8030 | admin@admin.com | admin |
E-mail - Mailpit | http://localhost:8040 | - | - |
Minio - S3 | http://localhost:8900 | nubble | nubble-pass |