Giter Club home page Giter Club logo

catalog-api's Introduction

Project catalog-api ๐Ÿ“š

Monolith REST API service for Inner Catalog project.

Community

  • Just use github discusson for now
  • Should i make a discord server?

Docs

  • Use Bruno
    • Import collection form ./docs/catalog-circle-api/bruno.json
  • ERD Diagram

Getting Started

Requirements

  • Go 1.21.1
  • PostgreSQL:latest
    • Docker (local)
    • Supabase
  • Go Migrate v4 link
  • wire
  • Docker
  • air (for live reload)
  • Google Client ID & Secret (for oauth2)
  • Object Storage
    • AWS S3 with Cloudflare R2

Installation

  1. Fork the repository
  2. Clone the repository from your fork
  3. Create .env file in the root dir based on .env.example
  4. Install dependencies
go mod download
  1. Run DB container
make docker-run
  1. Run the migration
make migrate-up
  1. Run the application locally
make watch

Environment

Available Make Commands

# run all make commands with clean tests
make all build

# build the application
make build

# run the application
make run

# Create DB container
make docker-run

# Shutdown DB container
make docker-down

# live reload the application
make watch

# create new migration file
make migrate-create

# run the migration
make migrate-up

# rollback the migration
make migrate-down

# run the test suite
make test

# clean up binary from the last build
make clean

catalog-api's People

Contributors

althafdaa avatar wawanrandianto1 avatar althafdemiandra avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.