@abiroot/boilerplate-monorepo

Boilerplate Monorepo

This repository serves as a monorepo boilerplate with shared libraries and utilities. Follow the steps below to clone, install dependencies, link locally, install/upgrade, and perform linting, TypeScript compilation, formatting, and testing.

Step 1: Clone and Install Packages and Dependencies

1. Clone the repository:

   git clone [e-mail]:abiroot/boilerplate-monorepo.git

Note: Ensure that you have the necessary SSH keys configured and appropriate access permissions to the private repository. If you encounter authentication issues, check your SSH setup and GitHub account permissions. For more information on how to generate SSH keys and check permissions, please refer to the official documentation:

• SSH Setup on GitHub
• Access Permissions on GitHub

2. Change into the cloned directory:

   cd boilerplate-monorepo

3. Install dependencies:

   yarn install

Step 2: How to Use the Package Locally

To link the boilerplate-monorepo locally, follow these steps:

1. Run the following command in the boilerplate-monorepo directory:

   yarn link

   After running this command, a success message will appear, indicating that "@abiroot/boilerplate-monorepo" is registered.

2. In the project where you want to use this package, run the following command:

   yarn link "@abiroot/boilerplate-monorepo"

   Now, you are able to use the @abiroot/boilerplate-monorepo locally in your project.

Step 3: Install and Upgrade the Package in the Project

Run the following command in your project to install or upgrade the package:

yarn add git+ssh://[e-mail]:abiroot/boilerplate-monorepo

Note: Ensure that you have the necessary SSH keys configured and appropriate access permissions to the private repository. If you encounter authentication issues, check your SSH setup and GitHub account permissions. For more information on how to generate SSH keys and check permissions, please refer to the official documentation:

• SSH Setup on GitHub
• Access Permissions on GitHub

Step 4: Linting, TypeScript Compilation, Formatting, and Testing

Use the following commands for linting, TypeScript compilation, formatting, and testing:

# Lint all projects
yarn lint:all

   - Lints all projects in the monorepo using ESLint.

# TypeScript compilation for all projects
yarn tsc:all

   - Compiles TypeScript code for all projects in the monorepo.

# Format all code
yarn format:all

   - Formats code using Prettier for all projects in the monorepo.

# Run tests
yarn test

   - Executes tests for all projects in the monorepo using Jest.