Chirper Repository

This is the main repository of all Chirper apps. This respository is based in Turborepo

What's Chirper?

Chirper is a Twitter clone. Is Open Source, and is being developed using Test-Driven Development, Domain-Driven Design & Hexagonal Architecture

What's inside?

This repository uses npm as a package manager. It includes the following packages/apps:

Apps and Packages

• api: a NestJS app
• web: a Next.js app
• ui: a stub React component library used by web application
• eslint-config-custom: eslint configurations (includes eslint-config-next and eslint-config-prettier)
• tsconfig: tsconfig.jsons used throughout the monorepo

Each package/app is 100% TypeScript.

Utilities

This repository has some additional tools already setup for you:

• TypeScript for static type checking
• ESLint for code linting
• Prettier for code formatting

Build

To build all apps and packages, run the following command:

cd ./chirper
npm run build

Develop

To develop all apps and packages, run the following command:

cd my-turborepo
npm run dev

Remote Caching

Turborepo can use a technique known as Remote Caching to share cache artifacts across machines, enabling you to share build caches with your team and CI/CD pipelines.

By default, Turborepo will cache locally. To enable Remote Caching you will need an account with Vercel. If you don't have an account you can create one, then enter the following commands:

cd ./chirper
npx turbo login

This will authenticate the Turborepo CLI with your Vercel account.

Next, you can link your Turborepo to your Remote Cache by running the following command from the root of your turborepo:

npx turbo link

Useful Links

Learn more about the power of Turborepo:

• Pipelines
• Caching
• Remote Caching
• Filtering
• Configuration Options
• CLI Usage