/the-word

Blog com serviços de registro e autenticação de usuário, assim como de criação, leitura, atualização e remoção de posts

Primary LanguageJavaScript

The Word Project

A aplicação se trata de um website de blog que provê ao usuário autenticado o serviço de criação, leitura, atualização e remoção (CRUD) de posts, assim como busca-los por termo ou autor.

O projeto teve como objetivo consolidar conhecimentos sobre Node.js, Express, Sequelize, sendo estruturada sob os princípios REST e arquitetura MSC (Model, Service, Controller).

Inicialmente o projeto se iniciou a partir de uma API de blogs feita por mim como tarefa de aprendizado do curso da Trybe. Após finalizada, comecei a desenvolver o front-end em pararelo a implementações e reajustes feitos na API conforme a necessidade.

⚠️ MySQL deve estar instalado para o funcionamento da API.

⚠️ Usa localStorage do browser para autenticação de usuário.

DEMO

the-word-frontend-production.up.railway.app

Quick start
  1. Clone o repositório e mude para a pasta back-end e instale as dependências:
git clone git@github.com:pennaor/the-word.git
cd ./the-word/back-end
npm install

  1. Crie um arquivo .env com as variáveis da ambiente exemplificadas no arquivo .env.example presente na raíz do diretório /back-end.

  2. Execute npm run prestart para criar o banco de dados e tabelas.

  3. Execute npx sequelize-cli db:seed:all para popular o banco de dados.

  4. Inicie a API com npm start.

  5. Mude para o diretório do front-end e instale as dependências:

cd ../front-end
npm install

  1. Crie um arquivo .env com as variáveis da ambiente exemplificadas no arquivo .env.example presente na raíz do diretório /front-end.

  2. Inicie o front-end com npm start.

Features
  • Buscar, cadastrar, autenticar e autorizar usuários.
  • Buscar, cadastrar, atualizar e remover posts.
Tools
Trybe
  • São de total autoria da Trybe:
    • Proposta da API
    • Regras de Lint
    • npm scripts