CampusHQ

This repository contains the source code for the CampusHQ backend API.

Golang Clean Architecture, Auth0, SQLC

CampusHQ uses onion architecture to separate the application into layers. The layers are as follows:

• Domain Layer
• Application Layer
• Infrastructure Layer
• Presentation Layer

Getting Started

Prerequisites

Make sure you have the following installed on your machine:

• Docker
• Postgresql
• Go

Installation

Clone the repository

git clone git@github.com:campushq-official/campushq-api.git

Create .env file in the root directory of the project, and add the environment variables specified in the .env.sample file.

The following two commands will make docker container, database and seed the database for you automatically,

To start the docker container run,

make db-start

To migrate database schema and seed the database run,

make db-init

Some useful commands

• db-wipe This command will drop the database and remove the docker container.
• new-migration name=migration-name This command will create a new migration file in the migrations' folder. The name flag is required.
• migrate-up This command will run all the migrations.
• migrate-down This command will roll back the migrations.

SQLC

SQLC is a code generator for SQL databases. It is used to generate the database layer of the application. It generates the following files:

To perform any database operation, there is a directory called repositories/queries, just write the query in the sql file and run the command below to generate the database layer.

make sqlc

The tag --name: FuncName :many in the sql file is used to specify the name of method to be generated in the database layer.

For Example, if you want to create a student, you can write a query in /repositories/queries/students.sql file, and run the command above to generate the database layer.