README.md

Nairobi Gophers

Backend API for the upcoming Gophercon to be held in Kenya in 2024 (Date TBA).

Running the project locally

1. Frontend To run the frontend, navigate to the frontend directory

cd frontend

Install the dependencies

yarn install

Start the development server

yarn dev

The project is monolithic.

Infrastructure

• Docker (Containerization)
• Postgres (Database)
• Liquibase (DB Migration)
• Drone (CI/CD)

Dependencies

• Web Framework: Gin
• Database Client: pgx
• DB Migration: Liquibase
• Logging: Zap
• Test/Mocking: Testify

Features

• User Registration
• User Login
• Ticket Purchase
• Mpesa/Credit Card Integration
• Ticket Generation/Mailing

Project Structure

The project is will use a Clean architecture approach. The project structure is as follows:

• cmd/ - Main applications for this project.
• internal/ - Private application and library code.
  • platform/ - Platform-specific code for interacting with the DB, filesystem, etc
  • app/ - Application specific code.
  • server/ - HTTP server initialisation.
• pkg/ - Library code.
• docs/ - Documentation for the project.
• configs/ - Configuration files.