matheusmurta/node-kanban

RESTful Simple API Kanban App with Express, PostgreSQL, Sequelize Node

Requeriments

This application required, Node.js and PostgreSQL.

Clone this repository

git clone https://github.com/matheusmurta/node-kanban.git

1 - Create postgres database with command or create using PgAdmin

createdb kanban

1.1 Please please set this configs according to your password and database user !

Ex: C:\Users\MatheusPC\Desktop\desafio\node-kanban\server\config\config.json

"development": {
    "username": "postgres",
    "password": "123456",
    "database": "kanban",
    "host": "127.0.0.1",
    "dialect": "postgres",
    "operatorsAliases": false
  }

2 - Run in project folder

npm install
sequelize db:migrate
npm start

3 - you can check there quickly if it works by going to http://localhost:3001/ and seeing this message

{"message":"Kanban App"}

4 - After run project locally you can check the Docs Api by Generate by Swagger Documentation

http://localhost:3001/docs/

5 Now Setup/Run the Front End App

https://github.com/matheusmurta/react-kanban

Notes :

Some features are not yet available, check issues yet

Mini Guia da api

Boards

GET http://127.0.0.1:3001/api/boards
Lista todos dos boards

Criar um novo Board
POST http://127.0.0.1:3000/api/boards
{
  "name": "Meu primeiro Board"
}

Listar detalhes de um Board 
GET http://127.0.0.1:3000/api/tasks/listbyboard/:boardId

Tasks

Lista todas as tarefas
GET http://127.0.0.1:3001/api/tasks/ 

Lista todas Por BoardID 
GET http://127.0.0.1:3001/api/tasks/listbyboard/{BoardID}

Inserir  
POST http://127.0.0.1:3000/api/boards/1/tasks
 {
  "name": "Protipagem",
  "description": "Prototipo de baixa fidelidade.",
  "project_stage": 1
 }

Deletar 
DELETE http://127.0.0.1:3000/api/tasks/{taskID}

Atualizar 
PUT http://127.0.0.1:3000/api/tasks/{taskID}
{
  "name": "Novo nome",
  "description": "Nova descricao.",
  "project_stage": 1
 }

i am aware of what needs to be improved check my remarks at issues

matheusmurta / node-kanban