Git Product home page Git Product logo

todo-app's Introduction

To-Do App

Yet another To-Do application.

Tech Stack

  • .Net Core
  • Postgresql
  • Docker

CI-CD

CI


Github Actions configuration is triggered when changes pushed to main branch. There are 3 Github secrets for this pipeline to deploy successfully to a remote server.

  • HOST
    • Host server IP address.
  • USER
    • Server user name.
  • PASSWORD
    • Server password.

Docker and Docker Compose should be installed on the server before the pipeline works.

Running the application

This app can be run as a docker container. Open a terminal in the directory which holds the docker-compose.yml file and run the following command.

docker-compose -f docker-compose.yml up -d --build

API Endpoints

For OpenAPI(swagger) support visit localhost:5000/swagger

Get All Tasks

  • URL
/api/todo
  • METHOD
GET
  • SUCCESS RESPONSE
    • Code: 200
    • Content =>
    [{"id": 1, "task": "Do dishes", "completed": false,  "createdAt": "2021-12-18T..."}] 

Get Task By Id

  • URL
/api/todo/{id}
  • METHOD
GET
  • SUCCESS RESPONSE

    • Code: 200
    • Content
    {"id": 1, "task": "Do dishes", "completed": false} 
  • ERROR RESPONSE

    • Code: 404 NOT FOUND
    • Content =>
     {"StatusCode": 404, "Message": "No task found with the given id. (Parameter toDoItem')" 

Create Task

  • URL
/api/todo
  • METHOD
POST
  • REQUEST BODY
{
  "id": 1,
  "createdAt": "2021-12-20T09:21:18.573Z",
  "taskContent": "Do the dishes",
  "isCompleted": true
}

todo-app's People

Contributors

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