xeho91/backend-starter

Back-end starter

A template to create a back-end project workspace (a.k.a. "monorepo") for the specific technology stack.

Caution

🚧 Under construction

---

Technology stack

Below is the list for the shared dependencies used in the project.

Dependencies

• Zod - schema validation with static type inference

Dev dependencies

• [TypeScript] - superset of JavaScript that compiles to clean JavaScript output

Optional dependencies

• TypeDoc - documentation generator
• Vitest - testing framework

---

Project structure

Below is a quick navigation on how to navigate this project workspace root directories.

.
├── [1] .husky
├── [2] apps
├── [3] coverage
├── [4] docs
├── [5] packages
└── [6] types

Where as:

• [1] .husky -> Git hooks setup for this project powered by husky
• [2] apps -> binary packages (applications)
• [3] coverage -> auto-generated (by Vitest) tests coverage (ignored by default via .gitignore)
• [4] docs -> auto-generated (by TypeDoc) documentation site (ignored by default via .gitignore)
• [5] packages -> library packages
• [6] types -> types for the workspace

---

Getting started

This section shows how to setup this project on your device.

Pre-requisites

• Node.js LTS
• pnpm
• Docker or Orb

First steps

1. Install the workspace dependencies:

    pnpm install

2. Setup environment variables:

   pnpm setup:env

3. Build the packages (both binaries and libraries):

   pnpm build

4. Setup the database:

   pnpm setup:db