Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/arthur-ferreira/simpleblog_api
https://github.com/arthur-ferreira/simpleblog_api
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/arthur-ferreira/simpleblog_api
- Owner: Arthur-Ferreira
- Created: 2024-01-04T23:39:10.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-01-15T19:36:32.000Z (12 months ago)
- Last Synced: 2024-01-16T01:11:49.747Z (12 months ago)
- Language: JavaScript
- Size: 111 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Simple Blog API
💻 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:
- [Node.js](https://nodejs.org/en/)
- [Express](https://expressjs.com/pt-br/)
- [MySQL](https://www.mysql.com/)
- [.ENV](https://www.dotenv.org/)
- [JSDoc](https://jsdoc.app/)
🗃 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](https://git-scm.com) para clonar esse repositório;
Um editor de código como o [VSCode](https://code.visualstudio.com/);
Um Runtime, como o [NodeJs](https://nodejs.org/en), para que seu código seja executado.
👨💻 Iniciando o projeto
```
# Clone este repositório em sua pasta atual.
$ git clone .
# Ou clone este repositório em uma nova pasta.
$ git clone
# 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