todo-app

module
v0.0.0-...-c70ca53 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 24, 2024 License: MIT

README

todo-app

Pet-project REST API

Description

This project is a REST API for managing todo lists. It is written in Go and uses PostgreSQL and Docker. The project includes user authentication, creation, reading, updating, and deletion of todo lists and todo items.

Project Structure

Entity-relationship diagram

How to Run

Step 1

Сreate a .env file in the root of the project with the following content:

DB_PASSWORD=your_postgres_password

PGADMIN_DEFAULT_EMAIL=your_pgadmin_email
PGADMIN_DEFAULT_PASSWORD=your_pgadmin_password
Step 2

Create a configs/config.yml file with the following content:

port: "8000"
db:
  username: "postgres"
  host: "db"
  port: "5432"
  dbname: "todo-db"
  sslmode: "disable"
Step 3

Make sure you have Docker and Docker Compose installed. Then run the following command:

docker-compose up --build
Step 3

In order to check the database operation go to http://localhost:5050

Directories

Path Synopsis
Package docs Code generated by swaggo/swag.
Package docs Code generated by swaggo/swag.
internal

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL