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.
the-word-frontend-production.up.railway.app
Quick start
- 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
-
Crie um arquivo .env com as variáveis da ambiente exemplificadas no arquivo
.env.example
presente na raíz do diretório/back-end
. -
Execute
npm run prestart
para criar o banco de dados e tabelas. -
Execute
npx sequelize-cli db:seed:all
para popular o banco de dados. -
Inicie a API com
npm start
. -
Mude para o diretório do front-end e instale as dependências:
cd ../front-end
npm install
-
Crie um arquivo .env com as variáveis da ambiente exemplificadas no arquivo
.env.example
presente na raíz do diretório/front-end
. -
Inicie o front-end com
npm start
.
Features
- Buscar, cadastrar, autenticar e autorizar usuários.
- Buscar, cadastrar, atualizar e remover posts.
Tools
- Front-end:
- Back-end:
- Linters:
Trybe
- São de total autoria da Trybe:
- Proposta da API
- Regras de Lint
- npm scripts