Simple Blog API

Projeto
Tecnologias
Estrutura
Pré-Requisitos
Configurações

💻 Projeto

O projeto construído é uma API REST para um Blog simples, onde podemos ver todas as publicações, criar novas, editar e excluí-las, desta forma teremos um CRUD (Create, Read, Update, Delete) completo.

Novas técnologias e funcionalidade:

04/01/24 - Separação do Front End do Back End, e inicio do desenvolvimento da API;
02/12/23 - Introdução do JSDoc, uma API geradora de documentações para JavaScript;
01/12/23 - Introdução do Padrão de Projetos MVC (Model, View, Controller), onde podemos dividir e visualizar melhor as responsabilidades dentro do Back-End;
31/10/23 - Introdução do arquivo .env, um gerenciador de informações sensíveis para desenvolvedores.

🚀 Tecnologias

Esse projeto foi desenvolvido com as seguintes tecnologias:

🗃 Estrutura do Projeto

- backend
  - controllers
    - post.controller.js
  - data
    -database.js
  - models
    - post.model.js
  - routes
    - blog.js
  - data
    - database.js
- .gitignore
- .env.example
- app.js
- jsdoc.json
- package-lock.json
- package.json
- README.md

👀 Pre-requisitos

Antes de começar, você precisará ter as seguintes ferramentas instaladas em seu computador:
Git para clonar esse repositório;
Um editor de código como o VSCode;
Um Runtime, como o NodeJs, para que seu código seja executado.

👨‍💻 Iniciando o projeto

# Clone este repositório em sua pasta atual.
$ git clone <https://github.com/Arthur-Ferreira/SimpleBlog_API> .

# Ou clone este repositório em uma nova pasta.
$ git clone <https://github.com/Arthur-Ferreira/SimpleBlog_API>

# Acesse a pasta do projeto no terminal/cmd
$ cd "SimpleBlog_API"

# Instale as dependências do projeto
$ npm install

# Para iniciar o projeto
$ npm start

Made with 🖤 by ARTHUR FERREIRA