Git Product home page Git Product logo

todo-api's Introduction

Todo-API

This code is to be done at home. Design and implement a deployable RESTful API backend that store the resource for a simple 'to do' task list.

API Document

Example API Document

Postman Collection

How do I get set up?

  • Install Java 1.8+
  • Install Maven 3.x.x
  • Create system variable JAVA_HOME with the path of your java installation
  • Create system variable MAVEN_HOME with the path of your maven installation
  • Add JAVA_HOME/bin and MAVEN_HOME/bin to PATH system variable

How to install Maven on Windows

To build use this command

cd todo-api
mvn clean install

To run use this command

cd todo-api
java -jar target/todo-api-0.0.1-SNAPSHOT.jar

To build and run with docker

  1. Build docker image with maven
cd todo-api
mvn package docker:build
  1. List of docker images
docker images
  1. Run your docker image
docker run -p 8080:8080 -t kupring/todo-api

To check health status use this command

curl -X GET 'http://localhost:8080/health'

------HTTP 1.1 200 OK------
{
  "status": "UP"
}

Note

When app started data will reset.

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.