osmancoskun / buildog

Buildog

1. Getting started
   • Install dependencies
2. Local development
   • Fork the repo
   • Clone the repo
   • Running turborepo
     • Environment variables
     • Shared components
     • Adding new component on @repo/ui
     • Installing packages
3. Create a pull request

Getting started

Thank you for your interest in Buildog and your willingness to contribute!

Install dependencies

You will need to install and configure the following dependencies on your machine to build Buildog:

• Git
• Node.js v18.x (LTS)
• pnpm version 8.x.x

Local development

This repo uses Turborepo.

Fork the repo

To contribute code to Buildog, you must fork the Buildog repo.

Clone the repo

1. Clone your GitHub forked repo:

git clone https://github.com/<github_username>/buildog.git

2. Go to the Buildog directory:

cd buildog

Install dependencies

1. Install the dependencies in the root of the repo.

pnpm install # install dependencies

2. After that you can run the apps simultaneously with the following.

pnpm dev

Directory	Description	Local development server
/apps/buildog	The main web application.	http://localhost:3000
/apps/api	The main backend application.	http://localhost:3010

Environment variables

Auth0 - How to setup Auth0

Shared components

The monorepo has a set of shared components under /packages:

• /packages/ui: shadcn/ui components.
• /packages/typescript-config: Shared Typescript settings
• /packages/eslint-config: Shared eslint settings

Adding new component on @repo/ui

Use the pre-made script:

pnpm ui:add <shadcn/ui-component-name>

This works just like the add command in the shadcn/ui CLI.

Installing packages

Installing a package with pnpm workspaces requires you to add the --filter flag to tell pnpm which workspace you want to install into. Do not install dependencies in their local folder, install them from the route using the --filter flag.

pnpm add <package> --filter <workspace>
pnpm uninstall <package> --filter <workspace>

For example:

• pnpm add react --filter buildog installs into ./apps/buildog

Create a pull request

After making any changes, open a pull request. Once your PR has been merged, you will be proudly listed as a contributor.