Skip to content

Latest commit

 

History

History
153 lines (94 loc) · 4.02 KB

README.md

File metadata and controls

153 lines (94 loc) · 4.02 KB
Raw

Hey Monorepo

Requirements

  • Node.js (v18 or higher) - The backbone of our project, make sure you have this installed.
  • pnpm - Our trusty package manager, because who doesn't love faster installs?
  • Postgres App - Our database of choice, because data needs a cozy home.
  • Redis - The speedy in-memory data store, for when you need things done in a flash.

Installation

We harness the power of pnpm workspaces to keep our monorepo running smoother than a freshly buttered pancake.

Clone the repository

Clone the Hey monorepo to your local machine:

git clone [email protected]:/repos/hey/hey.git

Install NVM (Node Version Manager) and pnpm

Rocking a macOS? You can grab both with Homebrew, like a true brew master:

brew install nvm pnpm

Install Node.js

Use nvm to summon the magical version of Node.js you need:

nvm install

Install dependencies

Teleport yourself to the root of the repository and let pnpm sprinkle its dependency magic:

pnpm install

Create a .env file

Channel your inner wizard and conjure up a .env file from the .env.example template for every package and app that needs it. Don't forget to sprinkle in the necessary environment variables!

cp .env.example .env

Don't forget to play copycat and repeat this .env file creation for every package and app that needs it. Consistency is key!

Start the application

When all the stars align and everything is in place, kick off the application in development mode:

pnpm dev

Build and Test

Build the application

Ready to build the application? Just run this command:

pnpm build

Test the application

Want to run tests while you're developing? Here's how you do it:

pnpm test

Periodic Tasks

Remove unused exports and helpers

We use ts-prune to hunt down and eliminate unused exports and helpers lurking in our codebase. Just a heads-up: you'll need to run this task manually for each package and app. Happy pruning!

cd apps/web; npx ts-prune -i generated.ts

Update dependencies

Time to give our dependencies a makeover! We rely on the magical powers of pnpm to keep everything up-to-date and looking sharp.

script/clean-branches
script/update-dependencies

Update lock file

We trust pnpm to keep our lock file fresh and fabulous!

script/clean-branches
script/update-lock-file

Other tools you might like

Ripgrep

We use Ripgrep to search for text in the codebase. It's like grep and ag had a baby, and that baby grew up to be a speed demon!

Install it via Homebrew:

brew install ripgrep

Search for text in the codebase:

rg "const Verified"

Bundle Analyzer

In apps/web, we've got a bundle analyzer that spills the beans on the size and contents of our production bundles. It's like having X-ray vision for your code!

To generate this output, run:

cd apps/web
ANALYZE=true pnpm build

Fire up this command to build the apps/web project and watch as three browser windows magically pop open, each showcasing bundle details for node, edge, and client bundles. The client bundle is the superhero for page performance, while all bundles play a vital role in development and build performance.

Code of Conduct

We kindly ask all contributors and team members to follow our Code of Conduct. Think of it as our community's golden rulebook - play nice and keep the good vibes flowing!

License

This project is open-sourced under the AGPL-3.0 license. For all the nitty-gritty details, check out the LICENSE file. It's a real page-turner!

P.S

We 💖 you to the moon and back! Your support is like a never-ending supply of coffee for our code. Thank you for making Hey the most awesome place in the universe!

🌸