Skip to content

Latest commit

 

History

History
82 lines (56 loc) · 2.34 KB

README.md

File metadata and controls

82 lines (56 loc) · 2.34 KB

Turborepo starter

This is an official starter Turborepo.

What's inside?

This Turborepo includes the following packages/apps:

Apps and Packages

.
├── apps
│   ├── api                       # NestJS app (https://nestjs.com).
│   └── web                       # Next.js app (https://nextjs.org).
└── packages
    ├── @valley/api                 # Shared `NestJS` resources.
    ├── @valley/eslint-config       # `eslint` configurations (includes `prettier`)
    ├── @valley/jest-config         # `jest` configurations
    ├── @valley/typescript-config   # `tsconfig.json`s used throughout the monorepo
    └── @valley/ui                  # Shareable stub React component library.

Each package and application are 100% TypeScript safe.

Utilities

This Turborepo has some additional tools already set for you:

Commands

Build

# Will build all the app & packages with the supported `build` script.
yarn build

# ℹ️ If you plan to only build apps individually,
# Please make sure you've built the packages first.

Develop

# Will run the development server for all the app & packages with the supported `dev` script.
yarn dev

Lint

# Will lint all the app & packages with the supported `lint` script.
# See `@valley/eslint-config` to customize the behavior.
yarn lint

Format

# Will format all the supported `.ts,.js,json,.tsx,.jsx` files.
# See `@valley/eslint-config/prettier-base.js` to customize the behavior.
yarn format

Installation and running issues

Ensure your machine has this packages installed: libvips, libvips-tools, libvips-dev

Running on WSL

If some of services are inaccessible from network, run the following command to proxy it.

PORT is your desired port to proxy from WSL to your network.

WSL_IP can be retrieved from hostname -I command.

netsh interface portproxy add v4tov4 listenport=<PORT> listenaddress=0.0.0.0 connectport=<PORT> connectaddress=<WSL_IP>