SaúdeiD Blog API

API de Blogs com tabela de posts, autores e categorias. Projeto realizado utilizando TDD com Node.js e MongoDB.
Explore a documentação no postman

Reportar Bug · Solicitar uma Feature

Sumário

1. Sobre
   • Feito com
2. Inicializando
   • Pré-requisitos
   • Instalando
3. Roadmap
4. Contribuindo

Feito com

• Jest
• Node.js
• Express.js
• MongoDB
• Amor 💜

(voltar ao topo)

Inicializando

Pré-requisitos

Certifique-se de que possui o Node e o npm instalado:

sudo apt install nodejs

sudo apt install npm

Certifique-se de que possui o Mongod instalado e rodando:

sudo apt systemctl start mongod

Instalando

1. Clone o repositório e entre na pasta

git clone git@github.com:brenno-calado/teste-saudeid-backend.git
cd saudeid-blog-api

3. Instale as dependências com npm

npm install

4. Adicione um arquivo .env na pasta principal do projeto com as variáveis:

• HOST: página onde está localizado o servidor. Ex.: http://localhost:
• PORT: Porta do servidor. Ex.: 3000
• MONGO_PORT: Porta onde o MongoDB está rodando. Usualmente ela se localiza na porta 27017
• MONGO_HOST: URL do seu banco de dados. Ex.: mongodb://localhost:
• DB_NAME: com o nome que o banco terá. Ex.: SaudeidBlog
• NODE_ENV: Decide se o Node inicializará em modo de teste, desenvolvimento, produção ou homologação, por exemplo.

(voltar ao topo)

Roadmap

• POST /post
• GET /post
• GET /post/:id
• PUT /post/:id
• DELETE /post/:id
• [] 100% Coverage test
• Postman Documentation
• [] Postman Server Mock

Veja as issues abertas Para uma lista completa das features a serem implementadas e bugs detectados.

(voltar ao topo)

Contribuindo

Sinta-se à vontade para aprimorar esta API. A comunidade open-source é feita para aprender, inspirar os demais e criar soluções!

Se você tem alguma sugestão para aprimorar, refatorar ou consertar um bug, siga os passos a seguir:

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Crie uma nova branch de nome descritivo

  git checkout -b feat-multer-upload

2. Certifique-se de que o código passa no eslint

  npm run lint

3. Realize commits, de preferência commits que englobem uma alteração completa

  git commit -am "add multer upload controller"

4. Suba as alterações para o repositório

  git push origin feat-multer-upload

5. Abra um Pull Request
6. Adicione uma tag que descreva a sua contribuição, como "bug fix" ou "enhancement"

(voltar ao topo)