ToDo App

This is a todo app, which is a web-based user interface, where users may interact with their tasks and manage their todo list. The frontend is designed with Vue.js and interfaces with the backend API designed in Go.

Table of Contents

1. App Features
2. Used Technologies
3. Installation
4. Manual
5. API Documentation
6. Testing

App Features

1. Add new todos to help users organize their tasks using the add button.
2. Mark the completed todos as done using a checkbox.
3. Delete unwanted todos using the delete button.
4. Rename a todo by double-clicking it and then typing the new name.

Used Technologies

Backend

• Golang: A quick and efficient backend programming language.
• Gin: A Go-based lightweight web framework used to develop the API.
• Swagger: An API documentation and testing tool.

Frontend

• Vue.js: A modern framework for creating user interfaces in JavaScript or Typescript. In this app, Typescript is used.
• Cypress: An end-to-end testing framework for web applications.

Installation

Before starting, ensure that the necessary tools are installed:

• Go
• Node.js
• Docker
• Docker Compose
• Cypress

Manual

• Clone the repository:

$ git clone https://github.com/codescalersinternships/ToDoApp-Rodina.git

• Go to the repository directory:

$ cd ToDoApp-Rodina

• Backend Setup:

$ cd backend

$ go mod download

$ go run main.go

• Frontend Setup:

$ cd frontend

$ npm install

$ npm run serve

How to run with docker?

Run the app using docker as follows:

$ docker-compose up -d

How to access the app?

• Open your web browser and go to http://localhost:8080 to access the app.

API Documentation

After starting the backend server, navigate to http://localhost:8096/swagger/index.html to view the API documentation and test the backend API using Swagger.

Testing

After installing all dependencies, you can test either the frontend or the backend as follows:

Backend

$ cd backend
$ go mod download
$ go test ./...

Frontend

$ cd frontend
$ npm install
$ npm run test