Skip to content

xUser5000/inplace

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Inplace

A website that helps you find the right apartment

Prerequisites

Required Tools

Pre-commit hooks:

This will automatically format the staged files when creating a new commit.

cd backend
npm run setup-pre-commit-hooks

Environment variables

  • Rename backend/.env-example to backend/.env
  • fill in the missing environment variables.

Basic Commands

The following commands are available in the root of the project:

docker compose build    # to build images (you'll need to do this once every time backend/package.json changes)
docker compose up       # to start containers
docker compose down -v  # to delete containers and erases all volumes (including the database contents)

The following commands are available in the backend directory:

npm run format          # to format the backend source files

Ports

Backend (Node.js)               -> 3000
Database (PostgreSQL)           -> 5432
Mailhog SMTP                    -> 1025
Mailhog Web UI                  -> 8025
MKDocs internal documentation   -> 8000

Important endpoints

Health check                    -> /
Swagger UI                      -> /api-docs