Skip to content

This project builds todo apis using Vert.x with the following specifications of Todo-backend.

Notifications You must be signed in to change notification settings

VIthulan/todo-vertx

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

16 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Todo-vertx

This project builds todo apis using Vert.x with the following specifications of Todo-backend.

Project is merged in Todo-backend Site!! Please checkout Todo-vertx from Vithulan.

Installation

  1. First install Mongo db
  2. Start Mongo db service
  3. Make sure Mongodb service is running in port 27017
  4. Clone the project : master branch
  5. Run mvn clean package
  6. Direct your terminal to /todo-vertx/target
  7. Run java -jar todo.vertx-1.0-SNAPSHOT-fat.jar

Now your server will be started in http://localhost:8080

##Deploying the application in Heroku

  1. Clone the heroku-app branch
  2. Open the terminal
  3. heroku create (Assumption : Heroku environment is alreay been set)
  4. git push heroku master

Project is live!

Please check out https://todo-vertx.herokuapp.com/api/tasks

##Calling APIs

  1. Open a Rest client in your browser
  2. Send a POST request to http://localhost:8080/api/tasks with the following JSON context
{
"task":"Doing GSoC 2016",
"completed":"true"
}
  1. View the sent request in http://localhost:8080/api/tasks in your browser.
  2. Like vice you can Add tasks, Delete tasks, Modify Tasks and View tasks.

##Available APIS

  • GET http://localhost:8080/api/tasks : Get all the Tasks stored in DB
  • POST http://localhost:8080/api/tasks : Add a new task
  • PUT http://localhost:8080/api/tasks/:id : Update a task whether it is done or not
  • DELETE http://localhost:8080/api/tasks/:id : Delete a task

##Simple Architecture of todo-vertx

##Database schema

##Contact The best way for potential contributors to contact is posting a message in my issue tracker

Feel free to contribute for any bugs or for improvemet of a new feature

-Vithulan MV

About

This project builds todo apis using Vert.x with the following specifications of Todo-backend.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages