Git Product home page Git Product logo

todo-api's Introduction

Simple TODO

This is a simple todo application using postgres as database

Architecture

Here I am using clean Architecture consists of 3 layers. Listing layers with implementation

  • entities ==> app/models
  • repository ==> app/data
  • usecases/api ==> app/api

project structure references: https://github.com/golang-standards/project-layout

Setting up

Run following command will runs both database and app

docker-compose up

Postman collection can be found in docs directory

Local setup

Unit test

go test ./...

Run App

export DB_HOST=localhost
go run main.go

Documentation

DB

Tables

  • users (id(pk), name, email)
  • todolist (id(pk), name, user_id(fk))
  • todo (id(pk), content, status, todo_list_id(fk))

API

  • GET - /app/user/{id} ==> to get-user
  • POST - /app/user ==> new user
  • GET - /app/todolist/{user_id} ==> todo lists under a user
  • POST - /app/todolist/{user_id} ==> new todo list for a user
  • PUT - /app/todolist/{id} ==> update todolist
  • DELETE - /app/todolist/{id} ==> delete todo list
  • GET - /app/todo/{todo_list_id} ==> get todos under a todo list with filer option
  • POST - /app/todo/{todo_list_id} ==> new todo on a todo list
  • PUT - /app/todo/{id} ==> update todo with/without status
  • DELETE -/app/todo/{id} ==> delete todo

todo-api's People

Contributors

tshihad 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.