Getting Started

Installation

For setting up Pictshare Book, follow these steps:

Requirements

• Bun version 1.2 or higher
• Docker Desktop (includes docker compose)
  • Alternatively Docker Engine and Docker Compose

Install commands for Mac (using Homebrew)

• Bun: curl -fsSL https://bun.sh/install | bash
• Docker: brew install --cask docker

Install commands for Arch (using Pacman)

• Bun: curl -fsSL https://bun.sh/install | bash
• Docker: sudo pacman -S docker docker-desktop

Install commands for Ubuntu (manual)

• Bun: curl -fsSL https://bun.sh/install | bash
• Docker: Follow these instructions to install Docker on Ubuntu: link

Install commands for Windows (using Chocolatey)

• Bun: choco install bun
• Docker: choco install docker-desktop

Setup

First, clone the repository:

git clone https://github.com/juliankarhof/pictshare-book.git && \
cd pictshare-book

next run the setup command:

bun run setup

WARNING

If you want to be able to use google login, you need to provide the GOOGLE_CLIENT_ID and GOOGLE_CLIENT_SECRET in the apps/api/.env file. Email login will work out of the box. You should also consider replacing the BETTER_AUTH_SECRET with a more secure value.

then start the development server:

bun run dev

now you can access Pictshare Book at http://localhost:3000.