Biseo

Development

Prerequisites

• node >=18.0.0
  • Use nvm or pnpm use to set node version.
• pnpm
  • npm install -g pnpm
• docker

Setup

1. Fill in the .env file.

   cp .env.example .env

2. Install dependencies and run dev server.

   pnpm i
   pnpm dev

Commit

This project uses Conventional Commits for commit messages. Refer to the conventional commits specification for more details.

This project uses Husky to run lint and test before commit. If you have "Command not found: nvm" errors when the precommit hooks are executed, add following lines to your .huskyrc(Refer to Husky troubleshooting).

# This loads nvm.sh, sets the correct PATH before running hook, and ensures the project version of Node
export NVM_DIR="$HOME/.nvm"

[ -s "$NVM_DIR/nvm.sh" ] && \. "$NVM_DIR/nvm.sh"

# If you have an .nvmrc file, we use the relevant node version
if [[ -f ".nvmrc" ]]; then
  nvm use
fi

Deployment

1. Fill in the .env file.

   cp .env.prod.example .env

2. Create an external volume for database.

   docker volume create biseo-data

3. Build and run the docker image.

   docker-compose up -d --build