Giter VIP home page Giter VIP logo

todolist-back-js's Introduction

todolist_back

Aplicação back-end para uma aplicação de TODO list, utilizando NodeJS. Nesta aplicação, são gerenciadas as informações das tarefas a serem feitas, permitindo a criação, leitura, atualização e exclusão dos registros.

Projeto

Para esse projeto, foi decidido implementar dois modelos de banco de dados: um relacional, utilizando o MySQL e um orientado a documentos, utilizando o MongoDB.

Dados

Cada tarefa possui os seguintes campos: title, status e created_at.

Endpoints

Essa aplicação expões uma API RESTful, com os seguintes end-points:

Endpoint Método Descrição
tasks GET Retorna um array com todos as tarefas
tasks POST Cria um nova tarefa
tasks/(:num) PUT Atualiza tarefa cujo id é (:num)
tasks/(:num) DELETE Deleta tarefa cujo id é (:num)

Banco de Dados

Para rodar esta aplicação, você precisará de um servidor de banco de dados instalado e rodando em sua máquina, utilizando o MySQL ou o MongoDB. Para configurar qual banco deseja usar, mude qual model é carregado no arquivo tasksController.js. Com a ferramenta de sua preferência, crie um banco de dados novo para esta aplicação. As configurações do banco de dados para esta aplicação são encontradas no arquivo .env, na pasta raíz do repositório. Neste arquivo você poderá modificar o nome, usuário e senha para as informações do banco de dados que você criou.

Instalação

  1. Instale um servidor de banco de dados MySQL ou MongoDB em sua máquina, inicie ele e crie um novo banco de dados. Garanta que exista um usuário para esse servidor em que o usuário da sua máquina consiga fazer login.

  2. Se o banco de dados escolhido foi o MySQL, crie uma tabela chamada "tasks" com os campos necessários, mostrados em Dados. Se o banco de dados escolhido foi o MongoDB, crie uma coleção vazia com o nome "tasks".

  3. Clone este repositório e, na pasta raiz, execute o seguinte comando para instalar as dependências necessárias do projeto:

    > npm install
    
  4. Faça uma cópia do arquivo env para .env e modifique o .env com as configurações do banco de dados que você criou, como mostrado em Banco de Dados.

  5. Após instalado e configurado, basta você dar o seguinte comando para subir o servidor:

    > npm start
    

Melhorias

O sistema está realizando todas as operações propostas, porém existem algumas melhorias a serem implementadas.

  • Adicionar autenticação
    • Atualmente qualquer usuário pode efetuar as chamadas na API, sem qualquer autenticação.
  • Facilitar a troca do BD
    • Colocar a escolha do BD pelo .env.

todolist-back-js's People

Contributors

jmflach avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.