Categorygithub.com/BakingUp/BakingUp-Backend
repository
0.0.0-20241126080719-f3a3b4bc790a
Repository: https://github.com/bakingup/bakingup-backend.git
Documentation: pkg.go.dev

# Packages

No description provided by the author
No description provided by the author

# README

BakingUp-Backend

Welcome to the BakingUp Backend Repository!

Technology Stacks

Programming Languages:

  • Go

Development Tools:

  • Backend API: Go Fiber
  • Database: PostgreSQL
  • Database ORM: Prisma
  • 3rd Party APIs: Gemini AI
  • Container Management: Docker
  • Hosting: Azure Virtual Machine
  • DNS: Cloudflare
  • CI/CD: GitHub Actions

Installation Guide

1. Clone the Repository

  • For viewers on GitHub:

    git clone https://github.com/BakingUp/BakingUp-Backend.git
    
  • For viewers in CS GitLab:

    git clone https://csgit.sit.kmutt.ac.th/csc498-499-bakingup/bakingup-backend.git
    

2. Generate Prisma Client

  • Navigate to the root directory and run the following command:

    go run github.com/steebchen/prisma-client-go generate
    

3. Setup Environment Variables

  • Create a .env file in the root directory of the project and add the following environment variables:

    HTTP_PORT=
    DATABASE_URL=postgresql://username:password@localhost:5432/yourdatabase
    HTTP_ALLOWED_ORIGINS=
    
  • Note: Replace username, password, and yourdatabase with your actual PostgreSQL credentials.

4. Start the Server

  • Run the following command to start the server:

    go run cmd/http/main.go
    

5. Access API Documentation (Swagger)

  • Open your browser and go to the following URL to access the Swagger documentation for API endpoints: http://localhost:8000/swagger/index.html
  • Note: Ensure that the backend server is running on port 8000 for the documentation to load properly.

More Information

For more information, please refer to the "Wiki" section at