todoapp

This is a simple todoapp built with Go.

How to Run it?

Clone the repo in your local environment:

git clone https://github.com/flakrimjusufi/todoapp.git

Remove ".example" from both .env.example and /seeds/init.sql.example and populate them with your environment variables.

In case you have docker-compose installed in your machine, just execute the following:

docker-compose up

Docker-compose will build all the dependencies and will add a PostgreSQL image in your container alongside with the server so that we can interact with data.

NOTE: You should configure your environment variables in sync with docker-compose.yml file

Once docker-compose is finished, you should see an output in terminal:

Starting server in http://localhost:8088

Open your browser in http://localhost:8088 or Send a GET request using cURL or Postman/Insomnia:

curl -X GET -k http://localhost:8088/getSampleTodoList

...and you should receive a response from the server with a ToDoList.

To verify that everything is working smoothly, run the test cases:

Make sure to remove ".example" from .env.example in /tests directory and populate it with you environment variables, same as you did in the step above.

Once you have set up your environment variables, execute the following command in another terminal:

docker-compose exec server go test ./tests

You should see all tests passing successfully!

In case you don't have docker installed, you need to do the following:

1. Install go:

[https://golang.org/], any one of the three latest major releases of Go.
For installation instructions, see Go's getting started guide: https://golang.org/doc/install

2. Install PostgreSQL (or any SQL database)

[Version 9+]
For installation instructions, please refer to this link: https://www.postgresql.org/download/

3. Remove ".example" from both .env.example and /seeds/init.sql-example and populate them with your environment variables.

4. Execute the script for creating the database in /seeds/init.sql

5. Run the test cases from the root of the project to verify that everything is working okay:

Make sure to remove ".example" from .env.example in /tests directory and populate it with you environment variables, same as you did in the step above.

Once you have set up your environment variables, execute the following command:

go test ./tests

6. Run the server:

go run main.go

You should recieve a response:
Starting server in http://localhost:8088

7. Send a GET request using cURL or Postman/Insomnia:

curl -X GET -k http://localhost:8088/getSampleTodoList

You should have a response from server: 

[
  {
    "id": 1,
    "labels": "Clean dishes",
    "comments": "Don't forget the garbage too..",
    "due_date": "2021-10-28T07:40:00Z"
  },
  {
    "id": 2,
    "labels": "Send kids to school",
    "comments": "Don't forget the Umbrella..",
    "due_date": "2021-10-28T08:10:00Z"
  },
  {
    "id": 3,
    "labels": "Go to work",
    "comments": "Do some small-talks with colleagues before starting the work..",
    "due_date": "2021-10-28T08:30:00Z"
  }
]

Interacting with API

Once the server is up and running, you can hit the endpoints listed in this table to interact with data:

HTTP call	Endpoint	Description
GET	http://localhost:8088/getSampleTodoList	Will list a sample of ToDoList
POST	http://localhost:8088/toDoList	Will create a ToDoList in database
GET	http://localhost:8088/toDoList	Will list all toDos created in database
PUT	http://localhost:8088/toDoList/1	Will update a toDo in database and send back the response
DELETE	http://localhost:8088/toDoList/1	Will delete a toDo by Id in database and send a successful message back
GET	http://localhost:8088/	Will render a UI in browser with some sample ToDoList
GET	http://localhost:8088/viewToDoList	Will render a UI in browser with ToDos created in database

Examples of interacting with API:

     curl -X GET -k http://localhost:8088/getSampleTodoList  

     curl -X GET -k http://localhost:8088/toDoList  

     curl -X GET -k http://localhost:8088/toDoList/1 

     curl -X POST -k http://localhost:8088/toDoList -d   
	'{
 	 "labels":"Push the code to your repo",
 	 "comments":"You still need to do some updates in readme file",
 	 "due_date":"2021-10-31T07:40:00Z"
 	}'

     curl -X PUT -k http://localhost:8088/toDoList/1  -d   
	'{
	 "labels":"Follow the course of Proxies",
	 "comments":"Today you should focus more on nginx.",
	 "due_date":"2021-10-30T17:40:00Z"
	}'

     curl -X DELETE -k http://localhost:8088/toDoList/1

You can see all the changes reflected under http://localhost:8088/viewToDoList

todoapp User-interface:

Watch a Demo Video

The app is now live

Check it out: http://todo.flakrimjusufi.com/