https://github.com/rebecaborges/pokemon-api
API pokemon, para adicionar tecnologias legais!
https://github.com/rebecaborges/pokemon-api
circleci docker docker-compose editorconfig eslint express heroku joi-validation makefile pm2 postgresql sequelize
Last synced: 3 months ago
JSON representation
API pokemon, para adicionar tecnologias legais!
- Host: GitHub
- URL: https://github.com/rebecaborges/pokemon-api
- Owner: rebecaborges
- Created: 2020-06-08T02:03:15.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2020-06-08T02:13:55.000Z (about 6 years ago)
- Last Synced: 2025-04-06T01:43:48.300Z (about 1 year ago)
- Topics: circleci, docker, docker-compose, editorconfig, eslint, express, heroku, joi-validation, makefile, pm2, postgresql, sequelize
- Language: JavaScript
- Homepage: https://pokemon-api-1.herokuapp.com/
- Size: 86.9 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
## API pokémon
### Dotenv
Utilizamos para substituir dados sensíveis em uma API, exemplo a `key` de um usuário, inserimos ela no arquivo `.env` e ela é substituida pela váriavel ambiente.
Criando uma variável ambiente:
1. Crie um arquivo `.env` na raiz do projeto
2. Insira a variável ambiente dentro do arquivo `.env` seguindo esse modelo:
ex: `NODE_KEY=1234`
3. Substitua no código as informações sensíveis pela variável de ambiente:
```
{
key: process.env.NODE_KEY
}
```
O que ele faz?
Substitui no local que chamado `process.env.NODE_KEY` pelo valor da variável que está no arquivo `.env`
*OBS*: colocar o arquivo `.env` dentro do `.gitignore` antes de subir o projeto, por questões de segurança, já que você não quer expor dados sensíveis.
NODE_ENV: geralmente é usado para definir se a variável ambiente seguirá para production ou development
chamar a variavel antes, no inicio de todo arquivo, pra nao correr o risco de aparecer para o usuario e expor dados importantes (pra ser carregado antes)
#### Iniciando
```
require('dotenv/config')
console.log(process.env.NODE_KEY)
```
### Makefile
Criar um arquivo com o nome `Makefile`.
Deve ser colocado o tab e não espaços para que a execução ocorra corretamente.
Exemplo:
```
start:
npm start
```
### Docker
`FROM`: colocamos o nome da linguagem e a versão que queremos utilizar dela.
`WORKDIR`:
`COPY`:
`RUN`:
`COPY . . `:
`EXPOSE`:
`CMD`:
#### Docker Compose
### Lembretes
* Rodar migrations antes de subir o servidor incluir no `make` antes do npm start