Conventional Commits

Rules

Code Style

ClubHub

Welcome to the ClubHub Developer documentation

Introduction

Getting Started

[GitHub](https://github.com) is used as our primary version control and collaboration platform, enabling us to host and review code, and work together seamlessly across our team.

GitHub

[GitHub Actions](https://github.com/features/actions) is used as our CI/CD tool, enabling us to automate our software development workflows, test and deploy code changes quickly and efficiently, and ensure code quality with continuous feedback.

GitHub Actions

[Nx](https://nx.dev) is used as our build system.

[Discord](https://discord.com) is used for all internal communication.

Discord

[Linear](https://linear.app) is used as our project management tool to streamline our workflows, collaborate on tasks, and track our team's progress.

Linear

[Neon](https://neon.tech) is used as our database infrastructure platform.

Neon

[Prisma](https://prisma.io) is used as our database toolkit to simplify data access and management with an intuitive and strong type-safety API.

Prisma

[Trigger](https://trigger.dev) is used as a code alternative to [GitHub Actions](https://github.com/features/actions) for workflow automation.

Trigger

[Google Cloud Run](https://cloud.google.com/run/) is used as our serverless compute platform for deploying cost-efficient containerized applications without having to manage the underlying infrastructure.

Google Cloud Run

[Fly.io](https://fly.io) is used as our cloud platform to deploy and run our applications.

[Docker](https://www.docker.com/) is used for containerizing our applications and deploying them to the cloud.

Docker

[Canny](https://canny.io) is used as our primary platform for managing and prioritizing customer feedback, enabling us to make data-driven product development decisions and improve customer satisfaction.

Canny

Remix

Why we chose Google Cloud Run instead of Fly

Google Cloud Run vs Fly

Neon vs PlanetScale

Space

A [Trigger](/stack/trigger) workflow for creating or deleting a Neon branch when a GitHub branch is created or deleted. It also posts corresponding messages to the `#neon` channel in the Discord Server with the necessary environment variables for establishing a database connection when using Prisma while developing

Trigger Neon Branch

A [Trigger](/stack/trigger) workflow for creating or deleting a [Google Cloud Run](/stack/google-cloud-run) service for [Space](/applications/space) application when a GitHub pull request is (re)opened or closed.

Trigger Space Preview App

Trigger Space Preview Application

Use [Deepkit](https://deepkit.io) as the app server for [Remix](https://remix.run)

Deepkit Remix

An overview on how to use the `@clubhub/space-db` library

Space Database

An overview on how to use the `@clubhub/internal-db` library

Internal Database

Example overview page before API endpoints

Authentication

This endpoint gets or creates a new user.

Home

Stack

Development

Architecture

Applications

Libraries

Code Style

Conventional Commits

Rules

Home

Stack

Development

Architecture

Applications

Libraries

​Conventional Commits

​Rules

Conventional Commits

Rules