https://github.com/ushiradineth/cron-be

Backend for Cron calendar management app
https://github.com/ushiradineth/cron-be

github-actions go go-tdd golang psql sqlx tdd testcontainers

Last synced: 4 days ago
JSON representation

Backend for Cron calendar management app

• Host: GitHub
• URL: https://github.com/ushiradineth/cron-be
• Owner: ushiradineth
• Created: 2024-02-11T02:57:50.000Z (11 months ago)
• Default Branch: main
• Last Pushed: 2025-01-04T21:40:02.000Z (7 days ago)
• Last Synced: 2025-01-04T22:24:51.113Z (7 days ago)
• Topics: github-actions, go, go-tdd, golang, psql, sqlx, tdd, testcontainers
• Language: Go
• Homepage: https://github.com/ushiradineth/cron
• Size: 205 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Go backend for Cron

- Check [frontend repository](https://github.com/ushiradineth/cron) for details about the project.

## Running the Project Locally

### Clone the repository

- `git clone https://github.com/ushiradineth/cron-be`

### Install binaries

#### Install Go Migrate

- `go install -tags 'postgres' github.com/golang-migrate/migrate/v4/cmd/migrate@latest`

#### Install Go Swag (optional)

- `go install github.com/swaggo/swag/cmd/swag@latest`

#### Install Go Watch (optional)

- `go install github.com/mitranim/gow@latest`

### Environment variables

- Check the `.env.example` file for the required environment variables.

- Use `cp .env.example .env` to create the `.env` file.

### Start the Postgres Database

- Run `docker compose -f deployments/docker-compose.yml --env-file .env up -d` to start the Postgres Database and Adminer.

- Wait for a moment for the database to initialize.

### Connect to the database

- You can use Adminer, a web-based administration tool included in the setup, to manage your database. Access Adminer at [localhost:9090](http://localhost:9090).

- In Adminer, use the following credentials:

  - Server: postgres:5432

  - Username: cron

  - Password: password

  - Database: cron

### Run Database Migrations

- Run `make db_up` to run the latest Database Migration.

### Run the Seeder

- Note: Make sure the database is the development database

- `go run cmd/seeder/main.go` or `make db_seed`

### Run the Go Server

- `go run cmd/api/main.go` or `make run`

- `gow run cmd/api/main.go` or `make run_watch`

## Build the Cron API

### Build the image

- Run `docker build -t cron-be:go -f deployments/Dockerfile .` or `make build_image` to build the image.

### Run the image using Docker Compose

- Uncomment the `cron-be` service in `docker-compose.yml`.

- Run `docker compose -f deployments/docker-compose.yml --env-file .env up -d` or `make compose_up` to start the Postgres Database, Adminer, and the Cron Go HTTP Server.

## Testing the Project

### Run the tests

- `go test -v -cover -failfast test ./...` or `make test`