Skip to content

Latest commit

 

History

History
84 lines (52 loc) · 1.68 KB

README.md

File metadata and controls

84 lines (52 loc) · 1.68 KB
Raw

Hey Monorepo

Requirements

Installation

We use pnpm workspaces to efficiently manage our monorepo.

Clone the repository

To gain access to the repository on Pierre, contact Yoginth and share your innovative ideas—together, let's build the future of the web.

git clone git@git.pierre.co:/repos/hey/hey.git

Install NVM (Node Version Manager) and pnpm

If you're on macOS, you can install both with Homebrew:

brew install nvm pnpm

Install Node.js

Use nvm to install the required version of Node.js:

nvm install

Install dependencies

Navigate to the root of the repository and install all dependencies:

pnpm install

Create a .env file

Copy the .env.example file to create a .env file in all relevant packages and apps, and fill in the necessary environment variables:

cp .env.example .env

Ensure to repeat this step for all packages and apps that require an .env file.

Start the application

Once everything is set up, run the application in development mode:

pnpm dev

Build and Test

Build the application

To build the application, run:

pnpm build

Test the application

For running tests in development mode:

pnpm test:dev

GitHub Mirror

We manage our repositories using Pierre. You can view our mirrored repository on GitHub here. While we don't accept pull requests (PRs) on GitHub, you're welcome to open issues.