todolist

README

todolist

---

This code repo contains the code developed for a Go rest API consisting of a simple ToDoList service.

Table of Contents

1. General Info
2. Technologies
3. Requirements
4. Installation
5. Authentication
6. Testing
7. API docs

General Info

---

At this time, you have a RESTful API server running at http://127.0.0.1:8000. It provides the following endpoints:

• GET /tasks: get the list of all tasks
• POST /tasks: add a new task
• PUT /tasks/:id: mark a task as completed
• DELETE /tasks/:id: deletes a task

The API achieves data persistence using a PostgreSQL implemented database with the SQL-boiler ORM. This database is initialized with a single "tasks" table through the .sql file. This table contains the columns of 'id', 'name' and 'check_valid'.

Golang templates have been used for the implementation of the web interface.

The api has been dockerized using a docker-compose of two containers: one for the app and one for the postgres database. The environment variables necessary to establish the connection with the database are defined in the docker-compose. The database can be managed using the "pgAdmin" software.

Technologies

---

A list of technologies used within the project:

• Go: Version 1.18.3
• Docker
• rs/cors
• gorilla/mux
• stretchr/testify
• gavv/httpexpect
• volatiletech/sqlboiler
• PostgreSQL
• Swagger
• go-openapi/runtime

Requirements

---

For the project to launch, you will need Docker installed, and preferably the Make tool too.

Installation

---

To install this project you need to clone or download it.

$ git clone https://github.com/jorgefg4/todolist.git

Then you have two options.

• Not having Make:

  Enter the root folder and then execute:

  $ docker-compose build
  $ docker-compose up
  

  To stop the app, execute docker-compose down.

• Having Make:

  Enter the root folder, then execute make. To stop the app, execute make stop.

Authentication

---

There are no authentication implemented yet. So, all the end-points are open.

Core Resources

---

Task object represents snapshot of a specific task with a unique Id.

API docs

---

This specification follows the Swagger specification. It is written in YAML and deployed automatically using ReDoc. You can access the API documentation in the path localhost:8000/api-doc

Testing

---

For the execution of the API tests, it will be possible to execute make test to execute all the tests after launching the app with make run.