Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/letsmakecakes/todo-app

The To-Do application is a web-based task management tool built with Golang, HTML, CSS, and JavaScript. Featuring user authentication, task creation, updating, deletion, and filtering, it uses the Fiber framework and PostgreSQL database
https://github.com/letsmakecakes/todo-app

css golang html javacript pos

Last synced: 1 day ago
JSON representation

Host: GitHub
URL: https://github.com/letsmakecakes/todo-app
Owner: letsmakecakes
Created: 2024-07-08T12:53:41.000Z (4 months ago)
Default Branch: master
Last Pushed: 2024-07-17T16:07:33.000Z (4 months ago)
Last Synced: 2024-09-11T03:58:09.128Z (2 months ago)
Topics: css, golang, html, javacript, pos
Language: HTML
Homepage:
Size: 74.2 KB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

# To-Do Application

This is a To-Do application built using Golang, HTML, CSS, and JavaScript. The backend is powered by the Fiber framework and a PostgreSQL database.

## Features

- User authentication (sign-up and log-in)
- Task creation, updating, deletion
- Task status updates
- Task filtering by status
- Retrieve details of individual tasks

### System Design Diagram

![System Design](img.png)

## API Endpoints

### User Authentication

#### Sign-up

- **Endpoint:** `POST /signup`
- **Description:** Register a new user.
- **Request Body:**
```json
{
"username": "string",
"password": "string"
}
```
- **Response:**
```json
{
"message": "User created successfully."
}
```

#### Log-in

- **Endpoint:** `POST /login`
- **Description:** Authenticate a user and return a token.
- **Request Body:**
```json
{
"username": "string",
"password": "string"
}
```
- **Response:**
```json
{
"token": "jwt_token"
}
```

### User Management

#### Get User Details

- **Endpoint:** `GET /users/{userId}`
- **Description:** Retrieve user details by user ID.
- **Request Headers:**
```
Authorization: Bearer jwt_token
```
- **Response:**
```json
{
"userId": "integer",
"username": "string"
}
```

### Task Management

#### Create Task

- **Endpoint:** `POST /tasks`
- **Description:** Create a new task.
- **Request Headers:**
```
Authorization: Bearer jwt_token
```
- **Request Body:**
```json
{
"title": "string",
"description": "string",
"status": "string" // e.g., "pending", "completed"
}
```
- **Response:**
```json
{
"taskId": "integer",
"message": "Task created successfully."
}
```

#### Update Task

- **Endpoint:** `PUT /tasks/{taskId}`
- **Description:** Update an existing task.
- **Request Headers:**
```
Authorization: Bearer jwt_token
```
- **Request Body:**
```json
{
"title": "string",
"description": "string",
"status": "string" // e.g., "pending", "completed"
}
```
- **Response:**
```json
{
"message": "Task updated successfully."
}
```

#### Delete Task

- **Endpoint:** `DELETE /tasks/{taskId}`
- **Description:** Delete a task by task ID.
- **Request Headers:**
```
Authorization: Bearer jwt_token
```
- **Response:**
```json
{
"message": "Task deleted successfully."
}
```

#### Get Task List

- **Endpoint:** `GET /tasks`
- **Description:** Retrieve a list of tasks with optional filters.
- **Request Headers:**
```
Authorization: Bearer jwt_token
```
- **Request Parameters:**
- `status` (optional): Filter tasks by status (e.g., `pending`, `completed`).
- **Response:**
```json
{
"tasks": [
{
"taskId": "integer",
"title": "string",
"description": "string",
"status": "string",
"createdAt": "datetime",
"updatedAt": "datetime"
},
...
]
}
```

#### Get Task Details

- **Endpoint:** `GET /tasks/{taskId}`
- **Description:** Retrieve details of a specific task by task ID.
- **Request Headers:**
```
Authorization: Bearer jwt_token
```
- **Response:**
```json
{
"taskId": "integer",
"title": "string",
"description": "string",
"status": "string",
"createdAt": "datetime",
"updatedAt": "datetime"
}
```

## Getting Started

### Prerequisites

- Go 1.16 or later
- PostgreSQL
- Fiber framework
- HTML, CSS, JavaScript

### Installation

1. Clone the repository:
```sh
git clone https://github.com/yourusername/todo-app.git
cd todo-app
```

2. Install dependencies:
```sh
go get -u github.com/gofiber/fiber/v2
go get -u github.com/gofiber/template/html/v2
go get -u github.com/lib/pq
```

3. Set up the PostgreSQL database and update the connection string in the code:
```sh
postgresql://:@

/?sslmode=disable
```

4. Run the application:
```sh
go run server.go
```

### Usage

Access the application at [http://localhost:3000](http://localhost:3000).