hng_boilerplate_nestjs

(β˜… 183)

Description

File Explorer

Download Latest Version (.zip)
  • .dockerignore
  • .env.example
  • .env.local
  • .eslint.rc
  • .eslintrc.js
  • .gitignore
  • .nvmrc
  • .prettierignore
  • .prettierrc
  • commitlint.config.js
  • deployment.sh
  • dev-ecosystem-config.json
  • Dockerfile
  • eslint.config.js
  • LICENSE
  • local repo
  • main-ecosystem-config.json
  • nest-cli.json
  • package-lock.json
  • package.json
  • README.md
  • setup-guide.md
  • staging-ecosystem-config.json
  • start_server.sh
  • tsconfig.build.json
  • tsconfig.json

# Installation Guide

1. Get the code
git clone https://github.com/hngprojects/hng_boilerplate_nestjs

Downloads the entire project code from GitHub to your computer.

cd hng_boilerplate_nestjs

Moves into the project folder you just downloaded.

2. Docker

Easy Recommended
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
docker compose -f compose/compose.dev.yaml up -d --build

Runs the command against the services defined in the compose file.

βœ… Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

3. Node.js

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Node.js Node.js must be installed to use npm. The LTS version is recommended.
npm run test

Type this command into your terminal and run it.

npm install

Downloads and installs the libraries listed in package.json.

npm run build

Builds optimized production files.

npm run dev

Starts the development/run server.

npm run start

Starts the development/run server.

βœ… After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

Pulled directly from this repo's README.

4. Python

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Python 3 On Windows, be sure to check 'Add Python to PATH' during installation.
⚠️ This is a large repository, so this method may point to an internal sub-package rather than the actual core product. Check the full README as well.
pip install -r src/run-tests/requirements.txt

Installs the Python libraries listed in requirements.txt (or similar).

python <μ‹€ν–‰ν•  파일λͺ…>.py # READMEμ—μ„œ μ •ν™•ν•œ μ‹€ν–‰ 파일λͺ…을 ν™•μΈν•˜μ„Έμš”

Runs the Python script (or module).

βœ… If it runs without errors and prints output in the terminal, it worked.

Today's picks

open-design β˜… 90,071

🎨 Best DeepSeek Harness Design Plugin. The open-source Claude Design alternative. πŸ–₯️ Local

TypeScript
worldmonitor β˜… 83,628

Real-time global intelligence dashboard. AI-powered news aggregation, geopolitical monitor

TypeScript
uptime-kuma β˜… 90,435

A fancy self-hosted monitoring tool

JavaScript
Awesome-Hacking β˜… 118,742

A collection of various awesome lists for hackers, pentesters and security researchers
andrej-karpathy-skills β˜… 204,772

A single CLAUDE.md file to improve Claude Code behavior, derived from Andrej Karpathy's ob
fzf β˜… 82,603

:cherry_blossom: A command-line fuzzy finder

Go
// repository documentation